From 6d7ba58f880be618ade07f8ea080fe8c4bf8a896 Mon Sep 17 00:00:00 2001 From: cyfraeviolae Date: Wed, 3 Apr 2024 03:10:44 -0400 Subject: venv --- .../litestar/openapi/spec/reference.py | 38 ++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py (limited to 'venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py') diff --git a/venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py b/venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py new file mode 100644 index 0000000..5ee2a95 --- /dev/null +++ b/venv/lib/python3.11/site-packages/litestar/openapi/spec/reference.py @@ -0,0 +1,38 @@ +from __future__ import annotations + +from dataclasses import dataclass + +from litestar.openapi.spec.base import BaseSchemaObject + +__all__ = ("Reference",) + + +@dataclass +class Reference(BaseSchemaObject): + """A simple object to allow referencing other components in the OpenAPI document, internally and externally. + + The ``$ref`` string value contains a URI `RFC3986 `_ , which identifies the + location of the value being referenced. + + See the rules for resolving `Relative References `_. + """ + + ref: str + """**REQUIRED**. The reference identifier. This MUST be in the form of a URI.""" + + summary: str | None = None + """A short summary which by default SHOULD override that of the referenced component. + + If the referenced object-type does not allow a ``summary`` field, then this field has no effect. + """ + + description: str | None = None + """A description which by default SHOULD override that of the referenced component. + + `CommonMark syntax `_ MAY be used for rich text representation. If the referenced + object-type does not allow a ``description`` field, then this field has no effect. + """ + + @property + def value(self) -> str: + return self.ref.split("/")[-1] -- cgit v1.2.3