ktor-openapi-schema/io.ktor.openapi/Tag

Tag

data class Tag(val name: String, val description: String? = null, val externalDocs: ExternalDocs? = null)(source)

Allows adding metadata to a single tag that is used by @Operation@. It is not mandatory to have a @Tag@ per tag used there.

Report a problem

Constructors

constructor(name: String, description: String? = null, externalDocs: ExternalDocs? = null)

Properties

val description: String?

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

val externalDocs: ExternalDocs?

Additional external documentation for this tag.

val name: String

The name of the tag.