Package dev.relism.flash.ext.openapi

Class Ui.Scalar

java.lang.Object

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

dev.relism.flash.ext.openapi.Ui.Scalar

Enclosing class:

Ui<S extends Ui<S>>

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Ui.Scalar.Layout	Sidebar and content in two columns, or the one-column classic.
static enum	Ui.Scalar.Sort	What decides the order of the operations in a tag.
static enum	Ui.Scalar.Theme	Scalar's own palettes.

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.Scalar	darkMode(boolean dark)	Dark on load; the reader's toggle still wins unless hideDarkModeToggle(boolean).
Ui.Scalar	defaultOpenAllTags(boolean open)	Every tag open on load, rather than only the first.
Ui.Scalar	hideClientButton(boolean hide)	The button that opens the operation in Scalar's API client.
Ui.Scalar	hideDarkModeToggle(boolean hide)
Ui.Scalar	hideModels(boolean hide)	Whether components.schemas gets a section of its own.
Ui.Scalar	hideSearch(boolean hide)
Ui.Scalar	hideTestRequestButton(boolean hide)	The button that fires the request from the page.
Ui.Scalar	layout(Ui.Scalar.Layout layout)
Ui.Scalar	showSidebar(boolean show)
Ui.Scalar	sortOperationsBy(Ui.Scalar.Sort sort)
Ui.Scalar	theme(Ui.Scalar.Theme theme)

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

theme

public Ui.Scalar theme(Ui.Scalar.Theme theme)

layout

public Ui.Scalar layout(Ui.Scalar.Layout layout)

darkMode

public Ui.Scalar darkMode(boolean dark)

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

hideDarkModeToggle

public Ui.Scalar hideDarkModeToggle(boolean hide)

hideModels

public Ui.Scalar hideModels(boolean hide)

Whether components.schemas gets a section of its own.

hideSearch

public Ui.Scalar hideSearch(boolean hide)

hideTestRequestButton

public Ui.Scalar hideTestRequestButton(boolean hide)

The button that fires the request from the page.

hideClientButton

public Ui.Scalar hideClientButton(boolean hide)

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

showSidebar

public Ui.Scalar showSidebar(boolean show)

defaultOpenAllTags

public Ui.Scalar defaultOpenAllTags(boolean open)

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

sortOperationsBy

public Ui.Scalar sortOperationsBy(Ui.Scalar.Sort sort)