InfoDsl

interface InfoDsl

DSL for the info object.

Note that the contact and license fields are directly embedded in this object.

Inheritors

Properties

Link copied to clipboard
abstract var contactEmail: String?

The email address of the contact person/organization for the exposed API. THis must be in the form of an email address.

Link copied to clipboard
abstract var contactName: String?

The identifying name of the contact person/organization for the exposed API.

Link copied to clipboard
abstract var contactUrl: String?

The URL pointing to the contact information for the exposed API. This must be in the form of a URL.

Link copied to clipboard
abstract var description: String?

A short summary of the API.

Link copied to clipboard
abstract var licenseIdentifier: String?

An SPDX license identifier for the API.

Link copied to clipboard
abstract var licenseName: String?

The license name used for the API.

Link copied to clipboard
abstract var licenseUrl: String?

A URL to the license used for the API. This must be in the form of a URL.

Link copied to clipboard
abstract var summary: String?

A short summary of the API.

Link copied to clipboard
abstract var termsOfService: String?

A URL to the Terms of Service for the API. This must be in the form of a URL.

Link copied to clipboard
abstract var title: String?

The title of the API.

Link copied to clipboard
abstract var version: String?

The version of the OpenAPI document. This is not the same as the version of the OpenAPI specification this document follows.