OpenAPI v3.0: Add Security Scheme info#61
Open
mhuin wants to merge 2 commits intosphinx-contrib:masterfrom
Open
OpenAPI v3.0: Add Security Scheme info#61mhuin wants to merge 2 commits intosphinx-contrib:masterfrom
mhuin wants to merge 2 commits intosphinx-contrib:masterfrom
Conversation
When an endpoint requires authentication, document the type of authentication needed. If the authentication requires scope(s) (OAuth2, OpenIDConnect), specify the scopes. If the authentication requires an API key in the query parameters, add the parameter to the list of parameters in the documentation.
Member
|
Hey @mhuin! Thanks for the patch! Can you please add a test for this? I'm working on some refactoring now, and I just want to make sure once my refactoring is rolled out, I don't accidentally break something that is previously worked. |
Author
|
Not sure if the formatted output is correct, can you have a look at the tests and let me know if I should do it differently? thanks! |
Author
|
Hello, |
|
Hi, |
|
Is there any news/progress on this? |
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
4 participants
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.
When an endpoint requires authentication, document the type of
authentication needed. If the authentication requires scope(s)
(OAuth2, OpenIDConnect), specify the scopes.
If the authentication requires an API key in the query parameters,
add the parameter to the list of parameters in the documentation.