Document Storefront customer auth and Stripe capture contracts - #54
Merged
Conversation
Both branches added the identical Customer-Token headers to the two
customer update requests, so only the descriptions conflicted — resolved
by combining this branch's exact 403 error contract with main's
authoritative-identity framing.
Capture checkout as order keeps main's functional change (it captures
the cash pickup checkout via {{cash_checkout_token}}, since a contract
run cannot complete a card payment) and this branch's documentation of
the idempotency and 402/409/422/502 verification contract, plus a note
pointing at the explicit 402 negative-contract request.
Validation: node scripts/validate-collections.js (5 collections, 3
environments) and postman collection lint on Fleetbase Storefront API —
62 items scanned, 0 errors, 0 warnings.
Member
Author
|
Resolved the merge conflicts with What survived the merge:
Is this PR still necessary? Yes, in its reduced form: after #55, its remaining value is documentation — the README section, and the richer capture/update descriptions (idempotency, exact error strings, the full status-code contract). The functional header changes are now no-ops relative to main. Validation after resolution: |
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.
Summary
Customer-Tokenon both Storefront customer profile update routesSource of truth
Aligned with the merged Storefront module changes on
dev-v0.4.20(PRs #92, #94, and #95).Validation
npm run postman:lintTest scope
The collection runner was not executed because the committed local environment intentionally contains no Storefront API credential. No secrets were added.
Documentation impact
The editable Storefront API collection and its repository reference README are updated. No generated fleetbase.io documentation was modified.