docs/zio.http.api.openapi/OpenAPI/Parameter/PathParameter

PathParameter

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

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.

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

Members list

Concise view

Value members

Concrete methods

Inherited methods

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

Attributes

Definition Classes: Parameter -> Any
Inherited from:: Parameter

Attributes

Inherited from:: Product

Attributes

Inherited from:: Product

Attributes

Definition Classes: Parameter -> OpenAPIBase
Inherited from:: Parameter

Generated with