Package | Description |
---|---|
org.eclipse.microprofile.openapi |
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI
v3 documents from their JAX-RS applications.
|
org.eclipse.microprofile.openapi.models |
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
|
org.eclipse.microprofile.openapi.models.media |
A set of interfaces for programmable models to represent input and output data types and media types.
|
org.eclipse.microprofile.openapi.models.tags |
Model interface to represent a tag of an API endpoint.
|
Modifier and Type | Method and Description |
---|---|
static ExternalDocumentation |
OASFactory.createExternalDocumentation()
This method creates a new
ExternalDocumentation instance. |
Modifier and Type | Method and Description |
---|---|
default ExternalDocumentation |
ExternalDocumentation.description(String description)
Sets this ExternalDocumentation's description property to the given string.
|
ExternalDocumentation |
Operation.getExternalDocs()
Returns the externalDocs property from an Operation instance.
|
ExternalDocumentation |
OpenAPI.getExternalDocs()
Returns the externalDocs property from an OpenAPI instance.
|
default ExternalDocumentation |
ExternalDocumentation.url(String url)
Sets this ExternalDocumentation's url property to the given string.
|
Modifier and Type | Method and Description |
---|---|
default Operation |
Operation.externalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.
|
default OpenAPI |
OpenAPI.externalDocs(ExternalDocumentation externalDocs)
Sets this OpenAPI instance's externalDocs property to the given object.
|
void |
Operation.setExternalDocs(ExternalDocumentation externalDocs)
Sets this Operation's externalDocs property to the given object.
|
void |
OpenAPI.setExternalDocs(ExternalDocumentation externalDocs)
Sets this OpenAPI instance's externalDocs property to the given object.
|
Modifier and Type | Method and Description |
---|---|
ExternalDocumentation |
Schema.getExternalDocs()
Returns the externalDocs property from this Schema instance.
|
Modifier and Type | Method and Description |
---|---|
default Schema |
Schema.externalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of this Schema to the indicated value.
|
void |
Schema.setExternalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of this Schema to the indicated value.
|
Modifier and Type | Method and Description |
---|---|
ExternalDocumentation |
Tag.getExternalDocs()
Returns the externalDocs property from a Tag instance.
|
Modifier and Type | Method and Description |
---|---|
default Tag |
Tag.externalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of a Tag instance to the given object.
|
void |
Tag.setExternalDocs(ExternalDocumentation externalDocs)
Sets the externalDocs property of a Tag instance to the given object.
|
Copyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.