Interface ComponentsObject

Hierarchy

  • ComponentsObject

Properties

callbacks? examples? headers? links? parameters? requestBodies? responses? schemas? securitySchemes?

Properties

Optional callbacks

callbacks?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.CallbackObject;
}

Type declaration

Optional examples

examples?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ExampleObject;
}

Type declaration

Optional headers

headers?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.HeaderObject;
}

Type declaration

Optional links

links?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.LinkObject;
}

Type declaration

Optional parameters

parameters?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject;
}

Type declaration

Optional requestBodies

requestBodies?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.RequestBodyObject;
}

Type declaration

Optional responses

responses?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.ResponseObject;
}

Type declaration

Optional schemas

schemas?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
}

Type declaration

Optional securitySchemes

securitySchemes?: {
    [key: string]: OpenAPIV3.ReferenceObject | OpenAPIV3.SecuritySchemeObject;
}

Type declaration

Settings

Member Visibility

Theme

Generated using TypeDoc