OasComponents

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.

class OasComponents {

@jsonOptional

OasSchema[string] schemas;

@jsonOptional

OasResponse[string] responses;

@jsonOptional

OasParameter[string] parameters;

@jsonOptional

OasExample[string] examples;

@jsonOptional

OasRequestBody[string] requestBodies;

@jsonOptional

OasHeader[string] headers;

@jsonOptional

OasSecurityScheme[string] securitySchemes;

@jsonOptional

OasLink[string] links;

@jsonOptional

OasCallback[string] callbacks;

}

Members

Variables

callbacks OasCallback[string] callbacks;: An object to hold reusable OasCallback objects.
examples OasExample[string] examples;: An object to hold reusable OasExample objects.
headers OasHeader[string] headers;: An object to hold reusable OasHeader objects.
links OasLink[string] links;: An object to hold reusable OasLink objects.
parameters OasParameter[string] parameters;: An object to hold reusable OasParameter objects.
requestBodies OasRequestBody[string] requestBodies;: An object to hold reusable OasRequestBody objects.
responses OasResponse[string] responses;: An object to hold reusable OasResponse objects.
schemas OasSchema[string] schemas;: An object to hold reusable OasSchema objects.
securitySchemes OasSecurityScheme[string] securitySchemes;: An object to hold reusable OasSecurityScheme objects.

OasComponents

Members

Variables

Meta

Source