Skip to content

docs(m108): connector platform — uniform API + bounded vendor calls#117

Merged
indykish merged 2 commits into
mainfrom
chore/m108-connector-platform-changelog
Jul 2, 2026
Merged

docs(m108): connector platform — uniform API + bounded vendor calls#117
indykish merged 2 commits into
mainfrom
chore/m108-connector-platform-changelog

Conversation

@indykish

@indykish indykish commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Companion changelog for agentsfleet PR #469 (connector platform base).

  • changelog.mdx — new Jul 02 <Update>: the generic {provider} connector route set is now in the public API reference, unknown providers return 404 UZ-CONN-004, and connector vendor calls are deadline-bounded (UZ-CONN-003).
  • api-reference/error-codes.mdx — adds UZ-CONN-003 (502) + UZ-CONN-004 (404); de-GitHubs the now-generic UZ-CONN-001 wording (it covers every provider's platform app, not just GitHub).

The API reference tables themselves regenerate from the openapi.json shipped 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.

  • changelog.mdx — adds a Jul 02 <Update> entry covering the three generic connector routes, UZ-CONN-003 (502, vendor deadline exceeded), and UZ-CONN-004 (404, unknown provider).
  • api-reference/error-codes.mdx — inserts UZ-CONN-003 and UZ-CONN-004 in the correct sequence position; HTTP status codes, titles, and cause descriptions are accurate and consistent with the changelog.
  • docs.json — resolves the previously flagged sidebar gap by adding a "Connectors" nav group with all four connector endpoints (the three generic provider routes plus 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

Filename Overview
changelog.mdx Adds Jul 02, 2026 changelog entry documenting the generic connector route set, bounded vendor calls, and new error codes UZ-CONN-003/UZ-CONN-004; content is internally consistent.
api-reference/error-codes.mdx Inserts UZ-CONN-003 (502) and UZ-CONN-004 (404) rows in the correct sequence position; HTTP status codes and prose are accurate.
docs.json Adds "Connectors" nav group with all four connector endpoints (3 generic provider routes + POST /v1/connectors/slack/events), addressing the previously flagged sidebar gap.

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)
Loading
%%{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)
Loading

Reviews (3): Last reviewed commit: "docs(m108): add Connectors group to API ..." | Re-trigger Greptile

@mintlify

mintlify Bot commented Jul 2, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
agentsfleet 🔴 Failed Jul 2, 2026, 9:40 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Comment thread docs.json
indykish and others added 2 commits July 2, 2026 15:45
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>
@indykish indykish force-pushed the chore/m108-connector-platform-changelog branch from 8536a5d to 28d8f9c Compare July 2, 2026 13:10
@indykish indykish merged commit 5b4ecd0 into main Jul 2, 2026
4 checks passed
@indykish indykish deleted the chore/m108-connector-platform-changelog branch July 2, 2026 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant