Templates and agreement partial fetch and pagination #15 #31
+697
−556
Conversation
This file contains 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
Signed-off-by: Chibuezem Marvinrose <[email protected]>
Signed-off-by: Chibuezem Marvinrose <[email protected]>
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.
Fixes #15 by addressing large response concerns for GET /templates and GET /agreements:
Added Pagination: Both endpoints support offset and limit (capped at 100 server-side), with meta (total, offset, limit) and links (self, next, prev, first, last) in the response
Implemented
fieldsparam for Partial Fetching: The fields query param (e.g., ?fields=id,name) allows clients to fetch specific fields, supporting the alternative pattern of listing IDs/names followed by individual requests (e.g., GET /templates/{name}).Added
fullparam to toggle full objects (e.g.,?full=true).Updated
openapi.jsonto document these params, removedlimitmaximum to allow server-side capping.Tested with Postman to confirm functionality.