HeaderParameter

zio.http.api.openapi.OpenAPI$.Parameter$.HeaderParameter

final case class HeaderParameter(name: String, description: Doc, required: Boolean, deprecated: Boolean, allowEmptyValue: Boolean, definition: Definition, explode: Boolean, examples: Map[String, ExampleOrReference]) extends Parameter

Custom headers that are expected as part of the request. Note that [RFC7230] states header names are case insensitive.

Attributes

allowEmptyValue: Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
deprecated: Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
description: A brief description of the parameter.
name: The name of the parameter. Parameter names are case sensitive.
required: Determines whether this parameter is mandatory.
Graph
Supertypes: trait Serializable
trait Product
trait Equals
trait Parameter
trait ParameterOrReference
class Object
trait Matchable
class Any

Concise view

A unique parameter is defined by a combination of a name and location.

Generated with