[I] OpenAPI3Components
Reusable OpenAPI 3.0 definitions. A component has no effect until an operation or another definition references it.
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `x-${string}`]: anyProperties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
examples? | Record<string, OpenAPI3Example> | Named examples that media types or parameters can reference. |
headers? | Record<string, OpenAPI3Header> | Reusable header definitions keyed by component name. The referencing response or encoding’s headers map supplies the HTTP header name. |
links? | Record<string, OpenAPI3Link> | Named relationships from a response to another operation. |
parameters? | Record<string, OpenAPI3Parameter> | Reusable parameters, each retaining its own name and location. |
requestBodies? | Record<string, OpenAPI3RequestBody> | Reusable request payload descriptions and media types. |
responses? | Record<string, OpenAPI3Response> | Reusable response descriptions, payloads and headers. |
schemas? | Record<string, OpenAPI3Schema> | Named schemas addressed through #/components/schemas/{name}. |
securitySchemes? | Record<string, OpenAPI3SecurityScheme> | Authentication definitions selected by name in security requirements. |