Index

A B C D E F G H I J M N O P R S T V Y
All Classes and Interfaces|All Packages|Constant Field Values

A

addExcludes(String...) - Method in class io.helidon.openapi.ExpandedTypeDescription

Add property names excludes.

addExtensions() - Method in class io.helidon.openapi.ExpandedTypeDescription

Adds property handling for extensions.

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

Adds an alternative server to service the specified operation.

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

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

addRef() - Method in class io.helidon.openapi.ExpandedTypeDescription

Adds property handling for a $ref reference.

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

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

Creates a new builder for composing an OpenAPI config instance.

buildImplsToTypes(ParserHelper) - Static method in class io.helidon.openapi.ExpandedTypeDescription

Build a map of implementations to types.

byFileType(String) - Static method in enum class io.helidon.openapi.OpenAPIMediaType

Find media type by file suffix.

byMediaType(MediaType) - Static method in enum class io.helidon.openapi.OpenAPIMediaType

Find OpenAPI media type by media type.

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.

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

Create a new parser helper.

create(Class<?>, Class<?>) - Static method in class io.helidon.openapi.ExpandedTypeDescription

Factory method for ease of chaining other method invocations.

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_TYPE - Static variable in enum class io.helidon.openapi.OpenAPIMediaType

Default media type (YAML).

E

entrySet() - Method in class io.helidon.openapi.ParserHelper

Entries of this helper.

ExpandedTypeDescription - Class in io.helidon.openapi

Extension of TypeDescription that handles: nested enums, extensible types, references, and additional properties (which can be either Boolean or Schema).

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.

format() - Method in enum class io.helidon.openapi.OpenAPIMediaType

Format associated with this media type.

G

getProperty(String) - Method in class io.helidon.openapi.ExpandedTypeDescription

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

H

hasDefaultProperty() - Method in class io.helidon.openapi.ExpandedTypeDescription

Whether a default value exists.

I

impl() - Method in class io.helidon.openapi.ExpandedTypeDescription

Returns the implementation class associated with this type descr.

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

Helidon SE OpenAPI Support.

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

Helidon common OpenAPI classes to be used when integrating with servers (Níma, Reactive, MicroProfile).

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

Internal classes for Helidon OpenAPI support.

J

JSON - Enum constant in enum class io.helidon.openapi.OpenAPIMediaType

JSON media type.

M

matchingTypes() - Method in enum class io.helidon.openapi.OpenAPIMediaType

File types matching this media type.

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.

N

newInstance(String, Node) - Method in class io.helidon.openapi.ExpandedTypeDescription

O

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.

OpenAPIMediaType - Enum Class in io.helidon.openapi

Abstraction of the different representations of a static OpenAPI document file and the file type(s) they correspond to.

OpenAPIParser - Class in io.helidon.openapi

Abstraction for SnakeYAML parsing of JSON and YAML.

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.

P

parse(Map<Class<?>, ExpandedTypeDescription>, InputStream) - Static method in class io.helidon.openapi.OpenAPIParser

Parse open API.

ParserHelper - Class in io.helidon.openapi

Wraps generated parser and uses ExpandedTypeDescription as its type.

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.

preferredOrdering() - Static method in enum class io.helidon.openapi.OpenAPIMediaType

Media types we recognize as OpenAPI, in order of preference.

R

recognizedFileTypes() - Static method in enum class io.helidon.openapi.OpenAPIMediaType

List of all supported file types.

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.

serialize(Map<Class<?>, ExpandedTypeDescription>, Map<Class<?>, ExpandedTypeDescription>, OpenAPI, Format, Writer) - Static method in class io.helidon.openapi.Serializer

Serialize using the selected format.

Serializer - Class in io.helidon.openapi

Expresses an existing OpenAPI instance as an OpenAPI document.

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

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

Sets servers.

setupPropertyType(String, Node) - Method in class io.helidon.openapi.ExpandedTypeDescription

T

types() - Method in class io.helidon.openapi.ParserHelper

Types.

V

valueOf(String) - Static method in enum class io.helidon.openapi.OpenAPIMediaType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class io.helidon.openapi.OpenAPIMediaType

Returns an array containing the constants of this enum class, in the order they are declared.

Y

YAML - Enum constant in enum class io.helidon.openapi.OpenAPIMediaType

YAML media type.

A B C D E F G H I J M N O P R S T V Y
All Classes and Interfaces|All Packages|Constant Field Values