Skip to main content

Interface: $Properties

Properties of an Info.

Extended by​

Properties​

contact?​

optional contact?: $Properties | null

The contact information for the exposed API.

description?​

optional description?: string | null

A short description of the application. GFM syntax can be used for rich text representation.

extensions?​

optional extensions?: {[k: string]: $Properties; } | null

Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification. See: https://swagger.io/docs/specification/2-0/swagger-extensions/

license?​

optional license?: $Properties | null

The license information for the exposed API.

termsOfService?​

optional termsOfService?: string | null

The Terms of Service for the API.

title?​

optional title?: string | null

The title of the application.

version?​

optional version?: string | null

Provides the version of the application API (not to be confused with the specification version).