A B C D E F G H I O R S V W

A

addResourcePackage(String) - Method in class org.sdase.commons.server.openapi.OpenApiBundle.Builder

addResourcePackage(String) - Method in interface org.sdase.commons.server.openapi.OpenApiBundle.InitialBuilder

Adds a package to the packages Swagger should scan to pick up resources.

addResourcePackageClass(Class<?>) - Method in class org.sdase.commons.server.openapi.OpenApiBundle.Builder

addResourcePackageClass(Class<?>) - Method in interface org.sdase.commons.server.openapi.OpenApiBundle.InitialBuilder

Adds the package of the given class to the packages Swagger should scan to pick up resources.

afterScan(OpenApiReader, OpenAPI) - Method in class org.sdase.commons.optional.server.openapi.parameter.embed.EmbedParameterModifier

afterScan(OpenApiReader, OpenAPI) - Method in class org.sdase.commons.optional.server.openapi.sort.SorterModifier

afterScan(OpenApiReader, OpenAPI) - Method in class org.sdase.commons.server.openapi.hal.HalLinkDescriptionModifier

B

beforeScan(OpenApiReader, OpenAPI) - Method in class org.sdase.commons.optional.server.openapi.parameter.embed.EmbedParameterModifier

beforeScan(OpenApiReader, OpenAPI) - Method in class org.sdase.commons.optional.server.openapi.sort.SorterModifier

beforeScan(OpenApiReader, OpenAPI) - Method in class org.sdase.commons.server.openapi.hal.HalLinkDescriptionModifier

build() - Method in class org.sdase.commons.server.openapi.OpenApiBundle.Builder

build() - Method in interface org.sdase.commons.server.openapi.OpenApiBundle.FinalBuilder

builder() - Static method in class org.sdase.commons.server.openapi.OpenApiBundle

C

clear() - Static method in class org.sdase.commons.server.openapi.filter.OpenAPISpecFilterSet

Clear all filters

configure(FeatureContext) - Method in class org.sdase.commons.server.openapi.filter.ServerUrlFilter

contextId(String) - Method in class org.sdase.commons.server.openapi.ContextIdOpenApiResource

Set a custom context id for the OpenApiContext to use different cache keys for the OpenAPI specifications.

ContextIdOpenApiResource - Class in org.sdase.commons.server.openapi

An OpenApiResource that sets a custom context id.

ContextIdOpenApiResource() - Constructor for class org.sdase.commons.server.openapi.ContextIdOpenApiResource

D

disableEmbedParameter() - Method in class org.sdase.commons.server.openapi.OpenApiBundle.Builder

disableEmbedParameter() - Method in interface org.sdase.commons.server.openapi.OpenApiBundle.FinalBuilder

Disables automatic addition of the embed query parameter if embeddable resources are discovered.

E

EmbedParameterModifier - Class in org.sdase.commons.optional.server.openapi.parameter.embed

Adds the embeddable resources as query parameter so they can be selected in the swagger ui.

EmbedParameterModifier() - Constructor for class org.sdase.commons.optional.server.openapi.parameter.embed.EmbedParameterModifier

F

filterOpenAPI(OpenAPI, Map<String, List<String>>, Map<String, String>, Map<String, List<String>>) - Method in class org.sdase.commons.server.openapi.filter.OpenAPISpecFilterSet

filterOpenAPI(OpenAPI, Map<String, List<String>>, Map<String, String>, Map<String, List<String>>) - Method in class org.sdase.commons.server.openapi.filter.ServerUrlFilter

G

getContextId(ServletConfig) - Method in class org.sdase.commons.server.openapi.ContextIdOpenApiResource

getName() - Method in enum org.sdase.commons.server.openapi.hal.HALModelResolver.HALReservedProperty

getValue(Annotation) - Method in enum org.sdase.commons.server.openapi.hal.HALModelResolver.HALReservedProperty

H

HalLinkDescriptionModifier - Class in org.sdase.commons.server.openapi.hal

An ReaderListener that provides a description for the HALLink class that is not annotated and lacks a correct description.

HalLinkDescriptionModifier() - Constructor for class org.sdase.commons.server.openapi.hal.HalLinkDescriptionModifier

HALModelResolver - Class in org.sdase.commons.server.openapi.hal

Converter to handle HAL annotated classes.

HALModelResolver(ObjectMapper) - Constructor for class org.sdase.commons.server.openapi.hal.HALModelResolver

HALModelResolver.HalModifiedAnnotation - Interface in org.sdase.commons.server.openapi.hal

A custom annotation tto show that a type was already handled by the discovery logic.

HALModelResolver.HALReservedProperty - Enum in org.sdase.commons.server.openapi.hal

Enumeration of properties reserved for HAL along with the association to the annotation marking objects to go into these properties.

I

initialize(Bootstrap<?>) - Method in class org.sdase.commons.server.openapi.OpenApiBundle

O

OpenApiBundle - Class in org.sdase.commons.server.openapi

A bundle used to generate and serve API-first or code-first OpenAPI 3 files at the openapi.yaml or openapi.json HTTP resources.

OpenApiBundle(Set<String>, OpenAPI) - Constructor for class org.sdase.commons.server.openapi.OpenApiBundle

OpenApiBundle.Builder - Class in org.sdase.commons.server.openapi

OpenApiBundle.FinalBuilder - Interface in org.sdase.commons.server.openapi

OpenApiBundle.InitialBuilder - Interface in org.sdase.commons.server.openapi

OpenAPISorter - Class in org.sdase.commons.optional.server.openapi.sort

Sorter for the contents of an OpenAPI specification.

OpenAPISpecFilterSet - Class in org.sdase.commons.server.openapi.filter

An implementation of the OpenAPISpecFilter that delegates the request to multiple registered filters.

OpenAPISpecFilterSet() - Constructor for class org.sdase.commons.server.openapi.filter.OpenAPISpecFilterSet

org.sdase.commons.optional.server.openapi.parameter.embed - package org.sdase.commons.optional.server.openapi.parameter.embed

org.sdase.commons.optional.server.openapi.sort - package org.sdase.commons.optional.server.openapi.sort

org.sdase.commons.server.openapi - package org.sdase.commons.server.openapi

org.sdase.commons.server.openapi.filter - package org.sdase.commons.server.openapi.filter

org.sdase.commons.server.openapi.hal - package org.sdase.commons.server.openapi.hal

R

register(OpenAPISpecFilter) - Static method in class org.sdase.commons.server.openapi.filter.OpenAPISpecFilterSet

Register a filter that should be called when an OpenAPI file is returned to a caller.

resolve(AnnotatedType, ModelConverterContext, Iterator<ModelConverter>) - Method in class org.sdase.commons.server.openapi.hal.HALModelResolver

run(Configuration, Environment) - Method in class org.sdase.commons.server.openapi.OpenApiBundle

S

ServerUrlFilter - Class in org.sdase.commons.server.openapi.filter

An OpenAPISpecFilter that adds the base URL to OpenAPI.servers(List).

ServerUrlFilter() - Constructor for class org.sdase.commons.server.openapi.filter.ServerUrlFilter

sort(OpenAPI) - Static method in class org.sdase.commons.optional.server.openapi.sort.OpenAPISorter

Sort all the paths and components of the OpenAPI specification, in place.

SorterModifier - Class in org.sdase.commons.optional.server.openapi.sort

A ReaderListener that runs the OpenAPISorter.

SorterModifier() - Constructor for class org.sdase.commons.optional.server.openapi.sort.SorterModifier

V

valueOf(String) - Static method in enum org.sdase.commons.server.openapi.hal.HALModelResolver.HALReservedProperty

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

valueOf(Class<? extends Annotation>) - Static method in enum org.sdase.commons.server.openapi.hal.HALModelResolver.HALReservedProperty

values() - Static method in enum org.sdase.commons.server.openapi.hal.HALModelResolver.HALReservedProperty

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

W

withExistingOpenAPI(String) - Method in class org.sdase.commons.server.openapi.OpenApiBundle.Builder

withExistingOpenAPI(String) - Method in interface org.sdase.commons.server.openapi.OpenApiBundle.InitialBuilder

Use an existing OpenAPI 3 specification as base for the generation.

withExistingOpenAPIFromClasspathResource(String) - Method in interface org.sdase.commons.server.openapi.OpenApiBundle.InitialBuilder

Reads an existing OpenAPI 3 specification from the given classpath resource and provide it to OpenApiBundle.InitialBuilder.withExistingOpenAPI(String)

A B C D E F G H I O R S V W