tegral-openapi-dsl/guru.zoroark.tegral.openapi.dsl/TagDsl

TagDsl

interface TagDsl

DSL for the tag object.

Note that the externalDocs field is embedded in this DSL.

The name of the tag is passed as a parameter to the builder.

Inheritors

Properties

Link copied to clipboard
abstract var description: String?

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

Link copied to clipboard
abstract var externalDocsDescription: String?

Description for the external documentation for this tag.

Link copied to clipboard
abstract var externalDocsUrl: String?

The URL for the external documentation for this tag. Must be in the form of a URL.