Interface IComponents

Reusable components storage.

interface IComponents {
    examples?: Record<string, OpenApiV3.IExample>;
    headers?: Record<string, Omit<OpenApiV3.IOperation.IParameter, "in">>;
    parameters?: Record<string, OpenApiV3.IOperation.IParameter>;
    requestBodies?: Record<string, OpenApiV3.IOperation.IRequestBody>;
    responses?: Record<string, OpenApiV3.IOperation.IResponse>;
    schemas?: Record<string, OpenApiV3.IJsonSchema>;
    securitySchemes?: Record<string, OpenApiV3.ISecurityScheme>;
}

Index

Properties

examples? headers? parameters? requestBodies? responses? schemas? securitySchemes?

Properties

`Optional`examples

examples?: Record<string, OpenApiV3.IExample>

Named examples.

`Optional`headers

headers?: Record<string, Omit<OpenApiV3.IOperation.IParameter, "in">>

Named headers.

`Optional`parameters

parameters?: Record<string, OpenApiV3.IOperation.IParameter>

Named parameters.

`Optional`requestBodies

requestBodies?: Record<string, OpenApiV3.IOperation.IRequestBody>

Named request bodies.

`Optional`responses

responses?: Record<string, OpenApiV3.IOperation.IResponse>

Named responses.

`Optional`schemas

schemas?: Record<string, OpenApiV3.IJsonSchema>

Named schemas.

`Optional`securitySchemes

securitySchemes?: Record<string, OpenApiV3.ISecurityScheme>

Named security schemes.