docs(api): sync nav + error codes with openapi drift fixes#102
Merged
Conversation
Tracks agentsfleet#430 (OpenAPI drift remediation). The API reference auto-renders from main's public/openapi.json, so the rendered operations update on that PR's merge; this aligns the hand-maintained nav and the error-code table. - Nav: add the previously-undocumented Authentication lifecycle ops (approve / verify / delete session / delete all / clerk identity-event), the per-charge billing telemetry endpoint, and new Fleet + Model Catalogue groups for the runner operator plane and the model catalogue. - error-codes: add UZ-GRANT-002 (404, integration grant not found), the new code that backs the revoke not-found path. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Tracks agentsfleet#430 — UZ-AGT-010 is reused by both the patch (invalid transition) and delete (not-yet-killed) paths, so the title generalizes from 'Agent already stopped or killed' to 'Agent state transition not allowed'. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Greptile flagged the abbreviated {ws}/{id} placeholders in the
UZ-GRANT-002 remediation URL. Every other path in the nav and the
Integration grants group uses {workspace_id}/{agent_id}; match them so a
reader can copy-paste without guessing the mapping.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Tracks agentsfleet#430 (OpenAPI drift remediation).
The API reference auto-renders from
main'spublic/openapi.json, so rendered operations update when #430 merges; this aligns the hand-maintained pieces:approve/verify/delete session/delete all/clerkidentity-event), the per-charge billing telemetry endpoint, and new Fleet + Model Catalogue groups for the runner operator plane and model catalogue.UZ-GRANT-002(404, integration grant not found) — the new code backing the revoke not-found path.🤖 Generated with Claude Code
Greptile Summary
This PR syncs hand-maintained documentation (nav and error-codes) with the OpenAPI drift fixes from agentsfleet#430. It adds previously-undocumented auth lifecycle endpoints, a billing telemetry endpoint, Fleet and Model Catalogue nav groups, and the new
UZ-GRANT-002error code for the revoke-not-found path.error-codes.mdx:UZ-AGT-010gets a more general state-transition description, andUZ-GRANT-002(HTTP 404) is added with a remediation path that correctly matches the existingintegration-grantsnav entry.docs.json: Five new Authentication endpoints, one Billing telemetry endpoint, a four-entry Fleet group, and a single-entry Model Catalogue group are added to the nav; the Fleet path inconsistency (POST /v1/runnersvs/v1/fleet/runners) and the/_um/hash path for Model Catalogue were flagged in previous review rounds.Confidence Score: 5/5
Safe to merge — all changes are additive nav entries and an error-code addition; no logic, schema, or migration files are touched.
Both files contain purely additive, documentation-only changes. The error-code update to UZ-AGT-010 is a description clarification with no structural impact, and the new UZ-GRANT-002 entry references an endpoint already present in the nav. The open questions about the Fleet path prefix and Model Catalogue hash path were raised in prior review rounds and carry no correctness risk to the docs themselves.
No files require special attention beyond the open questions from prior review threads on docs.json.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[docs.json nav] --> B[Authentication group] A --> C[Billing group] A --> D[Fleet group] A --> E[Model Catalogue group] B --> B1[POST /v1/auth/sessions] B --> B2[GET /v1/auth/sessions/session_id] B --> B3[PATCH .../approve NEW] B --> B4[POST .../verify NEW] B --> B5[DELETE .../session_id NEW] B --> B6[DELETE .../sessions/all NEW] B --> B7[POST .../identity-events/clerk NEW] C --> C1[GET /v1/tenants/me/billing] C --> C2[GET .../charges] C --> C3[GET .../charges/event_id/telemetry NEW] D --> D1[POST /v1/runners NEW - different prefix] D --> D2[GET /v1/fleet/runners NEW] D --> D3[PATCH /v1/fleet/runners/id NEW] D --> D4[GET /v1/fleet/runners/id/events NEW] E --> E1[GET /_um/hash/cap.json NEW] F[error-codes.mdx] --> G[UZ-AGT-010 description updated] F --> H[UZ-GRANT-002 added - 404 grant not found NEW]%%{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"}}}%% flowchart TD A[docs.json nav] --> B[Authentication group] A --> C[Billing group] A --> D[Fleet group] A --> E[Model Catalogue group] B --> B1[POST /v1/auth/sessions] B --> B2[GET /v1/auth/sessions/session_id] B --> B3[PATCH .../approve NEW] B --> B4[POST .../verify NEW] B --> B5[DELETE .../session_id NEW] B --> B6[DELETE .../sessions/all NEW] B --> B7[POST .../identity-events/clerk NEW] C --> C1[GET /v1/tenants/me/billing] C --> C2[GET .../charges] C --> C3[GET .../charges/event_id/telemetry NEW] D --> D1[POST /v1/runners NEW - different prefix] D --> D2[GET /v1/fleet/runners NEW] D --> D3[PATCH /v1/fleet/runners/id NEW] D --> D4[GET /v1/fleet/runners/id/events NEW] E --> E1[GET /_um/hash/cap.json NEW] F[error-codes.mdx] --> G[UZ-AGT-010 description updated] F --> H[UZ-GRANT-002 added - 404 grant not found NEW]Reviews (3): Last reviewed commit: "docs(api): use full path params in UZ-GR..." | Re-trigger Greptile