docs(error-codes): reconcile reference with the emittable registry (M92)#96
Merged
Conversation
The error-codes page had drifted from agentsfleetd's error registry: 45 real codes were undocumented and 32 documented codes had no producer, so operators could chase codes the API can never return. Regenerated the page to mirror exactly the 95 emittable registry entries (registry e() entries == documented codes, zero drift). Added: the full runner control-plane contract (UZ-RUN-*), runner-engine execution failures (UZ-EXEC-004..011), command-line interface (CLI) login (UZ-AUTH-011..021), API keys (UZ-APIKEY-*), large-language-model (LLM) provider config (UZ-PROVIDER-*), API load-shedding (UZ-API-*), plus UZ-AGENT-001, UZ-AGT-012, UZ-APPROVAL-006, UZ-STARTUP-006. Removed: never-shipped sections (Billing, Workspace, Scoring, Entitlement, CI Gate, Credentials, Relay, Slack) and retired codes — UZ-MEM-001 (now UZ-MEM-002/404), UZ-AUTH-007/008 and UZ-SLACK-* (superseded), UZ-WH-003 and UZ-AGT-007 (retired markers), UZ-AGT-001/002/005, UZ-GRANT-002/003, UZ-TOOL-004, UZ-STARTUP-007 (never raised). Each removal was checked against the codebase (no producer or an explicit retirement commit). Fixed: Pipeline v1 removal is documented as a 404 (the implementation returns 404, not the previously-documented 410), folded into a Removed surfaces note. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ror-codes reconcile (M92) A Jun 17 entry: invalid gate conditions now fail agent create/patch with 400 UZ-APPROVAL-005 (previously accepted and silently over-gated); UZ-APPROVAL-004 surfaces on the Redis-down default-deny; and the error-codes reference now mirrors the emittable registry. Follows the changelog voice (one headline, bold lead-noun bullets, load-bearing codes/statuses kept). 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. |
…mespace (greptile) UZ-AUTH-014 (410 Gone) read as a retryable 'not yet approved' state; reworded to make the terminal nature + the re-run-login remediation explicit, matching the sibling UZ-AUTH-012/013 410 rows. UZ-AGENT-001 carries the AGENT prefix (not APIKEY) because it is the agent-key (agt_a) lookup — a distinct registry namespace from the tenant UZ-APIKEY-* codes; the row now says so. (UZ-APIKEY-002 is an unassigned numbering gap — no entry, no retired marker — so it is intentionally undocumented.) 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.
What
Reconciles the public error-codes reference with
agentsfleetd's error registry — it had drifted to 45 undocumented real codes and 32 documented codes with no producer.Why
Operators use this page to look up
error_codevalues fromapplication/problem+jsonresponses. The drift meant (a) the entire runner control-plane + runner-engine contract, CLI login, API keys, and LLM-provider codes were undocumented, and (b) operators could chase codes (Billing / Workspace / Scoring / …) the API can never emit.Changes
The page now mirrors exactly the 95 emittable registry entries (verified: registry
e()entries == documented codes, zero drift).Added (45) — runner control plane
UZ-RUN-*, runner-engineUZ-EXEC-004..011, command-line interface (CLI) loginUZ-AUTH-011..021, API keysUZ-APIKEY-*, large-language-model (LLM) providerUZ-PROVIDER-*, API load-sheddingUZ-API-*, plusUZ-AGENT-001,UZ-AGT-012,UZ-APPROVAL-006,UZ-STARTUP-006.Removed (34) — never-shipped sections (Billing, Workspace, Scoring, Entitlement, CI Gate, Credentials, Relay, Slack) and retired codes; each verified against the codebase (no producer, or an explicit retirement commit):
UZ-MEM-001→ cross-workspace memory is nowUZ-MEM-002/ 404 (retired this milestone — agentsfleet #417).UZ-AUTH-007/008,UZ-SLACK-001/002/003→ superseded surfaces, deliberately removed.UZ-WH-003,UZ-AGT-007→ retired (registry markers).UZ-BILLING-*,UZ-WORKSPACE-*,UZ-ENTL-*,UZ-GATE-*,UZ-GRANT-002/003,UZ-CRED-*,UZ-RELAY-001,UZ-SCORING-001,UZ-AGT-001/002/005,UZ-TOOL-004,UZ-STARTUP-007→ never raised (m90-003 / orphan-code sweeps).Fixed — Pipeline v1 removal documented as 404 (the implementation returns 404, not the previously-documented 410); folded into a "Removed surfaces" note.
Related
Pairs with agentsfleet #417 (M92 error-registry cleanup + approval-gate hardening). The dotfiles error-codes gate was also fixed to stop missing digit-suffixed category codenames (
UZ-UUIDV7-*).🤖 Generated with Claude Code
Greptile Summary
This PR reconciles the public error-codes reference with the
agentsfleetderror registry, eliminating 45 previously undocumented codes and removing 34 codes that had no producer — bringing the page to an exact mirror of the 95 emittable registry entries. The changelog is updated with a breaking-change entry forUZ-APPROVAL-005gate-condition validation.UZ-RUN-*), runner engine (UZ-EXEC-004–011), CLI login (UZ-AUTH-011–021), API keys (UZ-APIKEY-*), LLM provider (UZ-PROVIDER-*), and API load-shedding (UZ-API-*).UZ-MEM-001cross-workspace scope retired toUZ-MEM-002/404.Confidence Score: 4/5
Safe to merge after clarifying or correcting the UZ-RUN-013 entry, which tells runner implementors two contradictory things about whether a renewal succeeded.
The UZ-RUN-013 row documents HTTP 400 while simultaneously stating the lease is still renewed. A runner implementation that follows standard HTTP semantics will abort on a 400, potentially killing a run whose lease is actually still live. This documentation defect directly shapes how operators write runner clients and needs to be resolved before operators adopt the runner control-plane contract.
api-reference/error-codes.mdx — specifically the UZ-RUN-013 row in the Runner control plane table.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[agentsfleet login] -->|device flow| B[CLI login UZ-AUTH-011..021] C[POST /v1/api-keys] -->|tenant key| D[API Keys UZ-APIKEY-*] C -->|agent key| E[UZ-AGENT-001] F[PUT /v1/tenants/me/provider] --> G[LLM Provider UZ-PROVIDER-*] H[Runner host] -->|/v1/runner/* lease protocol| I[Runner control plane UZ-RUN-*] I -->|claim / renew / report| J[Runner engine UZ-EXEC-*] K[Webhook ingest] --> L[Webhook UZ-WH-*] M[Agent trigger] --> N[Agent UZ-AGT-*] N --> O[Approval gate UZ-APPROVAL-*] N --> P[Vault UZ-VAULT-*] N --> Q[Memory UZ-MEM-*] R[agentsfleetd startup] --> S[Startup UZ-STARTUP-*] T[API instance] -->|load shedding| U[API limits UZ-API-*]%%{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[agentsfleet login] -->|device flow| B[CLI login UZ-AUTH-011..021] C[POST /v1/api-keys] -->|tenant key| D[API Keys UZ-APIKEY-*] C -->|agent key| E[UZ-AGENT-001] F[PUT /v1/tenants/me/provider] --> G[LLM Provider UZ-PROVIDER-*] H[Runner host] -->|/v1/runner/* lease protocol| I[Runner control plane UZ-RUN-*] I -->|claim / renew / report| J[Runner engine UZ-EXEC-*] K[Webhook ingest] --> L[Webhook UZ-WH-*] M[Agent trigger] --> N[Agent UZ-AGT-*] N --> O[Approval gate UZ-APPROVAL-*] N --> P[Vault UZ-VAULT-*] N --> Q[Memory UZ-MEM-*] R[agentsfleetd startup] --> S[Startup UZ-STARTUP-*] T[API instance] -->|load shedding| U[API limits UZ-API-*]Reviews (3): Last reviewed commit: "docs(error-codes): clarify UZ-AUTH-014 t..." | Re-trigger Greptile