Package io.muserver.openapi
Class TagObjectBuilder
- java.lang.Object
-
- io.muserver.openapi.TagObjectBuilder
-
public class TagObjectBuilder extends java.lang.Object
Adds metadata to a single tag that is used by theOperationObject
. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances.
-
-
Constructor Summary
Constructors Constructor Description TagObjectBuilder()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description TagObject
build()
static TagObjectBuilder
tagObject()
Creates a builder for aTagObjectBuilder
TagObjectBuilder
withDescription(java.lang.String description)
TagObjectBuilder
withExternalDocs(ExternalDocumentationObject externalDocs)
TagObjectBuilder
withName(java.lang.String name)
-
-
-
Method Detail
-
withName
public TagObjectBuilder withName(java.lang.String name)
- Parameters:
name
- REQUIRED. The name of the tag.- Returns:
- The current builder
-
withDescription
public TagObjectBuilder withDescription(java.lang.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()
- Returns:
- A new object
-
tagObject
public static TagObjectBuilder tagObject()
Creates a builder for aTagObjectBuilder
- Returns:
- A new builder
-
-