Top Description Methods
org.eclipse.microprofile.openapi.models

public Interface ExternalDocumentation

extends Constructible, Extensible<ExternalDocumentation>

ExternalDocumentation

Allows referencing an external resource for extended documentation.

See Also
OpenAPI Specification External Documentation Object

Method Summary

Modifier and TypeMethod and Description
public default ExternalDocumentation

Returns:

the current ExternalDocumentation instance
description
(String
a short description of the target documentation
description
)

Sets this ExternalDocumentation's description property to the given string.

public String

Returns:

a short description of the target documentation
getDescription
()

Returns the description property from an ExternalDocumentation instance.

public String

Returns:

the URL for the target documentation
getUrl
()

Returns the url property from an ExternalDocumentation instance.

public void
setDescription(String
a short description of the target documentation
description
)

Sets this ExternalDocumentation's description property to the given string.

public void
setUrl(String
the URL for the target documentation
url
)

Sets this ExternalDocumentation's url property to the given string.

public default ExternalDocumentation

Returns:

the current ExternalDocumentation instance
url
(String
the URL for the target documentation
url
)

Sets this ExternalDocumentation's url property to the given string.

Inherited from org.eclipse.microprofile.openapi.models.Extensible:
addExtensionextensionsgetExtensionsremoveExtensionsetExtensions

Method Detail

descriptionback to summary
public default ExternalDocumentation description(String description)

Sets this ExternalDocumentation's description property to the given string.

Parameters
description:String

a short description of the target documentation

Returns:ExternalDocumentation

the current ExternalDocumentation instance

getDescriptionback to summary
public String getDescription()

Returns the description property from an ExternalDocumentation instance.

Returns:String

a short description of the target documentation

getUrlback to summary
public String getUrl()

Returns the url property from an ExternalDocumentation instance.

Returns:String

the URL for the target documentation

setDescriptionback to summary
public void setDescription(String description)

Sets this ExternalDocumentation's description property to the given string.

Parameters
description:String

a short description of the target documentation

setUrlback to summary
public void setUrl(String url)

Sets this ExternalDocumentation's url property to the given string.

Parameters
url:String

the URL for the target documentation

urlback to summary
public default ExternalDocumentation url(String url)

Sets this ExternalDocumentation's url property to the given string.

Parameters
url:String

the URL for the target documentation

Returns:ExternalDocumentation

the current ExternalDocumentation instance