A B D E I J N O P R S W

A

addResourcePackage(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

addResourcePackage(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.InterimBuilder

Deprecated.

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

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

Deprecated.

addResourcePackageClass(Class<?>) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.InterimBuilder

Deprecated.

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

afterScan(Reader, Swagger) - Method in class org.sdase.commons.optional.server.swagger.json.example.JsonExampleModifier

afterScan(Reader, Swagger) - Method in class org.sdase.commons.optional.server.swagger.parameter.embed.EmbedParameterModifier

afterScan(Reader, Swagger) - Method in class org.sdase.commons.optional.server.swagger.sort.SortingModifier

ApiListingResourceWithDeducedHost - Class in org.sdase.commons.server.swagger

B

beforeScan(Reader, Swagger) - Method in class org.sdase.commons.optional.server.swagger.json.example.JsonExampleModifier

beforeScan(Reader, Swagger) - Method in class org.sdase.commons.optional.server.swagger.parameter.embed.EmbedParameterModifier

beforeScan(Reader, Swagger) - Method in class org.sdase.commons.optional.server.swagger.sort.SortingModifier

build() - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

build() - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

builder() - Static method in class org.sdase.commons.server.swagger.SwaggerBundle

Deprecated.

D

disableEmbedParameter() - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

disableEmbedParameter() - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

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

disableJsonExamples() - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

disableJsonExamples() - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Disables automatic rendering of Json examples in Swagger property examples and response examples.

E

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

Adds the embeddable resources as query parameter such that they can be selected in swagger.

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

I

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

Deprecated.

J

JsonExampleModifier - Class in org.sdase.commons.optional.server.swagger.json.example

Converts examples from the sagger annotations from simple strings into JSON to allow to use the full expressiveness of swagger.

JsonExampleModifier() - Constructor for class org.sdase.commons.optional.server.swagger.json.example.JsonExampleModifier

N

normalizeSwaggerYaml(String) - Static method in class org.sdase.commons.server.swagger.SwaggerFileHelper

Normalize an textual OpenApi in the yaml format and remove all environment-specific contents.

O

org.sdase.commons.optional.server.swagger.json.example - package org.sdase.commons.optional.server.swagger.json.example

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

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

org.sdase.commons.server.swagger - package org.sdase.commons.server.swagger

P

process(Application, ServletContext, ServletConfig, HttpHeaders, UriInfo) - Method in class org.sdase.commons.server.swagger.ApiListingResourceWithDeducedHost

R

run(Configuration, Environment) - Method in class org.sdase.commons.server.swagger.SwaggerBundle

Deprecated.

S

SortingModifier - Class in org.sdase.commons.optional.server.swagger.sort

Sorts the Paths and Definitions alphabetically.

SortingModifier() - Constructor for class org.sdase.commons.optional.server.swagger.sort.SortingModifier

SwaggerBundle - Class in org.sdase.commons.server.swagger

Deprecated.

please migrate to sda-commons-server-openapi's OpenApiBundle

SwaggerBundle.Builder - Class in org.sdase.commons.server.swagger

Deprecated.

SwaggerBundle.FinalBuilder - Interface in org.sdase.commons.server.swagger

Deprecated.

SwaggerBundle.InitialBuilder - Interface in org.sdase.commons.server.swagger

Deprecated.

SwaggerBundle.InterimBuilder - Interface in org.sdase.commons.server.swagger

Deprecated.

SwaggerFileHelper - Class in org.sdase.commons.server.swagger

W

withContact(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withContact(String, String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withContact(String, String, String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withContact(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the contact of the API.

withContact(String, String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the contact of the API.

withContact(String, String, String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the contact of the API.

withDescription(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withDescription(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the description of the API.

withLicense(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withLicense(String, String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withLicense(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the license of the API.

withLicense(String, String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the license of the API.

withTermsOfServiceUrl(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withTermsOfServiceUrl(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the Terms of Service URL of the API.

withTitle(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withTitle(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.InitialBuilder

Deprecated.

Sets the title of the API.

withVersion(String) - Method in class org.sdase.commons.server.swagger.SwaggerBundle.Builder

Deprecated.

withVersion(String) - Method in interface org.sdase.commons.server.swagger.SwaggerBundle.FinalBuilder

Deprecated.

Sets the version of the API.

A B D E I J N O P R S W