django-bolt 0.1.0__cp310-abi3-win_amd64.whl

django_bolt/openapi/spec/response.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import TYPE_CHECKING
+
+from .base import BaseSchemaObject
+
+if TYPE_CHECKING:
+    from .header import OpenAPIHeader
+    from .link import Link
+    from .media_type import OpenAPIMediaType
+    from .reference import Reference
+
+
+__all__ = ("OpenAPIResponse",)
+
+
+@dataclass
+class OpenAPIResponse(BaseSchemaObject):
+    """Describes a single response from an API Operation, including design-time, static ``links`` to operations based on
+    the response.
+    """
+
+    description: str
+    """**REQUIRED**. A short description of the response.
+    `CommonMark syntax <https://spec.commonmark.org/>`_ MAY be used for rich text representation.
+    """
+
+    headers: dict[str, OpenAPIHeader | Reference] | None = None
+    """Maps a header name to its definition.
+    `RFC7230 <https://tools.ietf.org/html/rfc7230#page-22>`_ states header names are case insensitive.
+    If a response header is defined with the name ``Content-Type``, it SHALL be ignored.
+    """
+
+    content: dict[str, OpenAPIMediaType] | None = None
+    """A map containing descriptions of potential response payloads. The key is a media type or
+    `media type range <https://tools.ietf.org/html/rfc7231#appendix-D>`_ and the value describes it.
+
+    For responses that match multiple keys, only the most specific key is applicable. e.g. ``text/plain`` overrides
+    ``text/*``
+    """
+
+    links: dict[str, Link | Reference] | None = None
+    """A map of operations links that can be followed from the response.
+
+    The key of the map is a short name for the link, following the naming constraints of the names for
+    `Component Objects <https://spec.openapis.org/oas/v3.1.0#componentsObject>`_.
+    """

django_bolt/openapi/spec/responses.py

@@ -0,0 +1,44 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Union
+
+if TYPE_CHECKING:
+    from .reference import Reference
+    from .response import OpenAPIResponse
+
+Responses = dict[str, Union["OpenAPIResponse", "Reference"]]
+"""A container for the expected responses of an operation. The container maps a
+HTTP response code to the expected response.
+
+The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in
+advance. However, documentation is expected to cover a successful operation response and any known errors.
+
+The ``default`` MAY be used as a default response object for all HTTP codes hat are not covered individually by the
+specification.
+
+The ``Responses Object`` MUST contain at least one response code, and it SHOULD be the response for a successful
+operation call.
+
+Fixed Fields
+
+default: ``Optional[Union[Response, Reference]]``
+
+The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover
+undeclared responses. A `Reference Object <https://spec.openapis.org/oas/v3.1.0#referenceObject>`_ can link to a
+response that the `OpenAPI Object's components/responses <https://spec.openapis.org/oas/v3.1.0#componentsResponses>`_
+section defines.
+
+Patterned Fields
+{httpStatusCode}: ``Optional[Union[Response, Reference]]``
+
+Any `HTTP status code <https://spec.openapis.org/oas/v3.1.0#httpCodes>`_ can be used as the property name, but only one
+property per code, to describe the expected response for that HTTP status code.
+
+A `Reference Object <https://spec.openapis.org/oas/v3.1.0#referenceObject>`_ can link to a response that is defined in
+the `OpenAPI Object's components/responses <https://spec.openapis.org/oas/v3.1.0#componentsResponses>`_ section. This
+field MUST be enclosed in quotation marks (for example, ``200``) for compatibility between JSON and YAML. To define a
+range of response codes, this field MAY contain the uppercase wildcard character ``X``. For example, ``2XX`` represents
+all response codes between ``[200-299]``. Only the following range definitions are allowed: ``1XX``, ``2XX``, ``3XX``,
+``4XX``, and ``5XX``. If a response is defined using an explicit code, the explicit code definition takes precedence
+over the range definition for that code.
+"""