Parameter

zio.http.endpoint.openapi.OpenAPI.Parameter
See theParameter companion class
object Parameter

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Parameter.type

Members list

Type members

Classlikes

final case class Content(key: String, mediaType: MediaType)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait PathStyle

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Label.type
object Matrix.type
object Simple.type
sealed trait QueryStyle

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DeepObject.type
object Form.type
object PipeDelimited.type
object SpaceDelimited.type
object Style

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Style.type

Inherited types

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def cookieParameter(name: String, description: Option[Doc], required: Boolean, deprecated: Boolean, definition: Option[ReferenceOr[JsonSchema]], explode: Boolean, examples: Map[String, ReferenceOr[Example]]): Parameter

Used to pass a specific cookie value to the API.

Used to pass a specific cookie value to the API.

Value parameters

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.

Attributes

def headerParameter(name: String, description: Option[Doc], required: Boolean, deprecated: Boolean, definition: Option[ReferenceOr[JsonSchema]], explode: Boolean, examples: Map[String, ReferenceOr[Example]]): Parameter

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

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

Value parameters

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.

Attributes

def pathParameter(name: String, description: Option[Doc], deprecated: Boolean, definition: Option[ReferenceOr[JsonSchema]], style: PathStyle, explode: Boolean, examples: Map[String, ReferenceOr[Example]]): Parameter

Used together with Path Templating, where the parameter value is actually part of the operation’s URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.

Used together with Path Templating, where the parameter value is actually part of the operation’s URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.

Value parameters

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.

Attributes

def queryParameter(name: String, description: Option[Doc], schema: Option[ReferenceOr[JsonSchema]], examples: Map[String, ReferenceOr[Example]], deprecated: Boolean, explode: Boolean, required: Boolean, allowReserved: Boolean, style: QueryStyle): Parameter

Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.

Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.

Value parameters

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.

Attributes

Implicits

Implicits

implicit val schema: Schema[Parameter]