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

TagBuilder

class TagBuilder(name: String) : TagDsl, Builder<Tag>

Actual builder for TagDsl.

Parameters

name

The name of the tag. This is the same value that is put in the tags property of operations.

Constructors

fun TagBuilder(name: String)

Functions

open override fun build(): Tag

Build the object.

Properties

open override var description: String? = null

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

externalDocsDescription

open override var externalDocsDescription: String? = null

Description for the external documentation for this tag.

externalDocsUrl

open override var externalDocsUrl: String? = null

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