Index

A B C D E F H I M N O P Q R S T U V W
All Classes and Interfaces|All Packages

A

add(OpenApiContributor) - Method in class dev.relism.flash.ext.openapi.OpenApiContributorRegistry

addOperation(Route, ApiOperation, Class<?>) - Method in class dev.relism.flash.ext.openapi.OpenApiBuilder

Documents one route.

allowEmptyValue() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

allResponses() - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution

allResponses(OpenApiResponseContribution) - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution.Builder

ApiOperation - Annotation Interface in dev.relism.flash.ext.openapi

Declares OpenAPI operation metadata for a class-based handler.

APIResponse - Annotation Interface in dev.relism.flash.ext.openapi

Declares one OpenAPI response for a class-based handler operation.

APIResponses - Annotation Interface in dev.relism.flash.ext.openapi

Container for repeated APIResponse annotations.

array() - Element in annotation interface dev.relism.flash.ext.openapi.Content

array() - Element in annotation interface dev.relism.flash.ext.openapi.RequestBody

ARRAY - Enum constant in enum class dev.relism.flash.ext.openapi.SchemaType

ArraySchema - Annotation Interface in dev.relism.flash.ext.openapi

Optional array-specific schema metadata.

B

BOOLEAN - Enum constant in enum class dev.relism.flash.ext.openapi.SchemaType

build() - Method in class dev.relism.flash.ext.openapi.OpenApiBuilder

build() - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution.Builder

build() - Method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution.Builder

builder() - Static method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution

builder() - Static method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution

Builder() - Constructor for class dev.relism.flash.ext.openapi.OpenApiOperationContribution.Builder

Builder() - Constructor for class dev.relism.flash.ext.openapi.OpenApiResponseContribution.Builder

C

componentContributions() - Method in interface dev.relism.flash.ext.openapi.OpenApiContributor

configure(FlashRegistrar<?>, FlashContext) - Method in class dev.relism.flash.ext.openapi.OpenApiExtension

content() - Element in annotation interface dev.relism.flash.ext.openapi.APIResponse

Content - Annotation Interface in dev.relism.flash.ext.openapi

What a response carries: the schema, and an example of it.

contentType() - Element in annotation interface dev.relism.flash.ext.openapi.RequestBody

contributors() - Method in class dev.relism.flash.ext.openapi.OpenApiContributorRegistry

COOKIE - Enum constant in enum class dev.relism.flash.ext.openapi.ParameterIn

D

deprecated() - Element in annotation interface dev.relism.flash.ext.openapi.ApiOperation

deprecated() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

deprecated() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

description() - Element in annotation interface dev.relism.flash.ext.openapi.ApiOperation

description() - Element in annotation interface dev.relism.flash.ext.openapi.APIResponse

description() - Method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution

description() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

description() - Element in annotation interface dev.relism.flash.ext.openapi.RequestBody

description() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

description() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

description(String) - Method in class dev.relism.flash.ext.openapi.OpenApiBuilder

description(String) - Method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution.Builder

dev.relism.flash.ext.openapi - package dev.relism.flash.ext.openapi

E

empty() - Static method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution

enumeration() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

enumeration() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

example() - Element in annotation interface dev.relism.flash.ext.openapi.Content

One example body, shown beside the schema.

example() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

example() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

example() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

examples() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

explode() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

F

format() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

format() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

H

header(String, Map<String, Object>) - Method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution.Builder

HEADER - Enum constant in enum class dev.relism.flash.ext.openapi.ParameterIn

headers() - Method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution

hidden() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

hidden() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

I

in() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

INTEGER - Enum constant in enum class dev.relism.flash.ext.openapi.SchemaType

isEmpty() - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution

itemClass() - Element in annotation interface dev.relism.flash.ext.openapi.ArraySchema

M

maxItems() - Element in annotation interface dev.relism.flash.ext.openapi.ArraySchema

minItems() - Element in annotation interface dev.relism.flash.ext.openapi.ArraySchema

N

name() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

name() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

name() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

nullable() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

nullable() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

NUMBER - Enum constant in enum class dev.relism.flash.ext.openapi.SchemaType

O

OBJECT - Enum constant in enum class dev.relism.flash.ext.openapi.SchemaType

of(String) - Static method in class dev.relism.flash.ext.openapi.OpenApiResponseContribution

OpenApiBuilder - Class in dev.relism.flash.ext.openapi

Assembles the OpenAPI document from what the handlers already say about themselves.

OpenApiBuilder() - Constructor for class dev.relism.flash.ext.openapi.OpenApiBuilder

OpenApiContributor - Interface in dev.relism.flash.ext.openapi

OpenApiContributorRegistry - Class in dev.relism.flash.ext.openapi

OpenApiContributorRegistry() - Constructor for class dev.relism.flash.ext.openapi.OpenApiContributorRegistry

OpenApiExtension - Class in dev.relism.flash.ext.openapi

Generates and serves an OpenAPI 3.0 spec and Swagger UI under a configurable base path.

OpenApiExtension() - Constructor for class dev.relism.flash.ext.openapi.OpenApiExtension

OpenApiExtension(String) - Constructor for class dev.relism.flash.ext.openapi.OpenApiExtension

OpenApiExtension(String, String, String) - Constructor for class dev.relism.flash.ext.openapi.OpenApiExtension

OpenApiExtension(String, String, String, String) - Constructor for class dev.relism.flash.ext.openapi.OpenApiExtension

OpenApiOperationContribution - Class in dev.relism.flash.ext.openapi

OpenApiOperationContribution.Builder - Class in dev.relism.flash.ext.openapi

OpenApiResponseContribution - Class in dev.relism.flash.ext.openapi

OpenApiResponseContribution.Builder - Class in dev.relism.flash.ext.openapi

operationFor(Class<?>) - Method in interface dev.relism.flash.ext.openapi.OpenApiContributor

operationId() - Element in annotation interface dev.relism.flash.ext.openapi.ApiOperation

P

Parameter - Annotation Interface in dev.relism.flash.ext.openapi

Declares one OpenAPI parameter for a class-based handler operation.

ParameterIn - Enum Class in dev.relism.flash.ext.openapi

Parameters - Annotation Interface in dev.relism.flash.ext.openapi

Container for repeated Parameter annotations.

PATH - Enum constant in enum class dev.relism.flash.ext.openapi.ParameterIn

Q

QUERY - Enum constant in enum class dev.relism.flash.ext.openapi.ParameterIn

R

RequestBody - Annotation Interface in dev.relism.flash.ext.openapi

The body this operation takes, for a handler that reads it by hand.

required() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

required() - Element in annotation interface dev.relism.flash.ext.openapi.RequestBody

required() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

required() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

response(int, OpenApiResponseContribution) - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution.Builder

responseCode() - Element in annotation interface dev.relism.flash.ext.openapi.APIResponse

responses() - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution

S

schema() - Element in annotation interface dev.relism.flash.ext.openapi.Content

Schema - Annotation Interface in dev.relism.flash.ext.openapi

Minimal OpenAPI schema metadata for model classes and properties.

SchemaProperty - Annotation Interface in dev.relism.flash.ext.openapi

Optional alias for property-level schema metadata.

SchemaType - Enum Class in dev.relism.flash.ext.openapi

security() - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution

security(String, List<String>) - Method in class dev.relism.flash.ext.openapi.OpenApiOperationContribution.Builder

STRING - Enum constant in enum class dev.relism.flash.ext.openapi.SchemaType

style() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

summary() - Element in annotation interface dev.relism.flash.ext.openapi.ApiOperation

T

tags() - Element in annotation interface dev.relism.flash.ext.openapi.ApiOperation

title() - Element in annotation interface dev.relism.flash.ext.openapi.Schema

title() - Element in annotation interface dev.relism.flash.ext.openapi.SchemaProperty

title(String) - Method in class dev.relism.flash.ext.openapi.OpenApiBuilder

type() - Element in annotation interface dev.relism.flash.ext.openapi.Parameter

U

Undocumented - Annotation Interface in dev.relism.flash.ext.openapi

Keeps a route out of the published document.

uniqueItems() - Element in annotation interface dev.relism.flash.ext.openapi.ArraySchema

V

value() - Element in annotation interface dev.relism.flash.ext.openapi.APIResponses

value() - Element in annotation interface dev.relism.flash.ext.openapi.Parameters

value() - Element in annotation interface dev.relism.flash.ext.openapi.RequestBody

valueOf(String) - Static method in enum class dev.relism.flash.ext.openapi.ParameterIn

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

valueOf(String) - Static method in enum class dev.relism.flash.ext.openapi.SchemaType

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

values() - Static method in enum class dev.relism.flash.ext.openapi.ParameterIn

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

values() - Static method in enum class dev.relism.flash.ext.openapi.SchemaType

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

version(String) - Method in class dev.relism.flash.ext.openapi.OpenApiBuilder

W

wireValue() - Method in enum class dev.relism.flash.ext.openapi.ParameterIn

wireValue() - Method in enum class dev.relism.flash.ext.openapi.SchemaType

A B C D E F H I M N O P Q R S T U V W
All Classes and Interfaces|All Packages