Components

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.

struct Components {

@optional

Schema[string] schemas;

@optional

Response[string] responses;

@optional

Parameter[string] parameters;

@optional

Example[string] examples;

@optional

RequestBody[string] requestBodies;

@optional

Header[string] headers;

@optional

SecurityScheme[string] securitySchemes;

@optional

Link[string] links;

@optional

Callback[string] callbacks;

mixin Serialization!Components ;

}

Members

Mixins

__anonymous mixin Serialization!Components: Undocumented in source.

Variables

callbacks Callback[string] callbacks;: An object to hold reusable Callback Objects.
examples Example[string] examples;: An object to hold reusable Example Objects.
headers Header[string] headers;: An object to hold reusable Header Objects.
links Link[string] links;: An object to hold reusable Link Objects.
parameters Parameter[string] parameters;: An object to hold reusable Parameter Objects.
requestBodies RequestBody[string] requestBodies;: An object to hold reusable Request Body Objects.
responses Response[string] responses;: An object to hold reusable Response Objects.
schemas Schema[string] schemas;: An object to hold reusable Schema Objects.
securitySchemes SecurityScheme[string] securitySchemes;: An object to hold reusable Security Scheme Objects.

Components

Members

Mixins

Variables

Meta

Source