Index

A B C D E F G I M O P S U V W
All Classes and Interfaces|All Packages|Constant Field Values

A

addOperationServer(String, String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Adds an alternative server to service the specified operation.

addOperationServer(String, String) - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

Adds an operation server for a given operation ID.

addPathServer(String, String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Adds an alternative server for all operations in the specified path.

addPathServer(String, String) - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

Adds a path server for a given path.

addSchema(String, String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Adds a schema for a class.

addServer(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Adds server.

applicationPathDisable() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

applicationPathDisable(Boolean) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets whether the app path search should be disabled.

B

build() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

build() - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

build(Function<MediaType, String>, String) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Creates a new OpenApiUi from the builder.

builder() - Static method in class io.helidon.openapi.internal.OpenAPIConfigImpl

Creates a new builder for composing an OpenAPI config instance.

builder() - Static method in class io.helidon.openapi.OpenAPISupport

Creates a new OpenAPISupport.Builder for OpenAPISupport using defaults.

builder() - Static method in interface io.helidon.openapi.OpenApiUi

Creates a builder for a new OpenApiUi instance.

builder() - Method in interface io.helidon.openapi.OpenApiUiFactory

builder() - Method in class io.helidon.openapi.OpenApiUiNoOpFactory

Builder() - Constructor for class io.helidon.openapi.OpenAPISupport.Builder

Builder() - Constructor for class io.helidon.openapi.OpenApiUiBase.Builder

C

config(Config) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets the builder's attributes according to the corresponding entries (if present) in the specified openapi Config object.

config(Config) - Method in class io.helidon.openapi.OpenAPISupport.Builder

Set various builder attributes from the specified Config object.

config(Config) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Updates the builder using the specified config node at "ui" within the "openapi" config section.

config(Config) - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

Assigns various OpenAPI settings from the specified openapi Config object.

CONFIG_KEY - Static variable in class io.helidon.openapi.OpenAPISupport.Builder

Config key to select the openapi node from Helidon config.

configureEndpoint(Routing.Rules) - Method in class io.helidon.openapi.OpenAPISupport

Sets up the OpenAPI endpoint by adding routing to the specified rules set.

create() - Static method in class io.helidon.openapi.OpenAPISupport

Creates a new OpenAPISupport instance using defaults.

create(Config) - Static method in class io.helidon.openapi.OpenAPISupport

Creates a new OpenAPISupport instance using the 'openapi' portion of the provided Config object.

crossOriginConfig(CrossOriginConfig) - Method in class io.helidon.openapi.OpenAPISupport.Builder

Assigns the CORS settings for the OpenAPI endpoint.

customSchemaRegistryClass() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

customSchemaRegistryClass(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets the custom schema registry class.

D

DEFAULT_RESPONSE_MEDIA_TYPE - Static variable in class io.helidon.openapi.OpenAPISupport

Default media type used in responses in absence of incoming Accept header.

DEFAULT_WEB_CONTEXT - Static variable in class io.helidon.openapi.OpenAPISupport

Default path for serving the OpenAPI document.

documentPreparer() - Method in class io.helidon.openapi.OpenApiUiBase.Builder

documentPreparer(Function<MediaType, String>) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Assigns how the OpenAPI UI can obtain a formatted document for a given media type.

documentPreparer(Function<MediaType, String>) - Method in class io.helidon.openapi.OpenApiUiBase.Builder

E

ENABLED_CONFIG_KEY - Static variable in interface io.helidon.openapi.OpenApiUi.Builder

Config key for the enabled setting.

F

filter() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

filter(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets the developer-provided OpenAPI filter class name.

filter(String) - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

Set the app-provided OpenAPI model filter class.

G

getSchemas() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

I

identity() - Method in interface io.helidon.openapi.OpenApiUi.Builder

indexViewsSupplier() - Method in class io.helidon.openapi.OpenAPISupport.Builder

Returns the supplier of index views.

io.helidon.openapi - module io.helidon.openapi

Helidon SE OpenAPI Support.

io.helidon.openapi - package io.helidon.openapi

Helidon SE OpenAPI Support.

io.helidon.openapi.internal - package io.helidon.openapi.internal

Internal classes for Helidon OpenAPI support.

isEnabled() - Method in class io.helidon.openapi.OpenApiUiBase

isEnabled(boolean) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Sets whether the UI should be enabled.

isEnabled(boolean) - Method in class io.helidon.openapi.OpenApiUiBase.Builder

M

modelReader() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

modelReader(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets the developer-provided OpenAPI model reader class name.

modelReader(String) - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

Sets the app-provided model reader class.

O

OPENAPI_UI_CONFIG_KEY - Static variable in interface io.helidon.openapi.OpenApiUi.Builder

Config prefix within the "openapi" section containing UI settings.

openAPIConfig() - Method in class io.helidon.openapi.OpenAPISupport.Builder

Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.

openAPIConfig() - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

OpenAPIConfigImpl - Class in io.helidon.openapi.internal

Helidon-specific implementation of the smallrye OpenApiConfig interface, loadable from a Helidon Config object as well as individual items settable programmatically.

OpenAPIConfigImpl.Builder - Class in io.helidon.openapi.internal

Fluent builder for OpenAPIConfigImpl.

OpenAPISupport - Class in io.helidon.openapi

Provides an endpoint and supporting logic for returning an OpenAPI document that describes the endpoints handled by the server.

OpenAPISupport(OpenAPISupport.Builder<?>) - Constructor for class io.helidon.openapi.OpenAPISupport

Creates a new instance of OpenAPISupport.

OpenAPISupport.Builder<B extends OpenAPISupport.Builder<B>> - Class in io.helidon.openapi

Fluent API builder for OpenAPISupport.

openApiSupportWebContext() - Method in class io.helidon.openapi.OpenApiUiBase.Builder

openApiSupportWebContext(String) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Assigns the web context the OpenAPISupport instance uses.

openApiSupportWebContext(String) - Method in class io.helidon.openapi.OpenApiUiBase.Builder

OpenApiUi - Interface in io.helidon.openapi

Behavior for OpenAPI UI implementations.

OpenApiUi.Builder<B extends OpenApiUi.Builder<B,T>,T extends OpenApiUi> - Interface in io.helidon.openapi

Builder for an OpenApiUi.

OpenApiUiBase - Class in io.helidon.openapi

Common base class for implementations of @link OpenApiUi}.

OpenApiUiBase(OpenApiUiBase.Builder<?, ?>, Function<MediaType, String>, String) - Constructor for class io.helidon.openapi.OpenApiUiBase

Creates a new UI implementation from the specified builder and document preparer.

OpenApiUiBase.Builder<B extends OpenApiUiBase.Builder<B,T>,T extends OpenApiUi> - Class in io.helidon.openapi

Common base builder implementation for creating a new OpenApiUi.

OpenApiUiFactory<B extends OpenApiUi.Builder<B,T>,T extends OpenApiUi> - Interface in io.helidon.openapi

Behavior for factories able to provide new builders of OpenApiUi instances.

OpenApiUiNoOpFactory - Class in io.helidon.openapi

Factory providing builders for OpenApiUiNoOp implementations.

OpenApiUiNoOpFactory() - Constructor for class io.helidon.openapi.OpenApiUiNoOpFactory

operationServers(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

operationServers(String, String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets alternative servers to service the specified operation.

options() - Method in class io.helidon.openapi.OpenApiUiBase.Builder

options() - Method in class io.helidon.openapi.OpenApiUiBase

options(Map<String, String>) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Merges implementation-specific UI options.

options(Map<String, String>) - Method in class io.helidon.openapi.OpenApiUiBase.Builder

OPTIONS_CONFIG_KEY - Static variable in interface io.helidon.openapi.OpenApiUi.Builder

Config key for implementation-dependent options settings.

P

pathServers(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

pathServers(String, String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets alternative servers to service all operations in the specified path.

prepareDocument(MediaType) - Method in class io.helidon.openapi.OpenApiUiBase

Prepares a representation of the OpenAPI document in the specified media type.

prepareModel() - Method in class io.helidon.openapi.OpenAPISupport

Triggers preparation of the model from external code.

prepareTextResponseFromMainEndpoint(ServerRequest, ServerResponse) - Method in interface io.helidon.openapi.OpenApiUi

Gives the UI an opportunity to respond to a request arriving at the OpenAPISupport endpoint for which the best-accepted MediaType was text/html.

S

scanClasses() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

scanDependenciesDisable() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

scanDependenciesJars() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

scanDisable() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

scanDisable(boolean) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets whether annotation scanning should be disabled.

scanExcludeClasses() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

scanExcludePackages() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

scanPackages() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

SCHEMA - Static variable in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Config key prefix for schema overrides for specified classes.

schemas(Map<String, String>) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets schemas for one or more classes referenced in the OpenAPI model.

sendStaticText(ServerRequest, ServerResponse, MediaType) - Method in class io.helidon.openapi.OpenApiUiBase

Sends a static text response of the given media type.

SEOpenAPISupportBuilder - Class in io.helidon.openapi

Builds OpenAPISupport in a Helidon SE environment.

SEOpenAPISupportBuilder() - Constructor for class io.helidon.openapi.SEOpenAPISupportBuilder

servers() - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl

servers(String) - Method in class io.helidon.openapi.internal.OpenAPIConfigImpl.Builder

Sets servers.

servers(String) - Method in class io.helidon.openapi.SEOpenAPISupportBuilder

Sets the servers which offer the endpoints in the OpenAPI document.

staticFile(String) - Method in class io.helidon.openapi.OpenAPISupport.Builder

Sets the file system path of the static OpenAPI document file.

supportedMediaTypes() - Method in interface io.helidon.openapi.OpenApiUi

Indicates the media types the UI implementation itself supports.

U

ui(OpenApiUi.Builder<?, ?>) - Method in class io.helidon.openapi.OpenAPISupport.Builder

Assigns the OpenAPI UI builder the OpenAPISupport service should use in preparing the UI.

UI_WEB_SUBCONTEXT - Static variable in interface io.helidon.openapi.OpenApiUi

Default subcontext within the OpenAPISupport instance's web context (which itself defaults to "/openapi".

update(Routing.Rules) - Method in class io.helidon.openapi.OpenAPISupport

V

validate() - Method in class io.helidon.openapi.OpenAPISupport.Builder

Makes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).

W

WEB_CONTEXT_CONFIG_KEY - Static variable in interface io.helidon.openapi.OpenApiUi.Builder

Config key for specifying the entire web context where the UI responds.

webContext() - Method in class io.helidon.openapi.OpenAPISupport

webContext() - Method in class io.helidon.openapi.OpenApiUiBase

webContext(String) - Method in class io.helidon.openapi.OpenAPISupport.Builder

Sets the web context path for the OpenAPI endpoint.

webContext(String) - Method in interface io.helidon.openapi.OpenApiUi.Builder

Sets the entire web context (not just the suffix) where the UI response.

webContext(String) - Method in class io.helidon.openapi.OpenApiUiBase.Builder

A B C D E F G I M O P S U V W
All Classes and Interfaces|All Packages|Constant Field Values