Interface IInfo

API metadata and identification.

Contains essential information about the API including title, version, contact information, and licensing details.

interface IInfo {
    contact?: OpenApi.IDocument.IContact;
    description?: string;
    license?: OpenApi.IDocument.ILicense;
    summary?: string;
    termsOfService?: string;
    title: string;
    version: string;
}

Index

Properties

contact? description? license? summary? termsOfService? title version

Properties

`Optional`contact

contact?: OpenApi.IDocument.IContact

Contact information.

`Optional`description

description?: string

Full description.

`Optional`license

license?: OpenApi.IDocument.ILicense

License information.

`Optional`summary

summary?: string

Short summary.

`Optional`termsOfService

termsOfService?: string

Terms of service URL.

title

title: string

API title.

version

version: string

API version.