Repository navigation
feat: New page for OpenAPI security features - #78
Conversation
handrews
left a comment
There was a problem hiding this comment.
This looks good! I particularly like how you called attention to how the OAS intentionally includes only the minimum necessary information.
I had one grammar nitpick, and also one suggestion that you are free to disregard. Otherwise I'm in favor of merging this.
|
@SensibleWood - have you seen this: https://swagger.io/docs/specification/authentication/ I think this is very similar to what you are proposing. |
Yes I have read it before. I would expect there is some commonality given they are both intended to be reference materials |
… OpenAPI descriptions
| Read our [Getting started](https://learn.openapis.org/) page first. | ||
| Read our [Getting Started](https://learn.openapis.org/) page first. | ||
|
|
||
| <p>Original site customized based on a theme based on theme by Patrick Marsceill, distributed by an <a href="https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt">MIT license.</a></p> |
There was a problem hiding this comment.
"based on a theme based on [a] theme" - really that indirect?
| Read our [Getting started](https://learn.openapis.org/) page first. | ||
| Read our [Getting Started](https://learn.openapis.org/) page first. | ||
|
|
||
| <p>Original site customized based on a theme based on theme by Patrick Marsceill, distributed by an <a href="https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt">MIT license.</a></p> |
There was a problem hiding this comment.
| <p>Original site customized based on a theme based on theme by Patrick Marsceill, distributed by an <a href="https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt">MIT license.</a></p> | |
| <p>Original site customized based on a theme by Patrick Marsceill, distributed by an <a href="https://github.com/pmarsceill/just-the-docs/tree/master/LICENSE.txt">MIT license.</a></p> |
There was a problem hiding this comment.
I didn't write that sentence nor sourced the theme so can't say whether the indirection is accurate or not...
There was a problem hiding this comment.
let's open a separate issue for this part - it's a good point (thanks @ralfhandl !) but it's not related to the work in this pull request.
darrelmiller
left a comment
There was a problem hiding this comment.
This doc page is a great. Thank you!
This PR addresses Issue #74.
Summary of changes:
specificationdirectory._config.yml.👍 cc @lornajane