InfoBuilder

class InfoBuilder : Builder<Info> , Buildable<Info> , InfoDsl

Builder object for the info object.

Constructors

Link copied to clipboard
constructor()

Functions

Link copied to clipboard
open override fun build(): Info

Build the object.

Properties

Link copied to clipboard
open override 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
open override var contactName: String?

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

Link copied to clipboard
open override 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
open override var description: String?

A short summary of the API.

Link copied to clipboard
open override var licenseIdentifier: String?

An SPDX license identifier for the API.

Link copied to clipboard
open override var licenseName: String?

The license name used for the API.

Link copied to clipboard
open override 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
open override var summary: String?

A short summary of the API.

Link copied to clipboard
open override 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
open override var title: String?

The title of the API.

Link copied to clipboard
open override var version: String?

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