docs(api): conventions for envelopes, pagination, provenance (#321) - #336
Merged
Conversation
Document staff REST asymmetries from integrator feedback: non-modifiable source on PATCH, response envelope keys, list total/hasMore, and that externalConfirmation already works on create/import. Link from README and integrations recipes; enrich Swagger examples on reservation routes. Co-authored-by: telivity-otaip <telivity-otaip@users.noreply.github.com>
telivity-otaip
marked this pull request as ready for review
August 20, 2026 21:28
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
2 participants
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
Addresses #321 items 3–6:
source/channelCodeare not patchable onPATCH /reservations/:id(intentional){ data }— would break clients){ data, total, page, limit }and add additivehasMoreexternalConfirmationalready works on create + import; enrich Swagger descriptionsChanges
docs/api-conventions.md; linked from README API Reference and integrations recipeshasMoreon reservation list; list DTO limit descriptionTest plan
hasMore