Class OpenApiDocument.RequestBodyBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.RequestBodyBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.RequestBodyBuilder, OpenApiDocument.RequestBody>, Supplier<OpenApiDocument.RequestBody>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.RequestBodyBuilder
extends Object
implements Builder<OpenApiDocument.RequestBodyBuilder, OpenApiDocument.RequestBody>

OpenAPI request body builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument.RequestBody	build()	Build the instance from this builder.
OpenApiDocument.RequestBodyBuilder	content(String mediaType, OpenApiDocument.MediaTypeObject content)	Add content entry.
OpenApiDocument.RequestBodyBuilder	content(String mediaType, Consumer<OpenApiDocument.MediaTypeObjectBuilder> content)	Add content entry.
OpenApiDocument.RequestBodyBuilder	description(String description)	Set description.
OpenApiDocument.RequestBodyBuilder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.RequestBodyBuilder	ref(String ref)	Set reference.
OpenApiDocument.RequestBodyBuilder	required(boolean required)	Set required flag.
OpenApiDocument.RequestBodyBuilder	summary(String summary)	Set reference 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.RequestBody	get()
default OpenApiDocument.RequestBodyBuilder	identity()	Instance of this builder as the correct type.
default OpenApiDocument.RequestBodyBuilder	update(Consumer<OpenApiDocument.RequestBodyBuilder> consumer)	Update the builder in a fluent API way.

Method Details

ref

public OpenApiDocument.RequestBodyBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.RequestBodyBuilder summary(String summary)

Set reference summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.RequestBodyBuilder description(String description)

Set description.

Parameters:

description - description

Returns:

updated builder

content

public OpenApiDocument.RequestBodyBuilder content(String mediaType,
 OpenApiDocument.MediaTypeObject content)

Add content entry.

Parameters:

mediaType - media type

content - media type object

Returns:

updated builder

content

public OpenApiDocument.RequestBodyBuilder content(String mediaType,
 Consumer<OpenApiDocument.MediaTypeObjectBuilder> content)

Add content entry.

Parameters:

mediaType - media type

content - consumer to update media type object builder

Returns:

updated builder

required

public OpenApiDocument.RequestBodyBuilder required(boolean required)

Set required flag.

Parameters:

required - required flag

Returns:

updated builder

extension

public OpenApiDocument.RequestBodyBuilder 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.RequestBody build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.RequestBodyBuilder, OpenApiDocument.RequestBody>

Returns:

instance of the built type