MPP-3799: Add schemas for privaterelay APIs #4661
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
This gets rid of the warning drf_spectacular.W002, but does not allow testing with the browsable API. A proper authentication class is needed to allow testing, and it will still be weird.
groovecoder
approved these changes
May 3, 2024
| required=True, | ||
| location="header", | ||
| examples=[OpenApiExample("bearer", "Bearer XXXX-ZZZZ")], | ||
| description="FXA Bearer Token. Can not be set in browsable API.", |
There was a problem hiding this comment.
praise: thanks for adding this to make it clear to api doc readers they can't use this endpoint in the docs.
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.
How to test:
In the browsable API at http://127.0.0.1:8000/api/v1/docs/, views are grouped, and each view function has documentation and examples:
/api/v1/flags/,/api/v1/profiles/, and/api/v1/users/are unchanged, except for a basic description.POST /api/v1/report_webcompat_issue/GET /api/v1/runtime_data/POST /api/v1/terms-accepted-user/- Added documentation, but still can't test in the browsable API due to restrictions onAuthenticationfield, part of the spec. We'd have to implement an authorization scheme instead, could be tricky.When running
./manage.py check --deploy, no views inapi/views/privaterelay.pyhave adrf_spectacular.W002warning.