Interface Tag
- All Superinterfaces:
Constructible
,Extensible<Tag>
Tag
An object to store metadata to be available in the OpenAPI document.
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiondefault 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.Returns the description property from a Tag instance.Returns the externalDocs property from a Tag instance.getName()
Returns the name property from a Tag instance.default Tag
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
Sets the name property of a Tag instance to the given string.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
Method Details
-
getName
String getName()Returns the name property from a Tag instance.- Returns:
- the name property from this tag
-
setName
Sets the name property of a Tag instance to the given string.- Parameters:
name
- the name property for this tag
-
name
Sets the name property of a Tag instance to the given string.- Parameters:
name
- the name property for this tag- Returns:
- the current Tag instance
-
getDescription
String getDescription()Returns the description property from a Tag instance.- Returns:
- the description property from this tag
-
setDescription
Sets the description property of a Tag instance to the given string.- Parameters:
description
- the description property for this tag
-
description
Sets the description property of a Tag instance to the given string.- Parameters:
description
- the description property for this tag- Returns:
- the current Tag instance
-
getExternalDocs
ExternalDocumentation getExternalDocs()Returns the externalDocs property from a Tag instance.- Returns:
- additional external documentation from this tag
-
setExternalDocs
Sets the externalDocs property of a Tag instance to the given object.- Parameters:
externalDocs
- additional external documentation for this tag
-
externalDocs
Sets the externalDocs property of a Tag instance to the given object.- Parameters:
externalDocs
- additional external documentation for this tag- Returns:
- the current Tag instance
-