public interface Tag extends Constructible, Extensible<Tag>
An object to store metadata to be available in the OpenAPI document.
Modifier and Type | Method and Description |
---|---|
default Tag |
description(String description)
Sets the description property of a Tag instance to the given string.
|
default Tag |
externalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of a Tag instance to the given object.
|
String |
getDescription()
Returns the description property from a Tag instance.
|
ExternalDocumentation |
getExternalDocs()
Returns the externalDocs property from a Tag instance.
|
String |
getName()
Returns the name property from a Tag instance.
|
default Tag |
name(String name)
Sets the name property of a Tag instance to the given string.
|
void |
setDescription(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(String name)
Sets the name property of a Tag instance to the given string.
|
addExtension, extensions, getExtensions, removeExtension, setExtensions
String getName()
void setName(String name)
name
- the name property for this tagdefault Tag name(String name)
name
- the name property for this tagString getDescription()
void setDescription(String description)
description
- the description property for this tagdefault Tag description(String description)
description
- the description property for this tagExternalDocumentation getExternalDocs()
void setExternalDocs(ExternalDocumentation externalDocs)
externalDocs
- additional external documentation for this tagdefault Tag externalDocs(ExternalDocumentation externalDocs)
externalDocs
- additional external documentation for this tagCopyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.