diff options
author | cyfraeviolae <cyfraeviolae> | 2024-04-03 03:17:55 -0400 |
---|---|---|
committer | cyfraeviolae <cyfraeviolae> | 2024-04-03 03:17:55 -0400 |
commit | 12cf076118570eebbff08c6b3090e0d4798447a1 (patch) | |
tree | 3ba25e17e3c3a5e82316558ba3864b955919ff72 /venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py | |
parent | c45662ff3923b34614ddcc8feb9195541166dcc5 (diff) |
no venv
Diffstat (limited to 'venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py')
-rw-r--r-- | venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py | 44 |
1 files changed, 0 insertions, 44 deletions
diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py deleted file mode 100644 index 6030998..0000000 --- a/venv/lib/python3.11/site-packages/litestar/openapi/spec/xml.py +++ /dev/null @@ -1,44 +0,0 @@ -from __future__ import annotations - -from dataclasses import dataclass - -from litestar.openapi.spec.base import BaseSchemaObject - -__all__ = ("XML",) - - -@dataclass() -class XML(BaseSchemaObject): - """A metadata object that allows for more fine-tuned XML model definitions. - - When using arrays, XML element names are *not* inferred (for singular/plural forms) and the ``name`` property SHOULD - be used to add that information. See examples for expected behavior. - """ - - name: str | None = None - """ - Replaces the name of the element/attribute used for the described schema property. When defined within ``items``, it - will affect the name of the individual XML elements within the list. When defined alongside ``type`` being ``array`` - (outside the ``items``), it will affect the wrapping element and only if ``wrapped`` is ``True``. If ``wrapped`` is - ``False``, it will be ignored. - """ - - namespace: str | None = None - """The URI of the namespace definition. Value MUST be in the form of an absolute URI.""" - - prefix: str | None = None - """The prefix to be used for the - `xmlName <https://spec.openapis.org/oas/v3.1.0#xmlName>`_ - """ - - attribute: bool = False - """Declares whether the property definition translates to an attribute instead of an element. Default value is - ``False``. - """ - - wrapped: bool = False - """ - MAY be used only for an array definition. Signifies whether the array is wrapped (for example, - ``<books><book/><book/></books>``) or unwrapped (``<book/><book/>``). Default value is ``False``. The definition - takes effect only when defined alongside ``type`` being ``array`` (outside the ``items``). - """ |