Class OpenApiDocument.ComponentsBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ComponentsBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ComponentsBuilder, OpenApiDocument.Components>, Supplier<OpenApiDocument.Components>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ComponentsBuilder
extends Object
implements Builder<OpenApiDocument.ComponentsBuilder, OpenApiDocument.Components>

OpenAPI components builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.Components	build()	Build the instance from this builder.
OpenApiDocument.ComponentsBuilder	callback(String name, OpenApiDocument.Callback callback)	Set callback.
OpenApiDocument.ComponentsBuilder	callback(String name, Consumer<OpenApiDocument.CallbackBuilder> callback)	Set callback.
OpenApiDocument.ComponentsBuilder	example(String name, OpenApiDocument.Example example)	Set example.
OpenApiDocument.ComponentsBuilder	example(String name, Consumer<OpenApiDocument.ExampleBuilder> example)	Set example.
OpenApiDocument.ComponentsBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.ComponentsBuilder	header(String name, OpenApiDocument.Header header)	Set header.
OpenApiDocument.ComponentsBuilder	header(String name, Consumer<OpenApiDocument.HeaderBuilder> header)	Set header.
OpenApiDocument.ComponentsBuilder	link(String name, OpenApiDocument.Link link)	Set link.
OpenApiDocument.ComponentsBuilder	link(String name, Consumer<OpenApiDocument.LinkBuilder> link)	Set link.
OpenApiDocument.ComponentsBuilder	mediaType(String name, OpenApiDocument.MediaTypeObject mediaType)	Set OpenAPI 3.2 media type.
OpenApiDocument.ComponentsBuilder	mediaType(String name, Consumer<OpenApiDocument.MediaTypeObjectBuilder> mediaType)	Set OpenAPI 3.2 media type.
OpenApiDocument.ComponentsBuilder	parameter(String name, OpenApiDocument.Parameter parameter)	Set parameter.
OpenApiDocument.ComponentsBuilder	parameter(String name, Consumer<OpenApiDocument.ParameterBuilder> parameter)	Set parameter.
OpenApiDocument.ComponentsBuilder	pathItem(String name, OpenApiDocument.PathItem pathItem)	Set path item.
OpenApiDocument.ComponentsBuilder	pathItem(String name, Consumer<OpenApiDocument.PathItemBuilder> pathItem)	Set path item.
OpenApiDocument.ComponentsBuilder	requestBody(String name, OpenApiDocument.RequestBody requestBody)	Set request body.
OpenApiDocument.ComponentsBuilder	requestBody(String name, Consumer<OpenApiDocument.RequestBodyBuilder> requestBody)	Set request body.
OpenApiDocument.ComponentsBuilder	response(String name, OpenApiDocument.Response response)	Set response.
OpenApiDocument.ComponentsBuilder	response(String name, Consumer<OpenApiDocument.ResponseBuilder> response)	Set response.
OpenApiDocument.ComponentsBuilder	schema(String name, JsonValue schema)	Set schema.
OpenApiDocument.ComponentsBuilder	securityScheme(String name, OpenApiDocument.SecurityScheme securityScheme)	Set security scheme.
OpenApiDocument.ComponentsBuilder	securityScheme(String name, Consumer<OpenApiDocument.SecuritySchemeBuilder> securityScheme)	Set security scheme.

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

Method Details

schema

public OpenApiDocument.ComponentsBuilder schema(String name,
 JsonValue schema)

Set schema.

Parameters:

name - schema name

schema - schema

Returns:

updated builder

response

public OpenApiDocument.ComponentsBuilder response(String name,
 OpenApiDocument.Response response)

Set response.

Parameters:

name - response name

response - response

Returns:

updated builder

response

public OpenApiDocument.ComponentsBuilder response(String name,
 Consumer<OpenApiDocument.ResponseBuilder> response)

Set response.

Parameters:

name - response name

response - consumer to update response builder

Returns:

updated builder

parameter

public OpenApiDocument.ComponentsBuilder parameter(String name,
 OpenApiDocument.Parameter parameter)

Set parameter.

Parameters:

name - parameter name

parameter - parameter

Returns:

updated builder

parameter

public OpenApiDocument.ComponentsBuilder parameter(String name,
 Consumer<OpenApiDocument.ParameterBuilder> parameter)

Set parameter.

Parameters:

name - parameter name

parameter - consumer to update parameter builder

Returns:

updated builder

example

public OpenApiDocument.ComponentsBuilder example(String name,
 OpenApiDocument.Example example)

Set example.

Parameters:

name - example name

example - example

Returns:

updated builder

example

public OpenApiDocument.ComponentsBuilder example(String name,
 Consumer<OpenApiDocument.ExampleBuilder> example)

Set example.

Parameters:

name - example name

example - consumer to update example builder

Returns:

updated builder

requestBody

public OpenApiDocument.ComponentsBuilder requestBody(String name,
 OpenApiDocument.RequestBody requestBody)

Set request body.

Parameters:

name - request body name

requestBody - request body

Returns:

updated builder

requestBody

public OpenApiDocument.ComponentsBuilder requestBody(String name,
 Consumer<OpenApiDocument.RequestBodyBuilder> requestBody)

Set request body.

Parameters:

name - request body name

requestBody - consumer to update request body builder

Returns:

updated builder

header

public OpenApiDocument.ComponentsBuilder header(String name,
 OpenApiDocument.Header header)

Set header.

Parameters:

name - header name

header - header

Returns:

updated builder

header

public OpenApiDocument.ComponentsBuilder header(String name,
 Consumer<OpenApiDocument.HeaderBuilder> header)

Set header.

Parameters:

name - header name

header - consumer to update header builder

Returns:

updated builder

securityScheme

public OpenApiDocument.ComponentsBuilder securityScheme(String name,
 OpenApiDocument.SecurityScheme securityScheme)

Set security scheme.

Parameters:

name - security scheme name

securityScheme - security scheme

Returns:

updated builder

securityScheme

public OpenApiDocument.ComponentsBuilder securityScheme(String name,
 Consumer<OpenApiDocument.SecuritySchemeBuilder> securityScheme)

Set security scheme.

Parameters:

name - security scheme name

securityScheme - consumer to update security scheme builder

Returns:

updated builder

link

public OpenApiDocument.ComponentsBuilder link(String name,
 OpenApiDocument.Link link)

Set link.

Parameters:

name - link name

link - link

Returns:

updated builder

link

public OpenApiDocument.ComponentsBuilder link(String name,
 Consumer<OpenApiDocument.LinkBuilder> link)

Set link.

Parameters:

name - link name

link - consumer to update link builder

Returns:

updated builder

callback

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

Set callback.

Parameters:

name - callback name

callback - callback

Returns:

updated builder

callback

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

Set callback.

Parameters:

name - callback name

callback - consumer to update callback builder

Returns:

updated builder

pathItem

public OpenApiDocument.ComponentsBuilder pathItem(String name,
 OpenApiDocument.PathItem pathItem)

Set path item.

Parameters:

name - path item name

pathItem - path item

Returns:

updated builder

pathItem

public OpenApiDocument.ComponentsBuilder pathItem(String name,
 Consumer<OpenApiDocument.PathItemBuilder> pathItem)

Set path item.

Parameters:

name - path item name

pathItem - consumer to update path item builder

Returns:

updated builder

mediaType

public OpenApiDocument.ComponentsBuilder mediaType(String name,
 OpenApiDocument.MediaTypeObject mediaType)

Set OpenAPI 3.2 media type.

Parameters:

name - media type name

mediaType - media type object

Returns:

updated builder

mediaType

public OpenApiDocument.ComponentsBuilder mediaType(String name,
 Consumer<OpenApiDocument.MediaTypeObjectBuilder> mediaType)

Set OpenAPI 3.2 media type.

Parameters:

name - media type name

mediaType - consumer to update media type object builder

Returns:

updated builder

extension

public OpenApiDocument.ComponentsBuilder 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.Components build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ComponentsBuilder, OpenApiDocument.Components>

Returns:

instance of the built type