Source code for dmr.openapi.objects.info

from dataclasses import dataclass
from typing import TYPE_CHECKING, Any

if TYPE_CHECKING:
    from dmr.openapi.objects.contact import Contact
    from dmr.openapi.objects.license import License
    from dmr.openapi.objects.reference import Reference




@dataclass(kw_only=True, slots=True)
class Info:
    """
    The Info object provides metadata about the API.

    The metadata MAY be used by the clients if needed, and MAY be presented
    in editing or documentation generation tools for convenience.

    .. versionchanged:: 0.16.0
        Added ``x_extensions`` for specification extensions.

    """

    title: str
    version: str
    summary: str | None = None
    description: 'Reference | str | None' = None
    terms_of_service: str | None = None
    contact: 'Contact | None' = None
    license: 'License | None' = None
    #: Specification extensions, keys must start with ``x-``.
    x_extensions: dict[str, Any] | None = None