Interface ExternalDocumentation
- All Superinterfaces:
Constructible
,Extensible
ExternalDocumentation
Allows referencing an external resource for extended documentation.
-
Method Summary
Modifier and TypeMethodDescriptiondescription
(String description) Sets this ExternalDocumentation's description property to the given string.Returns the description property from an ExternalDocumentation instance.getUrl()
Returns the url property from an ExternalDocumentation instance.void
setDescription
(String description) Sets this ExternalDocumentation's description property to the given string.void
Sets this ExternalDocumentation's url property to the given string.Sets this ExternalDocumentation's url property to the given string.Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, getExtensions, setExtensions
-
Method Details
-
getDescription
String getDescription()Returns the description property from an ExternalDocumentation instance.- Returns:
- a short description of the target documentation
-
setDescription
Sets this ExternalDocumentation's description property to the given string.- Parameters:
description
- a short description of the target documentation
-
description
Sets this ExternalDocumentation's description property to the given string.- Parameters:
description
- a short description of the target documentation- Returns:
- the current ExternalDocumentation instance
-
getUrl
String getUrl()Returns the url property from an ExternalDocumentation instance.- Returns:
- the URL for the target documentation
-
setUrl
Sets this ExternalDocumentation's url property to the given string.- Parameters:
url
- the URL for the target documentation
-
url
Sets this ExternalDocumentation's url property to the given string.- Parameters:
url
- the URL for the target documentation- Returns:
- the current ExternalDocumentation instance
-