Add docs - #736
Merged
Merged
Add docs#736
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
…u hit — request headers outside a four-name allowlist are dropped silently rather than refused, so a call that ignores a header you set looks like the service misbehaving; plus the 4 MB body and response caps, the 30 second ceiling, and where each function can be called from
… it — connecting an account was the fifth section though nothing before it works without one, so a reader following the first example got a 404; adds the 409 for an ambiguous label, a failure table, the missing OC_API_URL, a warning that the CLI command the platform's own error suggests does not exist, and puts the multi-account example inside a tool where it compiles
…rather than a fallback, so a call with no label 404s even when exactly one account is connected under another name; gmail caps a page at 100 ids so the counting example returns a page size, not a total; and the 404 row named the less likely cause
…ted, then callService and useService shipped and made managed connections real, leaving the API as the only way to attach an account and leaving the platform's own 404 telling people to run a command that no longer existed; add|list|remove wrap the routes the docs currently spell out as curl, and nothing secret passes through the CLI because add returns a link for the account's owner to open
…in — step one was four curl invocations and a warning telling readers the platform's own error message names a command that was removed; it is one line, the warning is gone, and the failure table points at connection list because that is how you find the label a 404 is complaining about
… kept both rows in the capabilities table and both nav entries, kept the callService pointer alongside the approvals section in tools.mdx, and added a note distinguishing the two GitHub paths #735 introduced: callService proxies the REST API, useConnection injects a token for git and gh
… — the CLI is the short path but people scripting a bulk import should not have to shell out to it, so each of add, list and remove carries both forms in a CodeGroup, and the two places the API differs from the CLI are stated: it wants the provider in the URL and the connection id rather than the label
… rather than decorate — remove took matches[0] whenever --service was given, so a narrowed delete could still hit the wrong account; it now filters and refuses an ambiguous match instead of guessing, and the listing carries the id because removing through the API needs it and the docs say to read it from there
…ending accounts — the listing route never asks the provider whether a consent completed, so an account authorized minutes ago still reads pending and nothing a user could run would clear it; add now polls the status route, which does reconcile, and list reconciles the pending rows it finds. No browser is opened: the account is often somebody else's and this runs on servers too. --no-wait and --json skip the wait
…s a stored status, so an account authorized a minute ago still reads pending and the page offered no way to find out otherwise; the API tab now shows the status route beside the listing, and says plainly which of the two re-checks with the provider
…e --service was undocumented — the sample showed four fields where the CLI now prints five, so anyone matching output against the page would think their build was wrong
… re-checked whenever it is listed, so the page no longer tells people to chase the status route themselves; the caveat narrows to the case #85 deliberately does not cover, where a connected account stays connected after the grant is revoked until a call to it fails
motatoes
approved these changes
Sep 16, 2026
…verloaded sentence, so it splits into connected accounts and GitHub's two separate paths; drive and sheets are absent from the connections picker because the platform has no auth config for them and linking one fails, which the services table now says rather than implying they work; and connectionServiceId returned undefined for both, which stranded such a connection in the dashboard with no way to reconcile or disconnect it
…gs for them — the picker and the services table held them back because a link call failed without one; shipping alongside the blue change that gives each a scope profile, which is what the call needs before the auth config is even looked up
…crets — the review comment was about the service table, where a reader meets github as a callService target and needs to know the App flow is a different path; repeating it in the secrets note made that note carry two ideas again
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for managed connections, and restores the CLI command for managing them.
Docs —
agents/services.mdxNew page: connect an account, declare it with
useService, call it withcallService, sweep several withlistServices. Includes the limits the proxy enforces (4 MB bodies, 30s, and a four-name request-header allowlist whose other headers are dropped silently) and a table of failures with fixes.CLI —
opencomputer connection add|list|removeRemoved in #624, restored here.
addprints a link for the account's owner and waits until it is authorized;--no-waitand--jsonskip the wait.listshows the connection id and re-checks pending accounts.removetakes an alias or an id.Every operation is documented as both CLI and API. Cross-linked from secrets, tools and capabilities.
All examples were compiled and run against a live Gmail account.