When we are using API document (yaml file) created as per OPEN API 3.0.0 standard , it is not showing the Authorize button. I have used Component: SecuritySchemes as per Open API 3.0.0 standard.
When I upload the yaml it is correctly showing the Authorize button and allowing me to select security schemes.
Please help.
YAML FIle:: (formatting is broken here because of copy paste, please use online yaml formatter)
openapi: 3.0.0
info:
version: 1.0.0-oas3
title: Sample
description: These is changed as sample
contact:
name: API Team or Solutions Architecture Team
servers:
- url: 'https://sample.com'
description: Development server
- url: 'https://sample.com'
description: QA server
- url: 'https://sample.com'
description: Production server
paths:
'/accesstoken':
post:
description: >-
endpoint to generate Oauth2 access token
tags:
- ARN Auth
security:
- basicAuth: []
parameters:
- name: grant_type
in: query
description: Grant Type
required: true
schema:
type: string
responses:
'200':
description: A Members Authentication Request Object
content:
application/json:
schema:
$ref: '#/components/schemas/OauthAuthenticationResponse'
default:
description: unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
components:
securitySchemes:
basicAuth:
type: http
scheme: basic
oauth2Pass:
type: oauth2
flows:
password:
tokenUrl: https://api.getbase.com/oauth2/token
scopes:
write: write permissions
read: read permissions
clientCredentials:
tokenUrl: https://api.getbase.com/oauth2/token
scopes:
write: write permissions
read: read permissions
authorizationCode:
authorizationUrl: https://example.com/oauth/authorize
tokenUrl: https://example.com/oauth/token
scopes:
write: write permissions
read: read permissions
implicit:
authorizationUrl: https://example.com/api/oauth/dialog
scopes:
write: write permissions
read: read permissions
APIKeyAuth:
type: apiKey
in: header
name: X-API-Key
BearerTokenAuth:
type: http
scheme: bearer
bearerFormat: JWT
OpenID:
type: openIdConnect
openIdConnectUrl: https://example.com/.well-known/openid-configuration
schemas:
OauthAuthenticationResponse:
type: object
properties:
access_token:
type: string
refresh_token:
type: string
expires_in:
type: string
refresh_token_expires_in:
type: string
token_type:
type: string
status:
type: string
Error:
type: object
required:
- code
- message
properties:
code:
type: string
message:
type: string
info:
type: string
errors:
type: array
items:
$ref: '#/components/schemas/ErrorMessages'
ErrorMessages:
type: object
properties:
code:
type: string
message:
type: string
LinkedIn
Twitter
