API: simplify and standardize data usage#281
Merged
Conversation
It does not include itself in the response.
agjohnson
reviewed
Apr 10, 2024
Contributor
agjohnson
left a comment
There was a problem hiding this comment.
This looks great! I didn't spend too much time looking through the schemas, but trust our tests would pick up issues there anyways.
Member
Author
I can confirm this. I took me a lot of time to adapt them to the new schema 😅 |
agjohnson
approved these changes
Apr 10, 2024
Co-authored-by: Anthony <aj@ohess.org>
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.
Implements the changes in the API made in readthedocs/readthedocs.org#11205. We need to merge that PR and deploy addons together with the changes in this PR.
In this PR there are mainly no changes in the logic. The most important thing to mention here is that we are standardizing the usage of the API response and pinning to
v1now (we were usingv0-alpha). This means:v1to users via the js custom event (see API: use<meta>to define supported API version and triggerCustomEvent#64)/addons/endpointI'm not sure there are too much to review here, but I'd appreciate at least a quick look at these changes. I'm happy to answer some questions you may have here or on the underlying PR about the API response changes.
Related:
stable/latestaliases #132project.versioning_schemefor links #265