docs(api): Cloudflare UA note + scopes-not-an-enum versioning fix (TRA-884)#200
Merged
mikestankavich merged 1 commit intoMay 30, 2026
Conversation
…ng (TRA-884) Quickstart: add a warning that the API behind Cloudflare rejects requests with a default/empty User-Agent (403 / error 1010 before the request reaches TrakRF). curl, requests, and generated clients pass; Python stdlib urllib is the common exception, so show setting the header explicitly. Versioning: scopes are a free-form string array, not a wire enum, so they carry no x-extensible-enum marker. Remove the "Scope strings" entry from the open-enum bullet list and the codegen-bypass sentence, and replace it with an accurate "scope strings are not an enum" paragraph that keeps the render-unknown-scopes-as-is guidance. The tag_type row is left as-is: TRA-882 added x-extensible-enum:true to the read variants, so it is now accurate. Co-Authored-By: Claude Opus 4.8 <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: |
7a73cf2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://967036a4.docs-4n7.pages.dev |
| Branch Preview URL: | https://preview.docs-4n7.pages.dev |
mikestankavich
deleted the
miks2u/tra-884-docs-versioning-page-corrections-static-spec-refresh-api
branch
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
Closes the docs half of the TRA-881 epic (TRA-884). Two doc-owned fixes; the third original bullet was a no-op (see below).
1. Quickstart — Cloudflare
User-Agentnotedocs/api/quickstart.mdxgains a:::warningin §2: the API behind Cloudflare rejects requests with a default/emptyUser-Agentwith a Cloudflare403(error1010) before the request reaches TrakRF — so there's no normalerrorenvelope to diagnose against.curl,requests, and the generated clients pass; Python stdliburllibis the common exception, shown with an explicit header.2. Versioning — scopes are not an enum
docs/api/versioning.md: scope strings are a free-form string array, not a wire enum, so they carry nox-extensible-enummarker. Removedscopesfrom the open-enum bullet list and from the codegen-bypass sentence, and replaced it with an accurate "scope strings are not an enum" paragraph that keeps the render-unknown-scopes-as-is guidance. Thetag_typerow is left as-is — TRA-882 addedx-extensible-enum: trueto the read variants, so it is now accurate (verified against the live preview spec).Removed from original ticket scope
The original "refresh static spec asset
docs/api/openapi.public.yaml" bullet was a no-op: no such asset exists. The/apipage is rendered by redocusaurus live-fetching${appHost}/api/openapi.yamlat build time (docusaurus.config.ts), so TRA-882's spec change flows to the rendered page on the next docs deploy with no docs PR. Ticket updated accordingly.Out of scope (flagged separately)
Relaxing the Cloudflare WAF rule so default-UA clients aren't blocked is a security-posture decision, not a docs fix — the note is the immediate mitigation.
Verification
pnpm build— success (client + server compiled, static files generated)pnpm dlx prettier --checkon both changed files — passtag_typeread/write marker state confirmed against the live preview spec (read variants carryx-extensible-enum: true, request variants bare, ErrorType/FieldErrorCode unchanged)🤖 Generated with Claude Code