fix(api): document ratings response variants - #890
Open
kevincador wants to merge 1 commit into
Open
Conversation
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
Correct the ratings endpoint contracts and documentation to represent both
response forms:
rating,votes, anddistributionat the toplevel.
extended=allreturns a nestedtraktobject plus supported external ratingproviders.
Closes #872
Changes
extendedquery parameter toall.defaultandextendedAllOpenAPI response examples.metascore, as optional.Risk
Low. The response type is widened to represent both payloads already returned
by the API. Generated clients cannot statically select a response shape from a
query parameter, so the two variants are distinguished through named examples
and endpoint documentation.