api-morph / ComponentsObject
Interface: ComponentsObject
Defined in: src/types/openapi.ts:247
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 outside the Components Object.
See
https://spec.openapis.org/oas/v3.1.1#components-object
Indexable
[key: `x-${string}`]: any
This object MAY be extended with Specification Extensions.
Properties
callbacks?
optionalcallbacks:Record<string,ReferenceObject|CallbackObject>
Defined in: src/types/openapi.ts:291
An object to hold reusable Callback Objects.
examples?
optionalexamples:Record<string,ReferenceObject|ExampleObject>
Defined in: src/types/openapi.ts:266
An object to hold reusable Example Objects.
headers?
optionalheaders:Record<string,ReferenceObject|HeaderObject>
Defined in: src/types/openapi.ts:276
An object to hold reusable Header Objects.
links?
optionallinks:Record<string,ReferenceObject|LinkObject>
Defined in: src/types/openapi.ts:286
An object to hold reusable Link Objects.
parameters?
optionalparameters:Record<string,ReferenceObject|ParameterObject>
Defined in: src/types/openapi.ts:261
An object to hold reusable Parameter Objects.
pathItems?
optionalpathItems:Record<string,PathItemObject>
Defined in: src/types/openapi.ts:296
An object to hold reusable Path Item Objects.
requestBodies?
optionalrequestBodies:Record<string,ReferenceObject|RequestBodyObject>
Defined in: src/types/openapi.ts:271
An object to hold reusable Request Body Objects.
responses?
optionalresponses:Record<string,ResponseObject|ReferenceObject>
Defined in: src/types/openapi.ts:256
An object to hold reusable Response Objects.
schemas?
optionalschemas:Record<string,boolean|SchemaObject>
Defined in: src/types/openapi.ts:251
An object to hold reusable Schema Objects.
securitySchemes?
optionalsecuritySchemes:Record<string,ReferenceObject|SecuritySchemeObject>
Defined in: src/types/openapi.ts:281
An object to hold reusable Security Scheme Objects.