Petstore API

1.0

Example to show how to use x-client-id, x-client-secret and x-default-scopes vendor extensions to pre fill them in the UI.

Below is the Open API spec snippet that shows its usage, and if you check the authentication section you will find that client-id and client-secret are pre-filled, the user just needs to click on GET TOKEN. Also notice that the scope dog-lover is already checked

  openapi: 3.0.0
  ...
  ...
  components:
    securitySchemes:
      exampleOauth2Flow:
        type: oauth2
        x-client-id: my-client-id             # <--- when provided it will be pre filled in RapiDoc UI
        x-client-secret: my-client-secret     # <--- when provided it will be pre filled in RapiDoc UI
        x-default-scopes: [dog-lover]         # <--- when provided scopes will be pre checked in RapiDoc UI
        x-receive-token-in: request-body      # <--- can be 'header' or 'request-body' when provided this will be pre selected
        flows:
          authorizationCode:
            authorizationUrl: /authorize
            tokenUrl: /access_token
            scopes:
              dog-lover: "always required"
              owner: "optional"