docs(api): TRA-799 — remove asset current-location from the API docs#187
Merged
Conversation
added 7 commits
May 22, 2026 11:13
…ource-identifiers
…rt/errors/design-notes
|
🚀 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: |
cd8910b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://5487ffb7.docs-4n7.pages.dev |
| Branch Preview URL: | https://docs-tra-799-current-locatio.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
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.
Docs-only companion to platform PR trakrf/platform#384 (TRA-799). The platform change makes an asset's current location fact data, not a dimension attribute the asset resource carries. This PR brings
docs/api/in line with that contract.Three contract changes documented
location_id/location_external_keyare removed from the asset resource.GET /api/v1/assetsandGET /api/v1/assets/{asset_id}return master data only. Current location is read fromGET /api/v1/reports/asset-locationsorGET /api/v1/assets/{asset_id}/history.location_id/location_external_keyin aPOSTorPATCHbody are rejected400/code: read_onlyon presence. The priorPATCHaccept-if-matches / reject-if-differs handling is retired — with location off the read shape there is nothing to echo.?location_id/?location_external_keyfilters are removed fromGET /api/v1/assets. Filter by location on/reports/asset-locationsinstead.The reporting endpoints (
/reports/asset-locations,/assets/{id}/history) are unchanged — they remain the system of record for asset location.Files changed
data-model.md— asset detail view dropped from the scan-data consumption table;POST/PATCHrejection prose unified.resource-identifiers.md— the page used assetlocation_*as its primary teaching example for FK-pair, present-as-null, accept-if-matches, and list-filter patterns; those examples are re-anchored onLocationView.parent_*and the/reports/asset-locationsrow. Paired-key matrix reworked.pagination-filtering-sorting.md—/assetslocation filter removed from the param table, mutual-exclusion rule, repeatable-filter examples, validator prose, and worked example.quickstart.mdx,errors.md,design-notes.md— corrected sentences that framed assetlocation_*as a read-shape / accept-if-matches field.changelog.md— newv1.0entry; prior entries (BB40, BB63) left as historical record.The OpenAPI-driven
/apiinteractive reference is generated from the platform-synced spec and updates with that sync — not hand-edited here. Design spec + plan included undersuperpowers/.Verification
pnpm buildpasses — no broken internal links or anchors.git grepaudit: every remaininglocation_id/location_external_keyhit is a path parameter, aparent_*reference, aLocationViewfield, or a/reports/asset-locations/ history row — none describes an asset response field or an/assetslist filter.errors.mdcarries pre-existing, unrelated Prettier drift frommain, left untouched).🤖 Generated with Claude Code