Interface IInfo

Information about the API.

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

The contact information for the exposed API.

`Optional`description

description?: string

A full description of the API.

`Optional`license

license?: OpenApi.IDocument.ILicense

The license information for the exposed API.

`Optional`summary

summary?: string

A short summary of the API.

`Optional`termsOfService

termsOfService?: string

A URL to the Terms of Service for the API.

title

title: string

The title of the API.

version

version: string

Version of the API.