io.muserver.openapi

Class TagObjectBuilder

java.lang.Object

io.muserver.openapi.TagObjectBuilder

public class TagObjectBuilder
extends Object

Adds metadata to a single tag that is used by the OperationObject. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.

Constructor Summary

Constructors

Constructor and Description
TagObjectBuilder()

Method Summary

Modifier and Type	Method and Description
TagObject	build()
static TagObjectBuilder	tagObject() Creates a builder for a TagObjectBuilder
TagObjectBuilder	withDescription(String description)
TagObjectBuilder	withExternalDocs(ExternalDocumentationObject externalDocs)
TagObjectBuilder	withName(String name)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TagObjectBuilder

public TagObjectBuilder()

Method Detail

withName

public TagObjectBuilder withName(String name)

Parameters:

name - REQUIRED. The name of the tag.

Returns:

The current builder

withDescription

public TagObjectBuilder withDescription(String description)

Parameters:

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

Returns:

The current builder

withExternalDocs

public TagObjectBuilder withExternalDocs(ExternalDocumentationObject externalDocs)

Parameters:

externalDocs - Additional external documentation for this tag.

Returns:

The current builder

build

public TagObject build()

tagObject

public static TagObjectBuilder tagObject()

Creates a builder for a TagObjectBuilder

Returns:

A new builder