docs(api): TRA-740 BB42 F3 — uniform accept-if-matches on http-method-coverage#156
Merged
mikestankavich merged 1 commit intoMay 16, 2026
Merged
Conversation
…-coverage Drop the artificial two-category split (round-trip-safe vs dedicated- mutation-surface) on /docs/api/http-method-coverage. The service applies accept-if-matches uniformly: a verbatim echo of any read-only field is silently stripped, and a differing value returns 400 read_only with the dedicated write path. Aligns the merge-patch semantics paragraph with the per-field accounting already in resource-identifiers and errors (BB39 work). Verified live: external_key, tags, and parent_external_key all 200 on verbatim echo and 400 only on mismatch — same as id/timestamps/ location_external_key. Cross-page check on resource-identifiers and errors confirms both already describe the uniform rule correctly; no edits needed there.
|
🚀 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: |
bb488d4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a09d2ad1.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
application/merge-patch+jsonparagraph on/docs/api/http-method-coverage.GET→PATCHround-trip); differing value →400 read_onlynaming the dedicated write path./docs/api/resource-identifiersand/docs/api/errorsalready describe the uniform rule correctly (BB39 work) — no edits needed there.Why
BB42 verified that
external_key,tags, andparent_external_keyall return 200 on verbatim echo and only 400 on mismatch — same asid/timestamps/location_external_key. The previous prose promised an unconditional 400 for the second-category fields, which an integrator following the full-object round-trip pattern would never observe. Two failure modes (verbatim echo vs stale-cache rewrite) diverged silently in the contract.No platform changes — service behavior is correct.
Test plan
pnpm typecheckpnpm buildpnpm dlx prettier --check docs/api/http-method-coverage.mdresource-identifiers.mdanderrors.mddescribe accept-if-matches uniformlyCloses TRA-740.
🤖 Generated with Claude Code