HTTP

zio.blocks.openapi.SecurityScheme.HTTP
final case class HTTP(scheme: String, bearerFormat: Option[String] = ..., description: Option[Doc] = ..., extensions: ChunkMap[String, Json] = ...) extends SecurityScheme

HTTP authentication scheme (Bearer, Basic, etc.).

Value parameters

bearerFormat

A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.

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.

scheme

REQUIRED. The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235. The values used SHOULD be registered in the IANA Authentication Scheme registry.

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