Skip to content

ExternalDocs

faststream.specification.asyncapi.v2_6_0.schema.docs.ExternalDocs #

Bases: BaseModel

A class to represent external documentation.

url instance-attribute #

url: AnyHttpUrl

description class-attribute instance-attribute #

description: str | None = None

model_config class-attribute instance-attribute #

model_config = {'extra': 'allow'}

Config #

extra class-attribute instance-attribute #

extra = 'allow'

from_spec classmethod #

from_spec(docs: None) -> None

from_spec(docs: ExternalDocs) -> Self

from_spec(docs: ExternalDocsDict) -> Self

from_spec(docs: dict[str, Any]) -> dict[str, Any]

from_spec(
    docs: ExternalDocs
    | ExternalDocsDict
    | dict[str, Any]
    | None,
) -> Self | dict[str, Any] | None
Source code in faststream/specification/asyncapi/v2_6_0/schema/docs.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
@classmethod
def from_spec(
    cls,
    docs: SpecDocs | ExternalDocsDict | dict[str, Any] | None,
) -> Self | dict[str, Any] | None:
    if docs is None:
        return None

    if isinstance(docs, SpecDocs):
        return cls(url=docs.url, description=docs.description)

    docs = cast("dict[str, Any]", docs)
    docs_data, custom_data = filter_by_dict(ExternalDocsDict, docs)

    if custom_data:
        return docs

    return cls(**docs_data)