Type Members

1.  final case class CookieParameter(name: String, description: Doc, required: Boolean, deprecated: Boolean = false, allowEmptyValue: Boolean = false, definition: Definition, explode: Boolean = false, examples: Map[String, ExampleOrReference]) extends Parameter with Product with Serializable

   Used to pass a specific cookie value to the API.

   Used to pass a specific cookie value to the API.

   name

   The name of the parameter. Parameter names are case sensitive.

   description

   A brief description of the parameter.

   required

   Determines whether this parameter is mandatory.

   deprecated

   Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

   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.

2.  sealed trait Definition extends SchemaOrReference
3.  final case class HeaderParameter(name: String, description: Doc, required: Boolean, deprecated: Boolean = false, allowEmptyValue: Boolean = false, definition: Definition, explode: Boolean = false, examples: Map[String, ExampleOrReference]) extends Parameter with Product with Serializable

   Custom headers that are expected as part of the request.

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

   name

   The name of the parameter. Parameter names are case sensitive.

   description

   A brief description of the parameter.

   required

   Determines whether this parameter is mandatory.

   deprecated

   Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

   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.

4.  final case class PathParameter(name: String, description: Doc, required: Boolean, deprecated: Boolean = false, allowEmptyValue: Boolean = false, definition: Definition, style: PathStyle = QueryStyle.Simple, explode: Boolean = false, examples: Map[String, ExampleOrReference]) extends Parameter with Product with Serializable

   Used together with Path Templating, where the parameter value is actually part of the operation’s URL.

   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.

   name

   The name of the parameter. Parameter names are case sensitive.

   description

   A brief description of the parameter.

   required

   Determines whether this parameter is mandatory.

   deprecated

   Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

   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.

5.  sealed trait PathStyle extends AnyRef
6.  final case class QueryParameter(name: String, description: Doc, deprecated: Boolean = false, allowEmptyValue: Boolean = false, definition: Definition, allowReserved: Boolean = false, style: QueryStyle = QueryStyle.Form, explode: Boolean = true, examples: Map[String, ExampleOrReference]) extends Parameter with Product with Serializable

   Parameters that are appended to the URL.

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

   name

   The name of the parameter. Parameter names are case sensitive.

   description

   A brief description of the parameter.

   deprecated

   Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.

   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.

7.  sealed trait QueryStyle extends AnyRef