Class OpenApiDocument.OperationBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.OperationBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.OperationBuilder, OpenApiDocument.Operation>, Supplier<OpenApiDocument.Operation>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.OperationBuilder
extends Object
implements Builder<OpenApiDocument.OperationBuilder, OpenApiDocument.Operation>

OpenAPI operation builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Operation	build()	Build the instance from this builder.
OpenApiDocument.OperationBuilder	callback(String name, OpenApiDocument.Callback callback)	Add callback.
OpenApiDocument.OperationBuilder	callback(String name, Consumer<OpenApiDocument.CallbackBuilder> callback)	Add callback.
OpenApiDocument.OperationBuilder	deprecated(boolean deprecated)	Set deprecated flag.
OpenApiDocument.OperationBuilder	description(String description)	Set description.
OpenApiDocument.OperationBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.OperationBuilder	externalDocs(OpenApiDocument.ExternalDocs externalDocs)	Set external documentation.
OpenApiDocument.OperationBuilder	externalDocs(Consumer<OpenApiDocument.ExternalDocsBuilder> externalDocs)	Set external documentation.
OpenApiDocument.OperationBuilder	operationId(String operationId)	Set operation id.
OpenApiDocument.OperationBuilder	parameter(OpenApiDocument.Parameter parameter)	Add parameter.
OpenApiDocument.OperationBuilder	parameter(Consumer<OpenApiDocument.ParameterBuilder> parameter)	Add parameter.
OpenApiDocument.OperationBuilder	requestBody(OpenApiDocument.RequestBody requestBody)	Set request body.
OpenApiDocument.OperationBuilder	requestBody(Consumer<OpenApiDocument.RequestBodyBuilder> requestBody)	Set request body.
OpenApiDocument.OperationBuilder	response(String status, OpenApiDocument.Response response)	Add a response.
OpenApiDocument.OperationBuilder	response(String status, String description)	Add a response.
OpenApiDocument.OperationBuilder	response(String status, Consumer<OpenApiDocument.ResponseBuilder> response)	Add a response.
OpenApiDocument.OperationBuilder	responseExtension(String name, JsonValue value)	Add an extension to the responses object.
OpenApiDocument.OperationBuilder	security(List<OpenApiDocument.SecurityRequirement> requirements)	Set security requirements.
OpenApiDocument.OperationBuilder	securityRequirement(OpenApiDocument.SecurityRequirement requirement)	Add security requirement.
OpenApiDocument.OperationBuilder	securityRequirement(Consumer<OpenApiDocument.SecurityRequirementBuilder> requirement)	Add security requirement.
OpenApiDocument.OperationBuilder	server(OpenApiDocument.Server server)	Add server.
OpenApiDocument.OperationBuilder	server(Consumer<OpenApiDocument.ServerBuilder> server)	Add server.
OpenApiDocument.OperationBuilder	summary(String summary)	Set summary.
OpenApiDocument.OperationBuilder	tag(String tag)	Add an operation tag.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Builder

get, identity, update

Modifier and Type	Method	Description
default OpenApiDocument.Operation	get()
default OpenApiDocument.OperationBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.OperationBuilder	update(Consumer<OpenApiDocument.OperationBuilder> consumer)	Update the builder in a fluent API way.

Method Details

tag

public OpenApiDocument.OperationBuilder tag(String tag)

Add an operation tag.

Parameters:

tag - tag name

Returns:

updated builder

summary

public OpenApiDocument.OperationBuilder summary(String summary)

Set summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.OperationBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

externalDocs

public OpenApiDocument.OperationBuilder externalDocs(OpenApiDocument.ExternalDocs externalDocs)

Set external documentation.

Parameters:

externalDocs - external documentation

Returns:

updated builder

externalDocs

public OpenApiDocument.OperationBuilder externalDocs(Consumer<OpenApiDocument.ExternalDocsBuilder> externalDocs)

Set external documentation.

Parameters:

externalDocs - consumer to update external documentation builder

Returns:

updated builder

operationId

public OpenApiDocument.OperationBuilder operationId(String operationId)

Set operation id.

Parameters:

operationId - operation id

Returns:

updated builder

parameter

public OpenApiDocument.OperationBuilder parameter(OpenApiDocument.Parameter parameter)

Add parameter.

Parameters:

parameter - parameter

Returns:

updated builder

parameter

public OpenApiDocument.OperationBuilder parameter(Consumer<OpenApiDocument.ParameterBuilder> parameter)

Add parameter.

Parameters:

parameter - consumer to update parameter builder

Returns:

updated builder

requestBody

public OpenApiDocument.OperationBuilder requestBody(OpenApiDocument.RequestBody requestBody)

Set request body.

Parameters:

requestBody - request body

Returns:

updated builder

requestBody

public OpenApiDocument.OperationBuilder requestBody(Consumer<OpenApiDocument.RequestBodyBuilder> requestBody)

Set request body.

Parameters:

requestBody - consumer to update request body builder

Returns:

updated builder

response

public OpenApiDocument.OperationBuilder response(String status,
 String description)

Add a response.

OpenAPI 3.0 and 3.1 require each operation to have at least one response. OpenAPI 3.2 permits an operation to omit responses.

Parameters:

status - status code, status-code range, or default

description - response description

Returns:

updated builder

response

public OpenApiDocument.OperationBuilder response(String status,
 OpenApiDocument.Response response)

Add a response.

OpenAPI 3.0 and 3.1 require each operation to have at least one response. OpenAPI 3.2 permits an operation to omit responses.

Parameters:

status - status code, status-code range, or default

response - response

Returns:

updated builder

response

public OpenApiDocument.OperationBuilder response(String status,
 Consumer<OpenApiDocument.ResponseBuilder> response)

Add a response.

OpenAPI 3.0 and 3.1 require each operation to have at least one response. OpenAPI 3.2 permits an operation to omit responses.

Parameters:

status - status code, status-code range, or default

response - consumer to update response builder

Returns:

updated builder

responseExtension

public OpenApiDocument.OperationBuilder responseExtension(String name,
 JsonValue value)

Add an extension to the responses object.

Extension names must start with x-. An extension alone does not satisfy the requirement that a present Responses Object contain at least one response.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

callback

public OpenApiDocument.OperationBuilder callback(String name,
 OpenApiDocument.Callback callback)

Add callback.

Parameters:

name - callback name

callback - callback

Returns:

updated builder

callback

public OpenApiDocument.OperationBuilder callback(String name,
 Consumer<OpenApiDocument.CallbackBuilder> callback)

Add callback.

Parameters:

name - callback name

callback - consumer to update callback builder

Returns:

updated builder

deprecated

public OpenApiDocument.OperationBuilder deprecated(boolean deprecated)

Set deprecated flag.

Parameters:

deprecated - deprecated flag

Returns:

updated builder

securityRequirement

public OpenApiDocument.OperationBuilder securityRequirement(OpenApiDocument.SecurityRequirement requirement)

Add security requirement.

Parameters:

requirement - security requirement

Returns:

updated builder

securityRequirement

public OpenApiDocument.OperationBuilder securityRequirement(Consumer<OpenApiDocument.SecurityRequirementBuilder> requirement)

Add security requirement.

Parameters:

requirement - consumer to update security requirement builder

Returns:

updated builder

security

public OpenApiDocument.OperationBuilder security(List<OpenApiDocument.SecurityRequirement> requirements)

Set security requirements.

An empty list declares that this operation overrides document-level security requirements with no security.

Parameters:

requirements - security requirements

Returns:

updated builder

server

public OpenApiDocument.OperationBuilder server(OpenApiDocument.Server server)

Add server.

Parameters:

server - server

Returns:

updated builder

server

public OpenApiDocument.OperationBuilder server(Consumer<OpenApiDocument.ServerBuilder> server)

Add server.

Parameters:

server - consumer to update server builder

Returns:

updated builder

extension

public OpenApiDocument.OperationBuilder extension(String name,
 JsonValue value)

Add an extension.

Extension names must start with x-.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

build

public OpenApiDocument.Operation build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.OperationBuilder, OpenApiDocument.Operation>

Returns:

instance of the built type