Package | Description |
---|---|
org.eclipse.microprofile.openapi |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
org.eclipse.microprofile.openapi.models |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
org.eclipse.microprofile.openapi.models.parameters |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
Modifier and Type | Method and Description |
---|---|
default Parameter |
OASFilter.filterParameter(Parameter parameter)
Allows filtering of a particular Parameter.
|
Modifier and Type | Method and Description |
---|---|
default Parameter |
OASFilter.filterParameter(Parameter parameter)
Allows filtering of a particular Parameter.
|
Modifier and Type | Method and Description |
---|---|
List<Parameter> |
PathItem.getParameters()
Returns the parameters property from this PathItem instance.
|
List<Parameter> |
Operation.getParameters()
Returns the parameters property from an Operation instance.
|
Map<String,Parameter> |
Components.getParameters()
Returns the parameters property from a Components instance.
|
Modifier and Type | Method and Description |
---|---|
PathItem |
PathItem.addParameter(Parameter parameter)
Adds the given parameter to this PathItem's list of parameters.
|
Operation |
Operation.addParameter(Parameter parameter)
Adds the given parameter item to this Operation's list of parameters.
|
Components |
Components.addParameter(String key,
Parameter parameter)
Adds the given parameter to this Components' map of parameters with the given string as its key.
|
Modifier and Type | Method and Description |
---|---|
PathItem |
PathItem.parameters(List<Parameter> parameters)
Sets this PathItem's parameters property to the given list.
|
Operation |
Operation.parameters(List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.
|
Components |
Components.parameters(Map<String,Parameter> parameters)
Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
|
void |
PathItem.setParameters(List<Parameter> parameters)
Sets this PathItem's parameters property to the given list.
|
void |
Operation.setParameters(List<Parameter> parameters)
Sets this Operation's parameters property to the given parameter list.
|
void |
Components.setParameters(Map<String,Parameter> parameters)
Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
|
Modifier and Type | Method and Description |
---|---|
Parameter |
Parameter.addExample(String key,
Example example)
Adds an example of the media type using the specified key.
|
Parameter |
Parameter.allowEmptyValue(Boolean allowEmptyValue)
Sets the allowEmptyValue property of a Parameter instance to the given value.
|
Parameter |
Parameter.allowReserved(Boolean allowReserved)
Sets the allowReserved property of a Parameter instance to the given value.
|
Parameter |
Parameter.content(Content content)
Sets the content property of a Parameter instance to the given object.
|
Parameter |
Parameter.deprecated(Boolean deprecated)
Sets the deprecated property of a Parameter instance to the given value.
|
Parameter |
Parameter.description(String description)
Sets the description property of a Parameter instance to the given string.
|
Parameter |
Parameter.example(Object example)
Sets the example property of a Parameter instance to the given object.
|
Parameter |
Parameter.examples(Map<String,Example> examples)
Sets the examples property of a Parameter instance to the given value.
|
Parameter |
Parameter.explode(Boolean explode)
Sets the explode property of a Parameter instance to the given value.
|
Parameter |
Parameter.in(Parameter.In in)
Sets the in property of a Parameter instance to the given value.
|
Parameter |
Parameter.name(String name)
Sets the name property of a Parameter instance to the given string.
|
Parameter |
Parameter.required(Boolean required)
Sets the required property of a Parameter instance to the given value.
|
Parameter |
Parameter.schema(Schema schema)
Sets the schema property of a Parameter instance to the given value.
|
Parameter |
Parameter.style(Parameter.Style style)
Sets the style property of a Parameter instance to the given value.
|
Copyright © 2017–2018 Eclipse MicroProfile. All rights reserved.