Class OpenApiDocument.PathItemBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.PathItemBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.PathItemBuilder, OpenApiDocument.PathItem>, Supplier<OpenApiDocument.PathItem>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.PathItemBuilder
extends Object
implements Builder<OpenApiDocument.PathItemBuilder, OpenApiDocument.PathItem>

OpenAPI path item builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.PathItemBuilder	additionalOperation(String method, OpenApiDocument.Operation operation)	Add an OpenAPI 3.2 additional operation.
OpenApiDocument.PathItemBuilder	additionalOperation(String method, Consumer<OpenApiDocument.OperationBuilder> operation)	Add an OpenAPI 3.2 additional operation.
OpenApiDocument.PathItem	build()	Build the instance from this builder.
OpenApiDocument.PathItemBuilder	description(String description)	Set description.
OpenApiDocument.PathItemBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.PathItemBuilder	operation(String method, OpenApiDocument.Operation operation)	Add an HTTP operation.
OpenApiDocument.PathItemBuilder	operation(String method, Consumer<OpenApiDocument.OperationBuilder> operation)	Add an HTTP operation.
OpenApiDocument.PathItemBuilder	parameter(OpenApiDocument.Parameter parameter)	Add common parameter.
OpenApiDocument.PathItemBuilder	parameter(Consumer<OpenApiDocument.ParameterBuilder> parameter)	Add common parameter.
OpenApiDocument.PathItemBuilder	query(OpenApiDocument.Operation operation)	Set the OpenAPI 3.2 query operation.
OpenApiDocument.PathItemBuilder	query(Consumer<OpenApiDocument.OperationBuilder> operation)	Set the OpenAPI 3.2 query operation.
OpenApiDocument.PathItemBuilder	ref(String ref)	Set reference.
OpenApiDocument.PathItemBuilder	server(OpenApiDocument.Server server)	Add server.
OpenApiDocument.PathItemBuilder	server(Consumer<OpenApiDocument.ServerBuilder> server)	Add server.
OpenApiDocument.PathItemBuilder	summary(String summary)	Set summary.

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.PathItem	get()
default OpenApiDocument.PathItemBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.PathItemBuilder	update(Consumer<OpenApiDocument.PathItemBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.PathItemBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.PathItemBuilder summary(String summary)

Set summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.PathItemBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

operation

public OpenApiDocument.PathItemBuilder operation(String method,
 OpenApiDocument.Operation operation)

Add an HTTP operation.

Method names are case-sensitive. Standard uppercase HTTP method tokens use the corresponding lowercase fixed field; other spellings are preserved in additionalOperations.

Parameters:

method - HTTP method

operation - operation

Returns:

updated builder

Throws:

IllegalArgumentException - if the method is not a non-empty ASCII RFC tchar token

operation

public OpenApiDocument.PathItemBuilder operation(String method,
 Consumer<OpenApiDocument.OperationBuilder> operation)

Add an HTTP operation.

Method names are case-sensitive. Standard uppercase HTTP method tokens use the corresponding lowercase fixed field; other spellings are preserved in additionalOperations.

Parameters:

method - HTTP method

operation - consumer to update operation builder

Returns:

updated builder

Throws:

IllegalArgumentException - if the method is not a non-empty ASCII RFC tchar token

query

public OpenApiDocument.PathItemBuilder query(OpenApiDocument.Operation operation)

Set the OpenAPI 3.2 query operation.

Parameters:

operation - query operation

Returns:

updated builder

query

public OpenApiDocument.PathItemBuilder query(Consumer<OpenApiDocument.OperationBuilder> operation)

Set the OpenAPI 3.2 query operation.

Parameters:

operation - consumer to update operation builder

Returns:

updated builder

additionalOperation

public OpenApiDocument.PathItemBuilder additionalOperation(String method,
 OpenApiDocument.Operation operation)

Add an OpenAPI 3.2 additional operation.

Method names are case-sensitive and preserved as supplied.

Parameters:

method - method name

operation - operation

Returns:

updated builder

Throws:

IllegalArgumentException - if the method is not a non-empty ASCII RFC tchar token, or if it is an uppercase HTTP method represented by a fixed field

IllegalStateException - if the method is already defined

additionalOperation

public OpenApiDocument.PathItemBuilder additionalOperation(String method,
 Consumer<OpenApiDocument.OperationBuilder> operation)

Add an OpenAPI 3.2 additional operation.

Method names are case-sensitive and preserved as supplied.

Parameters:

method - method name

operation - consumer to update operation builder

Returns:

updated builder

Throws:

IllegalArgumentException - if the method is not a non-empty ASCII RFC tchar token, or if it is an uppercase HTTP method represented by a fixed field

IllegalStateException - if the method is already defined

server

public OpenApiDocument.PathItemBuilder server(OpenApiDocument.Server server)

Add server.

Parameters:

server - server

Returns:

updated builder

server

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

Add server.

Parameters:

server - consumer to update server builder

Returns:

updated builder

parameter

public OpenApiDocument.PathItemBuilder parameter(OpenApiDocument.Parameter parameter)

Add common parameter.

Parameters:

parameter - parameter

Returns:

updated builder

parameter

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

Add common parameter.

Parameters:

parameter - consumer to update parameter builder

Returns:

updated builder

extension

public OpenApiDocument.PathItemBuilder 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.PathItem build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.PathItemBuilder, OpenApiDocument.PathItem>

Returns:

instance of the built type