public interface Tag extends Constructible, Extensible
An object to store metadata to be available in the OpenAPI document.
Modifier and Type | Method and Description |
---|---|
Tag |
description(java.lang.String description)
Sets the description property of a Tag instance to the given string.
|
Tag |
externalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of a Tag instance to the given object.
|
java.lang.String |
getDescription()
Returns the description property from a Tag instance.
|
ExternalDocumentation |
getExternalDocs()
Returns the externalDocs property from a Tag instance.
|
java.lang.String |
getName()
Returns the name property from a Tag instance.
|
Tag |
name(java.lang.String name)
Sets the name property of a Tag instance to the given string.
|
void |
setDescription(java.lang.String description)
Sets the description property of a Tag instance to the given string.
|
void |
setExternalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of a Tag instance to the given object.
|
void |
setName(java.lang.String name)
Sets the name property of a Tag instance to the given string.
|
addExtension, getExtensions, setExtensions
java.lang.String getName()
void setName(java.lang.String name)
name
- the name property for this tagTag name(java.lang.String name)
name
- the name property for this tagjava.lang.String getDescription()
void setDescription(java.lang.String description)
description
- the description property for this tagTag description(java.lang.String description)
description
- the description property for this tagExternalDocumentation getExternalDocs()
void setExternalDocs(ExternalDocumentation externalDocs)
externalDocs
- additional external documentation for this tagTag externalDocs(ExternalDocumentation externalDocs)
externalDocs
- additional external documentation for this tag