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.responses |
Model interfaces to describe a single response from an API operation, and an annotation to encapsulate multiple
responses from an API operation.
|
Modifier and Type | Method and Description |
---|---|
static APIResponses |
OASFactory.createAPIResponses()
This method creates a new
APIResponses instance. |
Modifier and Type | Method and Description |
---|---|
APIResponses |
Operation.getResponses()
Returns the responses property from an Operation instance.
|
Modifier and Type | Method and Description |
---|---|
default Operation |
Operation.responses(APIResponses responses)
Sets this Operation's responses property to the given responses.
|
void |
Operation.setResponses(APIResponses responses)
Sets this Operation's responses property to the given responses.
|
Modifier and Type | Method and Description |
---|---|
APIResponses |
APIResponses.addAPIResponse(String name,
APIResponse apiResponse)
Adds an APIResponse in the format of the name as a key and the item as the value to APIResponses map
|
default APIResponses |
APIResponses.defaultValue(APIResponse defaultValue)
Sets the default documentation of responses for this instance of ApiResponses and return this instance of
ApiResponses.
|
Copyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.