docs(api): TRA-742 BB43 F1+F2 — info.contact.url + external_key symmetry sweep#157
Closed
mikestankavich wants to merge 1 commit into
Closed
docs(api): TRA-742 BB43 F1+F2 — info.contact.url + external_key symmetry sweep#157mikestankavich wants to merge 1 commit into
mikestankavich wants to merge 1 commit into
Conversation
…try sweep Syncs trakrf/platform@24db422. Spec edits batched in the platform PR: F1 — info.contact.url: was https://app.trakrf.id/api (SPA HTML shell), now https://docs.trakrf.id/ (docs site). With the literal app.trakrf.id/api gone from the spec, the three contact-URL swap mechanisms (platform runtime, refresh-openapi.sh DEPLOY_ENV=preview block, swap-openapi-env.mjs postbuild) all silently no-op; docs-mirror and platform-served copies remain byte-identical without any platform-side code change. F2 — CreateAssetWithTagsRequest.external_key gains description + example parallel to CreateLocationWithTagsRequest.external_key. Sweep — 5 additional Asset/Location asymmetries surfaced and batched per the up-to-5 rule: CreateAssetWithTagsRequest description+name examples; UpdateAssetRequest description+is_active+name examples. Tag*Request variants and *View response schemas reviewed and confirmed symmetric. Cleanup follow-up (not in this PR): swap-openapi-env.mjs and the DEPLOY_ENV=preview block in refresh-openapi.sh are now permanently no-op and can be removed in a follow-up; their only job was swapping the app.trakrf.id/api literal that no longer appears in the spec. 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: |
b00f65d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://ea62cebb.docs-4n7.pages.dev |
| Branch Preview URL: | https://preview.docs-4n7.pages.dev |
Contributor
Author
|
Closing — the env-leak analysis surfaced that the docs-side mirror itself is the root issue (manual sync ceremony, contact-URL swap dance, BB byte-identity preflight all exist to manage a mirror that probably shouldn't exist). Pivoting to a redirect-based architecture. Follow-up on TRA-743. |
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
Syncs
trakrf/platform@24db422. BB43 hygiene/fix-now findings batched per the BB42 F1+F2 precedent (TRA-739).F1 —
info.contact.urlwashttps://app.trakrf.id/api(returned the SPA HTML shell, not contact info). Nowhttps://docs.trakrf.id/. With the literalapp.trakrf.id/apiremoved from the spec, the three existing contact-URL swap mechanisms (platform runtime,refresh-openapi.shDEPLOY_ENV=previewblock,swap-openapi-env.mjspostbuild) all silently no-op — docs-mirror and platform-served copies remain byte-identical with no platform-side code change.F2 —
CreateAssetWithTagsRequest.external_keynow carries a field-leveldescription+examplestructurally parallel toCreateLocationWithTagsRequest.external_key.Sweep — swept
Create*Request/Update*RequestAsset+Location pairs,Tag*Requestvariants, and*Viewresponse schemas. 5 additional asymmetries surfaced and batched in the same PR per the up-to-5 rule:CreateAssetWithTagsRequestdescription+nameexamples;UpdateAssetRequestdescription+is_active+nameexamples. Tag variants and*Viewschemas confirmed symmetric — no changes.Files
static/api/openapi.{json,yaml}— refreshed from platformstatic/api/platform-meta.json— bumped07b5edb→24db422Follow-up (not in this PR)
scripts/swap-openapi-env.mjsand theDEPLOY_ENV=previewblock inscripts/refresh-openapi.share now permanently no-op (their sole purpose was swapping theapp.trakrf.id/apiliteral that's no longer in the spec). Suggest a separate cleanup PR removes them plus thepostbuildhook inpackage.json.Cross-references
Test plan
app.preview.trakrf.id/api/v1/openapi.yamlbyte-identical todocs.preview.trakrf.id/api/openapi.yaml(BB spec-sync preflight)external_keydescription onPOST /assets🤖 Generated with Claude Code