[I] OpenAPIComponents3_1
Reusable OpenAPI 3.1 definitions, including callbacks and path items not modeled in the 3.0 component shape.
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `x-${string}`]: anyProperties
Section titled “Properties”| Property | Type | Description |
|---|---|---|
callbacks? | Record<string, Record<string, OpenAPI3PathItem>> | Named callbacks mapping runtime URL expressions to the requests the API may initiate. |
examples? | Record<string, Refable<OpenAPI3Example>> | Named examples for reuse by parameters or media types. |
headers? | Record<string, Refable<OpenAPI3Header>> | Header definitions or aliases; usage sites supply the header name. |
links? | Record<string, Refable<OpenAPI3Link>> | Reusable relationships from a response to another operation. |
parameters? | Record<string, Refable<OpenAPI3Parameter>> | Parameter definitions or aliases; each definition supplies its own name and location. |
pathItems? | Record<string, OpenAPI3PathItem> | Named path definitions reusable independently of a concrete URL path. |
requestBodies? | Record<string, Refable<OpenAPI3RequestBody>> | Request body definitions or aliases, separate from named parameters. |
responses? | Record<string, Refable<OpenAPI3Response>> | Response definitions or aliases, referenced from an operation’s response map. |
schemas? | Record<string, OpenAPISchema3_1> | Named schemas using the 3.1 JSON Schema vocabulary rather than the 3.0 schema subset. |
securitySchemes? | Record<string, Refable<OpenAPI3SecurityScheme>> | Authentication definitions selected by name in security requirements. |