ExternalDocumentation (Eclipse MicroProfile 2.0)

All Superinterfaces:

Constructible, Extensible
```
public interface ExternalDocumentation
extends Constructible, Extensible
```
ExternalDocumentation
Allows referencing an external resource for extended documentation.

See Also:

OpenAPI Specification External Documentation Object

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`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.
`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, getExtensions, 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
```
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
```
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