ApiKey

zio.http.api.openapi.OpenAPI$.SecurityScheme$.ApiKey
See theApiKey companion object
final case class ApiKey(description: Doc, name: String, in: In) extends SecurityScheme

Defines an HTTP security scheme that can be used by the operations.

Attributes

description

A short description for security scheme.

in

The location of the API key.

name

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

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def `type`: String

Attributes

Definition Classes
override def toJson: String

Attributes

Definition Classes
OpenAPIBase

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product