openapi/me.ahoo.wow.openapi/OpenApiSecurityScheme

OpenApiSecurityScheme

How a caller presents its identity to the public routes, as an OpenAPI security scheme: the host declares the schemes of its caller resolver, CoSec's a bearer token, so that a client, Swagger UI's "Try it out" among them, sends the identity.

bearer: Authorization: Bearer <token>, the token's format (JWT) a hint only;
header: an API key in the request header name.

Types

Companion

object Companion

Properties

bearerFormat

val bearerFormat: String?

The format of a bearer token, a hint only: JWT.

description

val description: String?

name

val name: String?

The request header of an apiKey scheme.

scheme

val scheme: String?

The HTTP authorization scheme of an http scheme: bearer.

type

val type: String

The OpenAPI type: http or apiKey.

Functions

equals

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

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String