Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAPI v3.0: Add Security Scheme info #61

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

mhuin
Copy link

@mhuin mhuin commented Sep 18, 2019

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.

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.
@ikalnytskyi
Copy link
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.

@mhuin
Copy link
Author

mhuin commented Oct 11, 2019

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!

@mhuin
Copy link
Author

mhuin commented Nov 20, 2019

Hello,
Anything else I need to do to get this merged?
Thanks!

@puschkin
Copy link

Hi,
I'm also interested in this pull request.
What's the status? I see there are conflicts which have to be resolved and some checks.
Does this mean tests are missing or are only not executed?
What about the docs task? The doc has to be written, right?

@vancheese
Copy link

Is there any news/progress on this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants