API-09 / API-11: correct the connection-status enum and complete the error-code table - #8
Draft
ever-just wants to merge 1 commit into
Draft
API-09 / API-11: correct the connection-status enum and complete the error-code table#8ever-just wants to merge 1 commit into
ever-just wants to merge 1 commit into
Conversation
…error table Two docs-vs-code discrepancies from the remediation ledger, each verified against the control-plane source and by an independent adversarial check. API-09 (medium): the MCP page listed six connection statuses; three (`completed`, `error`, `expired`) do not exist. The real status is a closed four-value enum — `pending`, `propagating`, `live`, `failed` (services/control-plane/internal/model/model.go:116-119, asserted by status_test.go:59). Corrected content/mcp/overview.mdx to the four real values. API-11 (medium): the error-code table documented neither `forbidden` (403), `conflict` (409), nor `rate_limited` (429), though the handlers return all three. Added them to content/reference.mdx and content/api-reference/index.mdx. `quota_exceeded`, `ProviderAuthenticationError`, and `InvalidNameservers` — the other three the finding named — were already present from earlier work. Only codes/values that exist in the Go code were added; nothing invented. The OpenAPI enum already listed the correct four statuses, so check-openapi-sync stays green and no spec change was needed. Site builds clean (npm run build). API-03, API-08 and API-14 from the same cluster were checked and found already correct in these docs (12-attempt durable-outbox retries, twelve MCP tools, and all eight SDK window events respectively) — no change needed, verified not assumed. Claude-Session: https://claude.ai/code/session_01YFw2Aya3Vn1W3saDPs8XRY
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.
What & why
Two customer-docs-vs-code discrepancies from the remediation ledger, each verified against the control-plane source and by an independent adversarial check.
API-09 (medium) — the MCP page listed six connection statuses; three of them (
completed,error,expired) don't exist. The real status is a closed four-value enum —pending,propagating,live,failed(model.go:116-119, asserted bystatus_test.go:59). Correctedcontent/mcp/overview.mdx.API-11 (medium) — the error-code table documented neither
forbidden(403),conflict(409), norrate_limited(429), though the handlers return all three. Added them tocontent/reference.mdxandcontent/api-reference/index.mdx. The other three the finding named (quota_exceeded,ProviderAuthenticationError,InvalidNameservers) were already present.Only codes/values that exist in the Go code were added — nothing invented. The OpenAPI enum already lists the correct four statuses, so
check-openapi-syncstays green and no spec change was needed.API-03, API-08, API-14 from the same cluster were checked and found already correct in these docs (12-attempt durable-outbox retries; twelve MCP tools; all eight SDK window events) — no change, verified not assumed.
Docs (required)
Checks
cd site && npm run build— clean (105+ pages prerendered).Generated by Claude Code