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.servers |
Model interfaces to represent servers used for a single API operation
or for all operations in an OpenAPI document, as well as a way to represent
variables for server URL template substitution.
|
Modifier and Type | Method and Description |
---|---|
static ServerVariable |
OASFactory.createServerVariable()
This method creates a new
ServerVariable instance. |
Modifier and Type | Method and Description |
---|---|
ServerVariable |
ServerVariable.addEnumeration(String enumeration)
This method adds a string item to enumeration list of a ServerVariable instance and returns the instance.
|
default ServerVariable |
ServerVariable.defaultValue(String defaultValue)
The default value to use for substitution, and to send, if an alternate value is not supplied.
|
default ServerVariable |
ServerVariable.description(String description)
This method sets the description property of ServerVariable instance to the given description argument and returns the modeified instance.
|
default ServerVariable |
ServerVariable.enumeration(List<String> enumeration)
This method sets the enumeration property of ServerVariable instance to the given enumeration argument and returns the modified instance.
|
ServerVariable |
ServerVariables.get(Object key)
Deprecated.
since 1.1
|
default ServerVariable |
ServerVariables.getServerVariable(String name)
Deprecated.
Returns a server variable for a given name.
|
ServerVariable |
ServerVariables.put(String key,
ServerVariable value)
Deprecated.
since 1.1
|
ServerVariable |
ServerVariables.remove(Object key)
Deprecated.
since 1.1
|
Modifier and Type | Method and Description |
---|---|
Map<String,ServerVariable> |
ServerVariables.getServerVariables()
Deprecated.
Returns a copy map (potentially immutable) of the server variables.
|
Modifier and Type | Method and Description |
---|---|
ServerVariables |
ServerVariables.addServerVariable(String name,
ServerVariable serverVariable)
Deprecated.
This method adds a key-value item to a ServerVariables instance from the name-item parameter pair and returns the modified instance.
|
ServerVariable |
ServerVariables.put(String key,
ServerVariable value)
Deprecated.
since 1.1
|
Modifier and Type | Method and Description |
---|---|
void |
ServerVariables.putAll(Map<? extends String,? extends ServerVariable> m)
Deprecated.
since 1.1
|
void |
ServerVariables.setServerVariables(Map<String,ServerVariable> items)
Deprecated.
Set the server variables map to this ServerVariables object.
|
void |
Server.setVariables(Map<String,ServerVariable> variables)
This method sets the variables property of Server instance to the given variables argument.
|
default Server |
Server.variables(Map<String,ServerVariable> variables)
This method sets the variables property of Server instance to the given variables argument and returns the modified instance.
|
Copyright © 2017 – 2021 Eclipse Foundation. All rights reserved.
Use is subject to license terms.