Interface IComponents

Reusable components in OpenAPI.

A storage of reusable components in OpenAPI document.

In other words, it is a storage of named DTO schemas and security schemes.

interface IComponents {
schemas?: Record<string, OpenApi.IJsonSchema>;
securitySchemes?: Record<string, OpenApi.ISecurityScheme>;
}

Index

Properties

schemas? securitySchemes?

Properties

`Optional`schemas

schemas?: Record<string, OpenApi.IJsonSchema>

An object to hold reusable DTO schemas.

In other words, a collection of named JSON schemas.

`Optional`securitySchemes

securitySchemes?: Record<string, OpenApi.ISecurityScheme>

An object to hold reusable security schemes.

In other words, a collection of named security schemes.