docs
API
Generated with
docs/zio.http/zio.http.endpoint/zio.http.endpoint.openapi/OpenAPI/Parameter

Parameter

zio.http.endpoint.openapi.OpenAPI$.Parameter$
See theParameter companion trait
object Parameter

Attributes

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

Members list

Type members

Classlikes

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

Used to pass a specific cookie value to the API.

Used to pass a specific cookie value to the API.

Value parameters

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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parameter
class Object
trait Matchable
class Any
Show all
object Definition

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Definition.type
sealed trait Definition extends SchemaOrReference

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class Content
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.

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

Value parameters

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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parameter
class Object
trait Matchable
class Any
Show all
final case class PathParameter(name: String, description: Doc, required: Boolean, deprecated: Boolean, allowEmptyValue: Boolean, definition: Definition, style: PathStyle, explode: Boolean, examples: Map[String, ExampleOrReference]) extends 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

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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parameter
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
final case class QueryParameter(name: String, description: Doc, deprecated: Boolean, allowEmptyValue: Boolean, definition: Definition, allowReserved: Boolean, style: QueryStyle, explode: Boolean, examples: Map[String, ExampleOrReference]) extends 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

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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Parameter
class Object
trait Matchable
class Any
Show all
object QueryStyle

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
QueryStyle.type
sealed trait QueryStyle

Attributes

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

Inherited types

type MirroredElemLabels <: Tuple

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
Generated with