enhance: standardize API endpoints #981
Merged
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
- Wrap return JSON in an "envelope" to provide the ability to send down viewable data versus metadata (such as paging information). - Moves spec `json_response` to a support/api_helpers file to allow for a single source for parsing response body into json_response (data) and json_meta (meta). Eventually we will want to add API headers for versioning so we can introduce changes with backwards compatibility.
rudokemper
approved these changes
Oct 28, 2023
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.
json_responseto a support/api_helpers file to allow for a single source for parsing response body into json_response (data) and json_meta (meta).Eventually we will want to add API headers for versioning so we can introduce changes with backwards compatibility.