blob: b11da78a8513d611a2ecd677f066d0a4554daa1f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
|
from __future__ import annotations
from dataclasses import dataclass, field
from typing import TYPE_CHECKING
from litestar.openapi.spec.base import BaseSchemaObject
__all__ = ("Components",)
if TYPE_CHECKING:
from litestar.openapi.spec.callback import Callback
from litestar.openapi.spec.example import Example
from litestar.openapi.spec.header import OpenAPIHeader
from litestar.openapi.spec.link import Link
from litestar.openapi.spec.parameter import Parameter
from litestar.openapi.spec.path_item import PathItem
from litestar.openapi.spec.reference import Reference
from litestar.openapi.spec.request_body import RequestBody
from litestar.openapi.spec.response import OpenAPIResponse
from litestar.openapi.spec.schema import Schema
from litestar.openapi.spec.security_scheme import SecurityScheme
@dataclass
class Components(BaseSchemaObject):
"""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.
"""
schemas: dict[str, Schema] = field(default_factory=dict)
"""An object to hold reusable
`Schema Objects <https://spec.openapis.org/oas/v3.1.0#schemaObject>`_"""
responses: dict[str, OpenAPIResponse | Reference] | None = None
"""An object to hold reusable
`Response Objects <https://spec.openapis.org/oas/v3.1.0#responseObject>`_"""
parameters: dict[str, Parameter | Reference] | None = None
"""An object to hold reusable
`Parameter Objects <https://spec.openapis.org/oas/v3.1.0#parameterObject>`_"""
examples: dict[str, Example | Reference] | None = None
"""An object to hold reusable
`Example Objects <https://spec.openapis.org/oas/v3.1.0#exampleObject>`_"""
request_bodies: dict[str, RequestBody | Reference] | None = None
"""An object to hold reusable
`Request Body Objects <https://spec.openapis.org/oas/v3.1.0#requestBodyObject>`_"""
headers: dict[str, OpenAPIHeader | Reference] | None = None
"""An object to hold reusable
`Header Objects <https://spec.openapis.org/oas/v3.1.0#headerObject>`_"""
security_schemes: dict[str, SecurityScheme | Reference] | None = None
"""An object to hold reusable
`Security Scheme Objects <https://spec.openapis.org/oas/v3.1.0#securitySchemeObject>`_"""
links: dict[str, Link | Reference] | None = None
"""An object to hold reusable
`Link Objects <https://spec.openapis.org/oas/v3.1.0#linkObject>`_"""
callbacks: dict[str, Callback | Reference] | None = None
"""An object to hold reusable
`Callback Objects <https://spec.openapis.org/oas/v3.1.0#callbackObject>`_"""
path_items: dict[str, PathItem | Reference] | None = None
"""An object to hold reusable
`Path Item Object <https://spec.openapis.org/oas/v3.1.0#pathItemObject>`_"""
|
