Skip to main content

Info

This class provides metadata about the API, including its title, version, and contact information. It supports optional fields for a summary, detailed description, terms of service, and licensing details to ensure comprehensive documentation. The class inherits from a base model configuration to facilitate structured data validation and serialization.

Attributes

AttributeTypeDescription
titlestrThe title of the API application.
summary`strNone` = null
description`strNone` = null
termsOfService`strNone` = null
contact`ContactNone` = null
license`LicenseNone` = null
versionstrThe version of the OpenAPI document.

Constructor

Signature

def Info(
title: str,
summary: str | None = None,
description: str | None = None,
termsOfService: str | None = None,
contact: Contact | None = None,
license: License | None = None,
version: str
) - > null

Parameters

NameTypeDescription
titlestrThe title of the application.
summary`strNone` = None
description`strNone` = None
termsOfService`strNone` = None
contact`ContactNone` = None
license`LicenseNone` = None
versionstrThe version of the OpenAPI document.