Components

class Components(d: dict[str, Any] = None, schemas: dict[str, Schema] = None, responses: dict[str, Response | Reference] = None, parameters: dict[str, Parameter | Reference] = None, examples: dict[str, Example | Reference] = None, requestBodies: dict[str, RequestBody | Reference] = None, headers: dict[str, Header | Reference] = None, securitySchemes: dict[str, SecurityScheme | Reference] = None, links: dict[str, Link | Reference] = None, callbacks: dict[str, Callback | Reference] = None, pathItems: dict[str, PathItem] = None)

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.

property schemas: dict[str, Schema] | None

An object to hold reusable Schema Objects.

property responses: dict[str, Response | Reference] | None

An object to hold reusable Response Objects.

property parameters: dict[str, Parameter | Reference] | None

An object to hold reusable Parameter Objects.

property examples: dict[str, Example | Reference] | None

An object to hold reusable Example Objects.

property requestBodies: dict[str, RequestBody | Reference] | None

An object to hold reusable Request Body Objects.

property headers: dict[str, Header | Reference] | None

An object to hold reusable Header Objects.

property securitySchemes: dict[str, SecurityScheme | Reference] | None

An object to hold reusable Security Scheme Objects.

property links: dict[str, Link | Reference] | None

An object to hold reusable Link Objects.

property callbacks: dict[str, Callback | Reference] | None

An object to hold reusable Callback Objects.

property pathItems: dict[str, PathItem] | None

An object to hold reusable Path Item Objects.