Package dev.relism.flash.ext.openapi

Class Ui.Swagger

java.lang.Object

dev.relism.flash.ext.openapi.Ui<Ui.Swagger>

dev.relism.flash.ext.openapi.Ui.Swagger

Enclosing class:

Ui<S extends Ui<S>>

public static final class Ui.Swagger
extends Ui<Ui.Swagger>

Swagger UI, pinned to 5.x.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Ui.Swagger.Expand	How much of the document is open when the page loads.
static enum	Ui.Swagger.Syntax	The highlighter's palette.

Nested classes/interfaces inherited from class dev.relism.flash.ext.openapi.Ui

Ui.Redoc, Ui.Scalar, Ui.Swagger

Method Summary

Modifier and Type	Method	Description
Ui.Swagger	deepLinking(boolean deepLinking)	Whether a tag or an operation gets its own URL.
Ui.Swagger	docExpansion(Ui.Swagger.Expand expand)	Tags open, everything open, or nothing.
Ui.Swagger	filter(boolean filter)	The box that filters operations by tag.
Ui.Swagger	modelsExpandDepth(int depth)	How deep the models open; -1 hides them.
Ui.Swagger	persistAuthorization(boolean persist)	Whether credentials entered in the page survive a reload.
Ui.Swagger	sortAlphabetically(boolean sorted)	Sorts tags and operations by name rather than by the order the document lists them.
Ui.Swagger	syntaxTheme(Ui.Swagger.Syntax theme)
Ui.Swagger	tryItOut(boolean tryItOut)	Whether "Try it out" is already on.

Methods inherited from class dev.relism.flash.ext.openapi.Ui

cdn, customCss, none, option, redoc, scalar, swagger

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

docExpansion

public Ui.Swagger docExpansion(Ui.Swagger.Expand expand)

Tags open, everything open, or nothing. Default: Ui.Swagger.Expand.LIST.

modelsExpandDepth

public Ui.Swagger modelsExpandDepth(int depth)

How deep the models open; -1 hides them. Default: 1.

deepLinking

public Ui.Swagger deepLinking(boolean deepLinking)

Whether a tag or an operation gets its own URL. Default: on, unlike upstream.

filter

public Ui.Swagger filter(boolean filter)

The box that filters operations by tag.

tryItOut

public Ui.Swagger tryItOut(boolean tryItOut)

Whether "Try it out" is already on.

persistAuthorization

public Ui.Swagger persistAuthorization(boolean persist)

Whether credentials entered in the page survive a reload.

syntaxTheme

public Ui.Swagger syntaxTheme(Ui.Swagger.Syntax theme)

sortAlphabetically

public Ui.Swagger sortAlphabetically(boolean sorted)

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