docs(api): finalize location external_key auto-mint to LOC-NNN#191
Merged
Conversation
Aligns the resource-identifiers page with the location external_key
auto-mint format shipped server-side: LOC-NNN (3 digits, first mint
LOC-001) instead of LOC-NNNN (4 digits). Adds a paragraph after the
auto-mint table explaining the asset/location asymmetry — locations are
typically named-and-known artifacts so a 3-digit slot suffices for the
typical ad-hoc volume — and notes that both formats are digit-count-
agnostic past the natural width (LOC-1000+, ASSET-10000+) so client
parsers should match \d{3,} / \d{4,} rather than fixed widths.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The auto-mint format for locations is LOC-NNN (3 digits), not LOC-NNNN. Matches resource-identifiers.md. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Match the LOC-NNN (3 digit) location external_key format. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Documents the 3-digit location auto-mint format and the deliberate asymmetry with ASSET-NNNN. Pre-launch correction superseding the previously-documented LOC-NNNN format. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Deploying docs with
|
| Latest commit: |
15ed87f
|
| Status: | 🚫 Build failed. |
|
🚀 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 |
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 follow-on to platform PR trakrf/platform#418. The location
external_keyauto-mint format shipped asLOC-NNN(3 digits, first mintLOC-001), narrower thanASSET-NNNN(4 digits) by deliberate triage decision — locations are typically named-and-known artifacts (warehouse rooms, dock doors, zones) where auto-mint is the exception rather than the norm.docs/api/resource-identifiers.md— auto-mint table updated; new paragraph after the table explains the asset/location asymmetry rationale and the digit-count-agnostic property of both formats (past the natural width —LOC-1000+,ASSET-10000+— the pattern continues without zero-pad reflow, so client parsers should match^LOC-\d{3,}$/^ASSET-\d{4,}$rather than fixed-width groups).docs/api/errors.md— the retry-mint reference in thePOST /assets,POST /locationsidempotency bullet now readsLOC-NNN.docs/api/date-fields.md— outbound example payload usesLOC-001/LOC-002.docs/api/changelog.md— new entry under## v1.0 — Launch (TBD)documenting the finalization.The BB52 historical paragraph in the changelog that mentions the previously-documented
LOC-NNNNshape is preserved as-written — replacing it would rewrite history. The new entry above supersedes it for the current format.Test plan
pnpm typecheck— cleanpnpm lint— no new findings (thedocs/api/errors.mdandsuperpowers/*warnings are pre-existing on main)pnpm build— clean, no broken links, MDX compilesmain🤖 Generated with Claude Code