Interface ExternalDocumentation
-
- All Superinterfaces:
Constructible
,Extensible<ExternalDocumentation>
public interface ExternalDocumentation extends Constructible, Extensible<ExternalDocumentation>
ExternalDocumentationAllows referencing an external resource for extended documentation.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default ExternalDocumentation
description(java.lang.String description)
Sets this ExternalDocumentation's description property to the given string.java.lang.String
getDescription()
Returns the description property from an ExternalDocumentation instance.java.lang.String
getUrl()
Returns the url property from an ExternalDocumentation instance.void
setDescription(java.lang.String description)
Sets this ExternalDocumentation's description property to the given string.void
setUrl(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.default ExternalDocumentation
url(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.-
Methods inherited from interface org.eclipse.microprofile.openapi.models.Extensible
addExtension, extensions, getExtensions, removeExtension, setExtensions
-
-
-
-
Method Detail
-
getDescription
java.lang.String getDescription()
Returns the description property from an ExternalDocumentation instance.- Returns:
- a short description of the target documentation
-
setDescription
void setDescription(java.lang.String description)
Sets this ExternalDocumentation's description property to the given string.- Parameters:
description
- a short description of the target documentation
-
description
default ExternalDocumentation description(java.lang.String 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
java.lang.String getUrl()
Returns the url property from an ExternalDocumentation instance.- Returns:
- the URL for the target documentation
-
setUrl
void setUrl(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.- Parameters:
url
- the URL for the target documentation
-
url
default ExternalDocumentation url(java.lang.String url)
Sets this ExternalDocumentation's url property to the given string.- Parameters:
url
- the URL for the target documentation- Returns:
- the current ExternalDocumentation instance
-
-