Class OpenApiDocument.Builder

java.lang.Object

io.helidon.openapi.OpenApiDocument.Builder

All Implemented Interfaces:

Builder<OpenApiDocument.Builder, OpenApiDocument>, Supplier<OpenApiDocument>

Enclosing class:

OpenApiDocument

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

OpenAPI document builder.

Method Summary

Modifier and Type	Method	Description
OpenApiDocument	build()	Build the instance from this builder.
OpenApiDocument.Builder	components(OpenApiDocument.Components components)	Add or merge components.
OpenApiDocument.Builder	components(Consumer<OpenApiDocument.ComponentsBuilder> components)	Add or merge components.
OpenApiDocument.Builder	extension(String name, JsonValue value)	Add an extension.
OpenApiDocument.Builder	externalDocs(OpenApiDocument.ExternalDocs externalDocs)	Set external documentation.
OpenApiDocument.Builder	externalDocs(Consumer<OpenApiDocument.ExternalDocsBuilder> externalDocs)	Set external documentation.
OpenApiDocument.Builder	info(OpenApiDocument.Info info)	Set the Info object.
OpenApiDocument.Builder	info(String title, String version)	Set the required Info object values.
OpenApiDocument.Builder	info(Consumer<OpenApiDocument.InfoBuilder> info)	Set the Info object.
OpenApiDocument.Builder	jsonSchemaDialect(String jsonSchemaDialect)	Set the JSON Schema dialect URI.
OpenApiDocument.Builder	merge(OpenApiDocument document)	Merge another OpenAPI document into this builder.
OpenApiDocument.Builder	openapi(String openapi)	Set the OpenAPI version string.
OpenApiDocument.Builder	path(String path, OpenApiDocument.PathItem pathItem)	Add or merge a path item.
OpenApiDocument.Builder	path(String path, Consumer<OpenApiDocument.PathItemBuilder> pathItem)	Add or merge a path item.
OpenApiDocument.Builder	pathExtension(String name, JsonValue value)	Add an extension to the paths object.
OpenApiDocument.Builder	paths(Map<String, OpenApiDocument.PathItem> paths)	Add or merge path items.
OpenApiDocument.Builder	securityRequirement(OpenApiDocument.SecurityRequirement requirement)	Add a security requirement.
OpenApiDocument.Builder	securityRequirement(String name, List<String> scopes)	Add a security requirement.
OpenApiDocument.Builder	securityRequirement(Consumer<OpenApiDocument.SecurityRequirementBuilder> requirement)	Add a security requirement.
OpenApiDocument.Builder	self(String self)	Set the OpenAPI 3.2 document identity URI.
OpenApiDocument.Builder	server(OpenApiDocument.Server server)	Add a server.
OpenApiDocument.Builder	server(Consumer<OpenApiDocument.ServerBuilder> server)	Add a server.
OpenApiDocument.Builder	tag(OpenApiDocument.Tag tag)	Add a document tag.
OpenApiDocument.Builder	tag(String name, String description)	Add a document tag.
OpenApiDocument.Builder	tag(Consumer<OpenApiDocument.TagBuilder> tag)	Add a document tag.
OpenApiDocument.Builder	webhook(String name, OpenApiDocument.PathItem pathItem)	Add or merge a webhook path item.
OpenApiDocument.Builder	webhook(String name, Consumer<OpenApiDocument.PathItemBuilder> pathItem)	Add or merge a webhook path item.
OpenApiDocument.Builder	webhooks(Map<String, OpenApiDocument.PathItem> webhooks)	Add or merge webhook path items.

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

Method Details

openapi

public OpenApiDocument.Builder openapi(String openapi)

Set the OpenAPI version string.

Parameters:

openapi - OpenAPI version

Returns:

updated builder

self

public OpenApiDocument.Builder self(String self)

Set the OpenAPI 3.2 document identity URI.

A relative identity is resolved against the configured OpenAPI web context. When the identity is relative, Helidon cannot determine whether an absolute reference identifies this document because composition does not have the request scheme or authority. That combination is not supported; use an absolute document identity or relative references instead.

Parameters:

self - document identity URI

Returns:

updated builder

jsonSchemaDialect

public OpenApiDocument.Builder jsonSchemaDialect(String jsonSchemaDialect)

Set the JSON Schema dialect URI.

Parameters:

jsonSchemaDialect - JSON Schema dialect URI

Returns:

updated builder

info

public OpenApiDocument.Builder info(String title,
 String version)

Set the required Info object values.

Parameters:

title - API title

version - API version

Returns:

updated builder

info

public OpenApiDocument.Builder info(OpenApiDocument.Info info)

Set the Info object.

Parameters:

info - info

Returns:

updated builder

info

public OpenApiDocument.Builder info(Consumer<OpenApiDocument.InfoBuilder> info)

Set the Info object.

Parameters:

info - consumer to update info builder

Returns:

updated builder

server

public OpenApiDocument.Builder server(OpenApiDocument.Server server)

Add a server.

Parameters:

server - server model

Returns:

updated builder

server

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

Add a server.

Parameters:

server - consumer to update server builder

Returns:

updated builder

paths

public OpenApiDocument.Builder paths(Map<String, OpenApiDocument.PathItem> paths)

Add or merge path items.

An empty map adds an empty Paths Object.

Parameters:

paths - path items keyed by OpenAPI path

Returns:

updated builder

path

public OpenApiDocument.Builder path(String path,
 OpenApiDocument.PathItem pathItem)

Add or merge a path item.

Parameters:

path - OpenAPI path

pathItem - path item

Returns:

updated builder

path

public OpenApiDocument.Builder path(String path,
 Consumer<OpenApiDocument.PathItemBuilder> pathItem)

Add or merge a path item.

Parameters:

path - OpenAPI path

pathItem - consumer to update path item builder

Returns:

updated builder

pathExtension

public OpenApiDocument.Builder pathExtension(String name,
 JsonValue value)

Add an extension to the paths object.

Extension names must start with x-.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

webhooks

public OpenApiDocument.Builder webhooks(Map<String, OpenApiDocument.PathItem> webhooks)

Add or merge webhook path items.

An empty map adds an empty Webhooks Object.

Parameters:

webhooks - webhook path items keyed by name

Returns:

updated builder

webhook

public OpenApiDocument.Builder webhook(String name,
 OpenApiDocument.PathItem pathItem)

Add or merge a webhook path item.

Parameters:

name - webhook name

pathItem - path item

Returns:

updated builder

webhook

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

Add or merge a webhook path item.

Parameters:

name - webhook name

pathItem - consumer to update path item builder

Returns:

updated builder

components

public OpenApiDocument.Builder components(OpenApiDocument.Components components)

Add or merge components.

Parameters:

components - components

Returns:

updated builder

components

public OpenApiDocument.Builder components(Consumer<OpenApiDocument.ComponentsBuilder> components)

Add or merge components.

Parameters:

components - consumer to update components builder

Returns:

updated builder

securityRequirement

public OpenApiDocument.Builder securityRequirement(String name,
 List<String> scopes)

Add a security requirement.

Parameters:

name - security scheme name

scopes - security scopes

Returns:

updated builder

securityRequirement

public OpenApiDocument.Builder securityRequirement(OpenApiDocument.SecurityRequirement requirement)

Add a security requirement.

Parameters:

requirement - security requirement

Returns:

updated builder

securityRequirement

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

Add a security requirement.

Parameters:

requirement - consumer to update security requirement builder

Returns:

updated builder

tag

public OpenApiDocument.Builder tag(String name,
 String description)

Add a document tag.

Parameters:

name - tag name

description - tag description

Returns:

updated builder

tag

public OpenApiDocument.Builder tag(OpenApiDocument.Tag tag)

Add a document tag.

Parameters:

tag - tag model

Returns:

updated builder

tag

public OpenApiDocument.Builder tag(Consumer<OpenApiDocument.TagBuilder> tag)

Add a document tag.

Parameters:

tag - consumer to update tag builder

Returns:

updated builder

externalDocs

public OpenApiDocument.Builder externalDocs(OpenApiDocument.ExternalDocs externalDocs)

Set external documentation.

Parameters:

externalDocs - external documentation

Returns:

updated builder

externalDocs

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

Set external documentation.

Parameters:

externalDocs - consumer to update external documentation builder

Returns:

updated builder

extension

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

Add an extension.

Extension names must start with x-.

Parameters:

name - extension name

value - extension value

Returns:

updated builder

merge

public OpenApiDocument.Builder merge(OpenApiDocument document)

Merge another OpenAPI document into this builder.

Parameters:

document - document to merge

Returns:

updated builder

Throws:

IllegalStateException - if both documents define conflicting values or the same path operation

build

public OpenApiDocument build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenApiDocument.Builder, OpenApiDocument>

Returns:

instance of the built type