Optional OAuth2 authentication

optional_auth_openapi.yaml

openapi: "3.0.3"
info:
  title: Service with different authentication
  version: "0.1"

paths:
  /default_optional_auth:
    get:
      summary: Method with optional authentication, from a default policy.
      operationId: default_optional_auth
      responses:
        "200":
          description: Information about the currently logged in user.
          content:
            application/json:
              schema:
                type: string
                description: Current user ID
                nullable: true

  /path_level_optional_auth:
    get:
      summary: Method with optional authentication, from a path-level policy.
      operationId: path_level_optional_auth
      responses:
        "200":
          description: Information about the currently logged in user.
          content:
            application/json:
              schema:
                type: string
                description: Current user ID
                nullable: true
      security:
        - {}
        - oauth:
            - special:api

  /required_auth:
    get:
      summary: Method with mandatory authentication, from a path-level policy.
      operationId: required_auth
      responses:
        "200":
          description: Information about the currently logged in user.
          content:
            application/json:
              schema:
                type: string
                description: Current user ID
                nullable: false
      security:
        - oauth:
            - write:api

components:
  securitySchemes:
    oauth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://auth.example.com/authorize
          tokenUrl: https://auth.example.com/token
          scopes:
            read:api: API read access
            special:api: API special access
            write:api: API write access

security:
  - {}
  - oauth:
      - read:api