openapi/me.ahoo.wow.openapi/OpenApiOptions

OpenApiOptions

class OpenApiOptions

What the document says beyond the Manifest: the routes the host serves or not, and its error statuses.

title names a service the Manifest does not (me.ahoo.wow.manifest.Manifest.service, a fragment's).
servers are the base URLs of the document's servers; none by default, so a client reads the routes relative to where it fetched the document.
datasets documents the dataset routes (/wow/dataset), which a node serves when it has a dataset backend; manifestEndpoint GET /wow/manifest; openApiEndpoint GET /wow/openapi.
errorStatuses are the statuses the host configures for error codes (wow.http.errors.[<code>].status), which win over the Manifest's tables as they do at the edge.
securitySchemes (withSecuritySchemes) are how a caller presents its identity, which the host fills from its caller resolver: the parts of one identity, presented together.

Fields may be added: pass the constructor's arguments by name.

Constructors

OpenApiOptions

constructor()

The default options; a constructor of its own, as the JVM has it for a class whose arguments all default.

constructor(title: String = DEFAULT_TITLE, servers: List<String> = emptyList(), datasets: Boolean = true, manifestEndpoint: Boolean = true, openApiEndpoint: Boolean = true, errorStatuses: Map<String, Int> = emptyMap())

Types

Companion

object Companion

Properties

datasets

val datasets: Boolean

errorStatuses

val errorStatuses: Map<String, Int>

manifestEndpoint

val manifestEndpoint: Boolean

openApiEndpoint

val openApiEndpoint: Boolean

securitySchemes

val securitySchemes: Map<String, OpenApiSecurityScheme>

How a caller presents its identity, by scheme name: the document's components.securitySchemes, and its global security, one requirement naming them all, since a caller presents them together (the development callers' Wow-* headers). None by default.

servers

val servers: List<String>

title

val title: String

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withSecuritySchemes

fun withSecuritySchemes(schemes: Map<String, OpenApiSecurityScheme>): OpenApiOptions

These options with schemes as the securitySchemes.