Info

class Info(d: dict[str, Any] = None, title: str = None, summary: str = None, description: str = None, termsOfService: str = None, contact: Contact = None, license: License = None, version: str = None)

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.

property title: str

REQUIRED. The title of the API.

property summary: str | None

A short summary of the API.

property description: str | None

A description of the API. CommonMark syntax MAY be used for rich text representation.

property termsOfService: str | None

A URI for the Terms of Service for the API. This MUST be in the form of a URI.

property contact: Contact | None

The contact information for the exposed API.

property license: License | None

The license information for the exposed API.

property version: str

REQUIRED. The version of the OpenAPI Document (which is distinct from the OpenAPI Specification version or the version of the API being described or the version of the OpenAPI Description).