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.headers |
An interface of a programmable model to represent a single
header object.
|
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.parameters |
A set of model interfaces to describe operation
parameters and operation's request body.
|
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 Content |
OASFactory.createContent()
This method creates a new
Content instance. |
Modifier and Type | Method and Description |
---|---|
Content |
Header.getContent()
Returns the content property from a Header instance.
|
Modifier and Type | Method and Description |
---|---|
default Header |
Header.content(Content content)
Sets this Header's content property to the given object.
|
void |
Header.setContent(Content content)
Sets this Header's content property to the given object.
|
Modifier and Type | Method and Description |
---|---|
Content |
Content.addMediaType(String name,
MediaType mediaType)
Adds the MediaType for this Content, where the key is the name of the MediaType and the value is the object that describes the content passed
into or returned from an operation.
|
Modifier and Type | Method and Description |
---|---|
Content |
RequestBody.getContent()
Returns the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
|
Content |
Parameter.getContent()
Returns the content property from a Parameter instance.
|
Modifier and Type | Method and Description |
---|---|
default RequestBody |
RequestBody.content(Content content)
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
|
default Parameter |
Parameter.content(Content content)
Sets the content property of a Parameter instance to the given object.
|
void |
RequestBody.setContent(Content content)
Sets the content of this instance of RequestBody, where the keys in content are media type names and the values describe it.
|
void |
Parameter.setContent(Content content)
Sets the content property of a Parameter instance to the given object.
|
Modifier and Type | Method and Description |
---|---|
Content |
APIResponse.getContent()
Returns the map containing descriptions of potential response payload for this instance of ApiResponse.
|
Modifier and Type | Method and Description |
---|---|
default APIResponse |
APIResponse.content(Content content)
Sets the map containing descriptions of potential response payload for this instance of ApiResponse and returns this ApiResponse instance.
|
void |
APIResponse.setContent(Content content)
Sets the map containing descriptions of potential response payload for this instance of ApiResponse.
|
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.