summaryrefslogtreecommitdiff
path: root/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py
diff options
context:
space:
mode:
Diffstat (limited to 'venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py')
-rw-r--r--venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py67
1 files changed, 0 insertions, 67 deletions
diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py
deleted file mode 100644
index 2a469c8..0000000
--- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/encoding.py
+++ /dev/null
@@ -1,67 +0,0 @@
-from __future__ import annotations
-
-from dataclasses import dataclass
-from typing import TYPE_CHECKING
-
-from litestar.openapi.spec.base import BaseSchemaObject
-
-if TYPE_CHECKING:
- from litestar.openapi.spec.header import OpenAPIHeader
- from litestar.openapi.spec.reference import Reference
-
-__all__ = ("Encoding",)
-
-
-@dataclass
-class Encoding(BaseSchemaObject):
- """A single encoding definition applied to a single schema property."""
-
- content_type: str | None = None
- """The Content-Type for encoding a specific property. Default value depends n the property type:
-
- - for ``object``: ``application/json``
- - for ``array``: the default is defined based on the inner type
- - for all other cases the default is ``application/octet-stream``.
-
- The value can be a specific media type (e.g. ``application/json``), a wildcard media type (e.g. ``image/*``), or a
- comma-separated list of the two types.
- """
-
- headers: dict[str, OpenAPIHeader | Reference] | None = None
- """A map allowing additional information to be provided as headers, for example ``Content-Disposition``.
-
- ``Content-Type`` is described separately and SHALL be ignored in this section. This property SHALL be ignored if the
- request body media type is not a ``multipart``.
- """
-
- style: str | None = None
- """Describes how a specific property value will be serialized depending on its type.
-
- See `Parameter Object <https://spec.openapis.org/oas/v3.1.0#parameterObject>`_ for details on the
- `style <https://spec.openapis.org/oas/v3.1.0#parameterStyle>`__ property. The behavior follows the same values as
- ``query`` parameters, including default values. This property SHALL be ignored if the request body media type is not
- ``application/x-www-form-urlencoded`` or ``multipart/form-data``. If a value is explicitly defined, then the value
- of `contentType <https://spec.openapis.org/oas/v3.1.0#encodingContentType>`_ (implicit or explicit) SHALL be
- ignored.
- """
-
- explode: bool = False
- """When this is true, property values of type ``array`` or ``object`` generate separate parameters for each value of
- the array, or key-value-pair of the map.
-
- For other types of properties this property has no effect. When
- `style <https://spec.openapis.org/oas/v3.1.0#encodingStyle>`_ is ``form``, the default value is ``True``. For all
- other styles, the default value is ``False``. This property SHALL be ignored if the request body media type is not
- ``application/x-www-form-urlencoded`` or ``multipart/form-data``. If a value is explicitly defined, then the value
- of `contentType <https://spec.openapis.org/oas/v3.1.0#encodingContentType>`_ (implicit or explicit) SHALL be
- ignored.
- """
-
- allow_reserved: bool = False
- """Determines whether the parameter value SHOULD allow reserved characters, as defined by :rfc:`3986`
- (``:/?#[]@!$&'()*+,;=``) to be included without percent-encoding.
-
- This property SHALL be ignored if the request body media type s not ``application/x-www-form-urlencoded`` or
- ``multipart/form-data``. If a value is explicitly defined, then the value of
- `contentType <https://spec.openapis.org/oas/v3.1.0#encodingContentType>`_ (implicit or explicit) SHALL be ignored.
- """