Package | Description |
---|---|
org.eclipse.microprofile.openapi.models |
Copyright (c) 2017 Contributors to the Eclipse Foundation
|
Modifier and Type | Method and Description |
---|---|
Components |
Components.addCallback(String key,
Callback callback)
Adds the given callback to this Components' map of callbacks with the given string as its key.
|
Components |
Components.addExample(String key,
Example example)
Adds the given example to this Components' map of examples with the given string as its key.
|
Components |
Components.addHeader(String key,
Header header)
Adds the given header to this Components' map of headers with the given string as its key.
|
Components |
Components.addLink(String key,
Link link)
Adds the given link to this Components' map of links with the given string as its key.
|
Components |
Components.addParameter(String key,
Parameter parameter)
Adds the given parameter to this Components' map of parameters with the given string as its key.
|
Components |
Components.addRequestBody(String key,
RequestBody requestBody)
Adds the given request body to this Components' map of request bodies with the given string as its key.
|
Components |
Components.addResponse(String key,
APIResponse response)
Adds the given response to this Components' map of responses with the given string as its key.
|
Components |
Components.addSchema(String key,
Schema schema)
Adds the given schema to this Components' list of schemas with the given string as its key.
|
Components |
Components.addSecurityScheme(String key,
SecurityScheme securityScheme)
Adds the given security scheme to this Components' map of security schemes with the given string as its key.
|
Components |
Components.callbacks(Map<String,Callback> callbacks)
Sets this Components' callbacks property to the given Map containing keys and reusable callback objects.
|
Components |
Components.examples(Map<String,Example> examples)
Sets this Components' examples property to the given Map containing keys and reusable example objects.
|
Components |
OpenAPI.getComponents()
Returns the components property from an OpenAPI instance.
|
Components |
Components.headers(Map<String,Header> headers)
Sets this Components' headers property to the given Map containing keys and reusable header objects.
|
Components |
Components.links(Map<String,Link> links)
Sets this Components' links property to the given Map containing keys and reusable link objects.
|
Components |
Components.parameters(Map<String,Parameter> parameters)
Sets this Components' parameters property to the given Map containing keys and reusable parameter objects.
|
Components |
Components.requestBodies(Map<String,RequestBody> requestBodies)
Sets this Components' requestBodies property to the given Map containing keys and reusable request body objects.
|
Components |
Components.responses(Map<String,APIResponse> responses)
Sets this Components' responses property to the given Map containing keys and reusable response objects.
|
Components |
Components.schemas(Map<String,Schema> schemas)
Sets this Components' schemas property to the given Map containing keys and reusable schemas.
|
Components |
Components.securitySchemes(Map<String,SecurityScheme> securitySchemes)
Sets this Components' securitySchemes property to the given Map containing keys and reusable security scheme objects.
|
Modifier and Type | Method and Description |
---|---|
OpenAPI |
OpenAPI.components(Components components)
Sets this OpenAPI instance's components property to the given components.
|
void |
OpenAPI.setComponents(Components components)
Sets this OpenAPI instance's components property to the given components.
|
Copyright © 2017–2018 Eclipse MicroProfile. All rights reserved.