ktor-openapi-schema/io.ktor.openapi/OpenApiInfo

OpenApiInfo

@Serializable(with = OpenApiInfo.Companion.Serializer::class)

data class OpenApiInfo(val title: String, val version: String, val description: String? = null, val termsOfService: String? = null, val contact: OpenApiInfo.Contact? = Contact(), val license: OpenApiInfo.License? = null, val extensions: ExtensionProperties? = null) : Extensible(source)

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.

Report a problem

Constructors

constructor(title: String, version: String, description: String? = null, termsOfService: String? = null, contact: OpenApiInfo.Contact? = Contact(), license: OpenApiInfo.License? = null, extensions: ExtensionProperties? = null)

Types

object Companion

data class Contact(val name: String? = null, val url: String? = null, val email: String? = null)

Contact information for the exposed API.

data class License(val name: String, val url: String? = null, val identifier: String? = null)

License information for the exposed API.

Properties

val contact: OpenApiInfo.Contact?

The contact information for the exposed API.

val description: String?

A short description of the API. CommonMark syntax MAY be used for rich text representation.

open override val extensions: ExtensionProperties?

Any additional external documentation for this OpenAPI document.

val license: OpenApiInfo.License?

The license information for the exposed API.

val termsOfService: String?

A URL to the Terms of Service for the API. MUST be in the format of a URL.

val title: String

The title of the API.

val version: String

The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).