[I] OpenAPI3SecuritySchemeBase

defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), OAuth2’s common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect Discovery.

See

https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#security-scheme-object

Extends

• Extensions

Extended by

• OpenAPI3ApiKeySecurityScheme
• OpenAPI3HttpSecurityScheme
• OpenAPI3OAuth2SecurityScheme
• OpenAPI3OpenIdConnectSecurityScheme

Indexable

[key: `x-${string}`]: any

Properties

Property	Type	Description
description?	string	A short description for security scheme. CommonMark syntax MAY be used for rich text representation.