Index

A B C D E F H I J K L 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.

AGATE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

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

ALPHA - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Sort

ALTERNATE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

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.

ARTA - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

B

BLUE_PLANET - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

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

cdn(String) - Method in class dev.relism.flash.ext.openapi.Ui

Where the bundle is loaded from, without a trailing slash.

CLASSIC - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Layout

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

customCss(String) - Method in class dev.relism.flash.ext.openapi.Ui

CSS appended to the page, after the bundle's own.

D

darkMode(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

Dark on load; the reader's toggle still wins unless Ui.Scalar.hideDarkModeToggle(boolean).

DEEP_SPACE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

deepLinking(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

Whether a tag or an operation gets its own URL.

DEFAULT - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

defaultOpenAllTags(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

Every tag open on load, rather than only the first.

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

disableSearch(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

docExpansion(Ui.Swagger.Expand) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

Tags open, everything open, or nothing.

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

filter(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

The box that filters operations by tag.

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

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

FULL - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Expand

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

hideClientButton(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

The button that opens the operation in Scalar's API client.

hideDarkModeToggle(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

hideDownloadButton(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

hideHostname(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

Hides the host the servers declare, leaving the paths.

hideModels(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

Whether components.schemas gets a section of its own.

hideSchemaTitles(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

hideSearch(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

hideTestRequestButton(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

The button that fires the request from the page.

I

IDEA - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

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

J

jsonSampleExpandLevel(int) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

How deep a JSON sample is expanded; 0 collapses it.

K

KEPLER - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

L

LASERWAVE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

layout(Ui.Scalar.Layout) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

LIST - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Expand

M

MARS - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

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

menuToggle(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

Whether an open sidebar group can be collapsed again.

METHOD - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Sort

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

modelsExpandDepth(int) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

How deep the models open; -1 hides them.

MODERN - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Layout

MONOKAI - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

MOON - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

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

nativeScrollbars(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

The browser's own scrollbars in the sidebar.

none() - Static method in class dev.relism.flash.ext.openapi.Ui

No page at all — the spec routes stay.

NONE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

NONE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Expand

NORD - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

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

OBSIDIAN - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

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 the documentation page that reads it, 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

option(String, Object) - Method in class dev.relism.flash.ext.openapi.Ui

Any option this class does not name, as its upstream documentation spells it; null drops it.

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

pathInMiddlePanel(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

The path in the middle panel rather than beside the description.

persistAuthorization(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

Whether credentials entered in the page survive a reload.

PURPLE - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

Q

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

R

redoc() - Static method in class dev.relism.flash.ext.openapi.Ui

Redoc: three panels, read-only, the most printable of the three.

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

requiredPropsFirst(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

Required properties first in every schema, rather than in declaration order.

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

SATURN - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

scalar() - Static method in class dev.relism.flash.ext.openapi.Ui

Scalar: the modern one, with themes and an API client built in.

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

showSidebar(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

SOLARIZED - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Theme

sortAlphabetically(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

Sorts tags and operations by name rather than by the order the document lists them.

sortOperationsBy(Ui.Scalar.Sort) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

sortPropsAlphabetically(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Redoc

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

swagger() - Static method in class dev.relism.flash.ext.openapi.Ui

Swagger UI: the one that lets you fire requests from the page.

syntaxTheme(Ui.Swagger.Syntax) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

T

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

theme(Ui.Scalar.Theme) - Method in class dev.relism.flash.ext.openapi.Ui.Scalar

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

TOMORROW_NIGHT - Enum constant in enum class dev.relism.flash.ext.openapi.Ui.Swagger.Syntax

tryItOut(boolean) - Method in class dev.relism.flash.ext.openapi.Ui.Swagger

Whether "Try it out" is already on.

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

U

ui(Ui<?>) - Method in class dev.relism.flash.ext.openapi.OpenApiExtension

Which documentation page to serve, Ui.swagger() by default; Ui.none() serves none.

Ui<S> - Class in dev.relism.flash.ext.openapi

The documentation page served beside the spec: Swagger UI, Redoc or Scalar.

Ui.Redoc - Class in dev.relism.flash.ext.openapi

Redoc community edition, pinned to 2.x.

Ui.Scalar - Class in dev.relism.flash.ext.openapi

Scalar's API reference, pinned to 1.x.

Ui.Scalar.Layout - Enum Class in dev.relism.flash.ext.openapi

Sidebar and content in two columns, or the one-column classic.

Ui.Scalar.Sort - Enum Class in dev.relism.flash.ext.openapi

What decides the order of the operations in a tag.

Ui.Scalar.Theme - Enum Class in dev.relism.flash.ext.openapi

Scalar's own palettes.

Ui.Swagger - Class in dev.relism.flash.ext.openapi

Swagger UI, pinned to 5.x.

Ui.Swagger.Expand - Enum Class in dev.relism.flash.ext.openapi

How much of the document is open when the page loads.

Ui.Swagger.Syntax - Enum Class in dev.relism.flash.ext.openapi

The highlighter's palette.

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.

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

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

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

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

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

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

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

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

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

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.

values() - Static method in enum class dev.relism.flash.ext.openapi.Ui.Scalar.Layout

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.Ui.Scalar.Sort

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.Ui.Scalar.Theme

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.Ui.Swagger.Expand

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.Ui.Swagger.Syntax

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 J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages