A B C D F H I M O P S U V W
All Classes All Packages

A

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

Adds an operation server.

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 a path server.

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

Adds a path server for a given path.

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.OpenAPISupport.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() - Constructor for class io.helidon.openapi.OpenAPISupport.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 openapi Config object.

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

Set various builder attributes from the specified openapi Config object.

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

Config key for locating openapi settings within a Helidon config object.

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.

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.

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.

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

Set the app-provided OpenAPI model filter class.

H

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

Deprecated.

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

Deprecated.

I

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

Returns the Jandex IndexView containing annotated endpoint classes.

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

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.

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.

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

Sets the app-provided model reader class.

O

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.Builder - Class in io.helidon.openapi

Fluent API builder for OpenAPISupport.

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

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

Sets operation servers.

P

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

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

Sets path servers.

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

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

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

Sets whether schema references are enabled.

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 location of the static OpenAPI document file.

U

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

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

Path under which to register OpenAPI endpoint on the web server.

A B C D F H I M O P S U V W
All Classes All Packages