Skip to content

Conversation

tim-lai
Copy link
Contributor

@tim-lai tim-lai commented Sep 15, 2022

Description

Documentation for OpenAPI 3.1.0 Security Scheme Object

Motivation and Context

Ref #1993

How Has This Been Tested?

local.

fixture:

openapi: 3.1.0
info:
  title: deref
  version: 1.0.0
components:
  securitySchemes:
    oauth2-server:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: 'https://some-url.com/auth'
          tokenUrl: 'https://some-url/token'
          refreshUrl: 'https://some-url/token'
          scopes:
            user: allows user resources
            admin: allows admin resources
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

Screenshots (if appropriate):

parent:
ls-pr-2018-security-scheme-1

example target 1 type:

ls-pr-2018-security-scheme-2-target-1

example target 2 scheme:

ls-pr-2018-security-scheme-2-target-2

example target 3 bearerFormat:

ls-pr-2018-security-scheme-2-target-3

Checklist

My PR contains...

  • No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • Dependency changes (any modification to dependencies in package.json)
  • Bug fixes (non-breaking change which fixes an issue)
  • Improvements (misc. changes to existing features)
  • Features (non-breaking change which adds functionality)

My changes...

  • are breaking changes to a public API (config options, System API, major UI change, etc).
  • are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • are not breaking changes.

Documentation

  • My changes do not require a change to the project documentation.
  • My changes require a change to the project documentation.
  • If yes to above: I have updated the documentation accordingly.

Automated tests

  • My changes can not or do not need to be tested.
  • My changes can and should be tested by unit and/or integration tests.
  • If yes to above: I have added tests to cover my changes.
  • If yes to above: I have taken care to cover edge cases in my tests.
  • All new and existing tests passed.

@tim-lai tim-lai changed the title feat(ls): oas31 docs for security scheme object feat(ls): docs for OpenApi 3.1.0 Security Scheme object Sep 15, 2022
@tim-lai tim-lai added enhancement New feature or request OpenAPI 3.1 ApiDOM labels Sep 15, 2022
@tim-lai tim-lai merged commit 1e983af into main Sep 15, 2022
@tim-lai tim-lai deleted the feat/oas31-docs-securityScheme branch September 15, 2022 21:03
@tim-lai tim-lai self-assigned this Sep 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant