api-typescript-generator / Modules / openapi / OpenApiComponents
openapi.OpenApiComponents
Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object.
See
https://swagger.io/specification/#components-object
- callbacks
- examples
- headers
- links
- parameters
- pathItems
- requestBodies
- responses
- schemas
- securitySchemes
• Optional callbacks: Record<string, Record<string, OpenApiPathItem>>
An object to hold reusable Callback Objects.
• Optional examples: Record<string, OpenApiExample>
An object to hold reusable Example Objects.
• Optional headers: Record<string, OpenApiHeader>
An object to hold reusable Header Objects.
• Optional links: Record<string, OpenApiLink>
An object to hold reusable Link Objects.
• Optional parameters: Record<string, OpenApiParameter>
An object to hold reusable Parameter Objects.
• Optional pathItems: Record<string, OpenApiPathItem>
An object to hold reusable Path Item Objects.
• Optional requestBodies: Record<string, OpenApiRequestBody>
An object to hold reusable Request Body Objects.
• Optional responses: Record<string, OpenApiResponse>
An object to hold reusable Response Objects.
• Optional schemas: Record<string, OpenApiSchema>
An object to hold reusable Schema Objects.
• Optional securitySchemes: Record<string, OpenApiSecurityScheme>
An object to hold reusable Security Scheme Objects.