openapi icon indicating copy to clipboard operation
openapi copied to clipboard

Published 20 hours ago • verified publisher icon sphinx-contrib

OpenAPI v3.0: Add Security Scheme info

Open mhuin opened this issue 5 years ago • 5 comments

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.

mhuin avatar Sep 18 '19 16:09 mhuin

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.

ikalnytskyi avatar Oct 04 '19 20:10 ikalnytskyi

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 avatar Oct 11 '19 11:10 mhuin

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

mhuin avatar Nov 20 '19 10:11 mhuin

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?

puschkin avatar Jan 27 '20 07:01 puschkin

Is there any news/progress on this?

vancheese avatar Oct 22 '20 09:10 vancheese