Skip to main content

Interface: $Properties

options.Info.$Properties

Properties of an Info.

Hierarchy​

Properties​

contact​

• Optional contact: null | $Properties

The contact information for the exposed API.

description​

• Optional description: null | string

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

extensions​

• Optional extensions: null | { [k: string]: $Properties; }

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: null | $Properties

The license information for the exposed API.

termsOfService​

• Optional termsOfService: null | string

The Terms of Service for the API.

title​

• Optional title: null | string

The title of the application.

version​

• Optional version: null | string

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