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

feat: New page for OpenAPI security features #78

Merged
merged 8 commits into from
Feb 15, 2024

Conversation

SensibleWood
Copy link
Collaborator

@SensibleWood SensibleWood commented Feb 1, 2024

This PR addresses Issue #74.

Summary of changes:

  • Added Security page to specification directory.
  • Provided overview of Security Scheme Object and Security Requirement Object and relationship between both.
  • Provided details on each security type with examples inlne.
  • Updated tictactoe OpenAPI document with examples.
  • Added a note to README on running Jekyll and pointer to Contributing Guide.
  • Updated link to this repository in _config.yml.
  • Added diagram to represent security-related objects in digraph and SVG formats.

👍 cc @lornajane

specification/security.md Outdated Show resolved Hide resolved
Copy link
Member

@handrews handrews left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

specification/security.md Outdated Show resolved Hide resolved
specification/security.md Show resolved Hide resolved
@miqui
Copy link
Collaborator

miqui commented Feb 6, 2024

@SensibleWood - have you seen this: https://swagger.io/docs/specification/authentication/

I think this is very similar to what you are proposing.

@SensibleWood
Copy link
Collaborator Author

@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


<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>
Copy link
Contributor

@ralfhandl ralfhandl Feb 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"based on a theme based on [a] theme" - really that indirect?


<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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<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>

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't write that sentence nor sourced the theme so can't say whether the indirection is accurate or not...

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@darrelmiller darrelmiller left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This doc page is a great. Thank you!

@darrelmiller darrelmiller merged commit e9de40c into OAI:main Feb 15, 2024
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.

7 participants