Uses of Class
io.helidon.openapi.OpenApiDocument.Builder

Packages that use OpenApiDocument.Builder

Package	Description
io.helidon.openapi	Helidon OpenAPI support.
io.helidon.openapi.spi	OpenAPI SPI.

Uses of OpenApiDocument.Builder in io.helidon.openapi

Classes in io.helidon.openapi that implement interfaces with type arguments of type OpenApiDocument.Builder

Modifier and Type	Class	Description
static final class	OpenApiDocument.Builder	OpenAPI document builder.

Methods in io.helidon.openapi that return OpenApiDocument.Builder

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

Methods in io.helidon.openapi with parameters of type OpenApiDocument.Builder

Modifier and Type	Method	Description
protected static void	OpenApiSourceBase.componentSchema(OpenApiDocument.Builder document, JsonSchemaProvider provider, String name)	Add a component schema from a JSON schema provider to the OpenAPI document.

Uses of OpenApiDocument.Builder in io.helidon.openapi.spi

Methods in io.helidon.openapi.spi with parameters of type OpenApiDocument.Builder

Modifier and Type	Method	Description
void	OpenApiDocumentSource.describe(OpenApiDocumentContext context, OpenApiDocument.Builder document)	Describe this source as OpenAPI document metadata.