APIKey

zio.blocks.openapi.SecurityScheme.APIKey
final case class APIKey(name: String, in: APIKeyLocation, description: Option[Doc] = ..., extensions: ChunkMap[String, Json] = ...) extends SecurityScheme

API key authentication.

Value parameters

description

A description for security scheme. CommonMark syntax MAY be used for rich text representation.

extensions

Specification extensions (x-* fields). These allow adding additional properties beyond the standard OpenAPI fields.

in

REQUIRED. The location of the API key.

name

REQUIRED. The name of the header, query or cookie parameter to be used.

Attributes

Source
OpenAPI.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Inherited methods

def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
Source
Product.scala
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Source
Product.scala