docs(m108): connector platform — uniform API + bounded vendor calls#117
Merged
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
New Jul 02 <Update>: the generic {provider} connector route set is now in
the public API reference, unknown providers 404, and connector vendor calls
are deadline-bounded. Error-codes page gains UZ-CONN-003/004 and de-GitHubs
the now-generic UZ-CONN-001 wording.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Greptile flagged the connector endpoints announced in the changelog as absent from docs.json navigation. Backend agentsfleet#469 has now merged and the live OpenAPI spec carries these paths, so add the Connectors group without breaking the openapi-drift lint check. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
8536a5d to
28d8f9c
Compare
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
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.
Companion changelog for agentsfleet PR #469 (connector platform base).
<Update>: the generic{provider}connector route set is now in the public API reference, unknown providers return404 UZ-CONN-004, and connector vendor calls are deadline-bounded (UZ-CONN-003).UZ-CONN-003(502) +UZ-CONN-004(404); de-GitHubs the now-genericUZ-CONN-001wording (it covers every provider's platform app, not just GitHub).The API reference tables themselves regenerate from the
openapi.jsonshipped in agentsfleet #469 — no hand-maintained endpoint page to revise.🤖 Generated with Claude Code
Greptile Summary
This documentation PR ships the companion changelog and error-code table entries for the connector platform refactor (agentsfleet #469), publishing the generic
{provider}connector route set and two new error codes to the public API reference.<Update>entry covering the three generic connector routes,UZ-CONN-003(502, vendor deadline exceeded), andUZ-CONN-004(404, unknown provider).UZ-CONN-003andUZ-CONN-004in the correct sequence position; HTTP status codes, titles, and cause descriptions are accurate and consistent with the changelog.POST /v1/connectors/slack/events).Confidence Score: 5/5
Documentation-only change; no logic, no executable code, no schema migrations — safe to merge.
All three files make purely additive documentation changes. The new error code rows are ordered correctly and their HTTP status codes match the described behaviour. The Connectors nav group in docs.json resolves the previously flagged sidebar gap and lists all four connector endpoints consistently with the changelog. No content contradictions or omissions were found.
No files require special attention.
Important Files Changed
Sequence Diagram
%%{init: {'theme': 'neutral'}}%% sequenceDiagram participant Client participant API as agentsfleet API participant Vendor as Connector Vendor Client->>API: "POST /v1/workspaces/{workspace_id}/connectors/{provider}/connect" API-->>Client: 503 UZ-CONN-001 (provider not configured) API-->>Client: 200 (redirect URL to vendor) Client->>Vendor: Follows OAuth redirect Vendor->>API: "GET /v1/connectors/{provider}/callback?state=..." API-->>Vendor: 400 UZ-CONN-002 (invalid/expired state) API->>Vendor: Outbound call (deadline-bounded) Vendor-->>API: 502 UZ-CONN-003 (deadline exceeded / unreachable) API-->>Client: 502 UZ-CONN-003 Client->>API: "GET /v1/workspaces/{workspace_id}/connectors/{provider}" API-->>Client: 404 UZ-CONN-004 (unknown provider)%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%% sequenceDiagram participant Client participant API as agentsfleet API participant Vendor as Connector Vendor Client->>API: "POST /v1/workspaces/{workspace_id}/connectors/{provider}/connect" API-->>Client: 503 UZ-CONN-001 (provider not configured) API-->>Client: 200 (redirect URL to vendor) Client->>Vendor: Follows OAuth redirect Vendor->>API: "GET /v1/connectors/{provider}/callback?state=..." API-->>Vendor: 400 UZ-CONN-002 (invalid/expired state) API->>Vendor: Outbound call (deadline-bounded) Vendor-->>API: 502 UZ-CONN-003 (deadline exceeded / unreachable) API-->>Client: 502 UZ-CONN-003 Client->>API: "GET /v1/workspaces/{workspace_id}/connectors/{provider}" API-->>Client: 404 UZ-CONN-004 (unknown provider)Reviews (3): Last reviewed commit: "docs(m108): add Connectors group to API ..." | Re-trigger Greptile