docs(api): TRA-748 F9 — align Errors page OPTIONS prose with server-to-server intent#162
Merged
Merged
Conversation
…o-server intent The Errors page line "OPTIONS is reserved for CORS preflight" implied OPTIONS is honored for CORS, contradicting both live behavior (405 with no Access-Control-Allow-* headers) and the canonical http-method-coverage prose. Replace with framing that matches the authoritative page: OPTIONS returns 405 like any other unsupported verb; the API is server-to-server only, no CORS. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
🚀 Preview Deployment Update ✅ This PR has been successfully merged into the preview branch. The preview environment will update shortly at: https://docs.preview.trakrf.id |
Deploying docs with
|
| Latest commit: |
29ccea3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b36335ff.docs-4n7.pages.dev |
| Branch Preview URL: | https://preview.docs-4n7.pages.dev |
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
1 participant
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.
Summary
/docs/api/errors§ HTTP method coverage paragraph claimedOPTIONSis "reserved for CORS preflight" — aspirational prose that contradicts live behavior and the canonical HTTP method coverage page.OPTIONSreturns405withAllow: GET, HEAD, POSTand noAccess-Control-Allow-*headers, even with a full CORS preflight (per the Authentication → Server-to-server design framing).OPTIONSis reserved for CORS preflight" with "OPTIONSis not honored — it returns405like any other unsupported verb (the API is server-to-server only, no CORS)". No new link added — the same paragraph already links to the canonical HTTP method coverage page.Scope: docs only. The companion F1 platform fix (service error template URL + regression test) ships separately in
trakrf/platform.Test plan
pnpm typecheckcleanpnpm buildsucceeds (Docusaurus production build)docs/api/errors.mdnot in the warning set (pre-existing spec-file warnings are unrelated)/docs/api/errors§ HTTP method coverage for the updated clause and confirm it reads consistently with/docs/api/http-method-coverage§ OPTIONS and/docs/api/authentication§ Server-to-server design.🤖 Generated with Claude Code