Class OpenApiDocument.ResponseBuilder

java.lang.Object

io.helidon.openapi.OpenApiDocument.ResponseBuilder

All Implemented Interfaces:

Builder<OpenApiDocument.ResponseBuilder, OpenApiDocument.Response>, Supplier<OpenApiDocument.Response>

Enclosing class:

OpenApiDocument

public static final class OpenApiDocument.ResponseBuilder
extends Object
implements Builder<OpenApiDocument.ResponseBuilder, OpenApiDocument.Response>

OpenAPI response builder.

Method Summary

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

Method Details

ref

public OpenApiDocument.ResponseBuilder ref(String ref)

Set reference.

Parameters:

ref - reference

Returns:

updated builder

summary

public OpenApiDocument.ResponseBuilder summary(String summary)

Set summary.

Parameters:

summary - summary

Returns:

updated builder

description

public OpenApiDocument.ResponseBuilder description(String description)

Set description.

OpenAPI 3.0 and 3.1 require a description for a Response Object, although the description can be empty. OpenAPI 3.2 makes the description optional.

Parameters:

description - description

Returns:

updated builder

header

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

Add header.

Parameters:

name - header name

header - header

Returns:

updated builder

header

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

Add header.

Parameters:

name - header name

header - consumer to update header builder

Returns:

updated builder

content

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

Add content entry.

Parameters:

mediaType - media type

content - media type object

Returns:

updated builder

content

public OpenApiDocument.ResponseBuilder 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

link

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

Add link.

Parameters:

name - link name

link - link

Returns:

updated builder

link

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

Add link.

Parameters:

name - link name

link - consumer to update link builder

Returns:

updated builder

extension

public OpenApiDocument.ResponseBuilder 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.Response build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.ResponseBuilder, OpenApiDocument.Response>

Returns:

instance of the built type