Skip to content

feat: New page for OpenAPI security features - #78

Merged
darrelmiller merged 8 commits into
OAI:mainfrom
SensibleWood:main
Feb 15, 2024
Merged

darrelmiller merged 8 commits into
OAI:mainfrom
SensibleWood:main

Conversation

@SensibleWood

@SensibleWood SensibleWood commented Feb 1, 2024 •

Copy link
Copy Markdown
Collaborator

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

Comment thread specification/security.md Outdated

@handrews handrews left a comment

Copy link
Copy Markdown
Member

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.

Comment thread specification/security.md Outdated
Comment thread specification/security.md
@miqui

miqui commented Feb 6, 2024

Copy link
Copy Markdown
Contributor

@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
Copy Markdown
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

Comment thread specification/security.md Outdated
Comment thread README.md
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>

@ralfhandl ralfhandl Feb 9, 2024 •

Copy link
Copy Markdown
Contributor

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?

Comment thread README.md
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>

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

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.

@darrelmiller darrelmiller left a comment

Copy link
Copy Markdown
Member

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