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. 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.
- Alphabetic
- By Inheritance
- QueryParameter
- Serializable
- Product
- Equals
- Parameter
- ParameterOrReference
- OpenAPIBase
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new 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])
- 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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val allowEmptyValue: Boolean
- Definition Classes
- QueryParameter → Parameter
- val allowReserved: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val definition: Definition
- Definition Classes
- QueryParameter → Parameter
- val deprecated: Boolean
- Definition Classes
- QueryParameter → Parameter
- val description: Doc
- Definition Classes
- QueryParameter → Parameter
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(obj: Any): Boolean
A unique parameter is defined by a combination of a name and location.
A unique parameter is defined by a combination of a name and location.
- Definition Classes
- Parameter → AnyRef → Any
- val examples: Map[String, ExampleOrReference]
- Definition Classes
- QueryParameter → Parameter
- val explode: Boolean
- Definition Classes
- QueryParameter → Parameter
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def in: String
- Definition Classes
- QueryParameter → Parameter
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val name: String
- Definition Classes
- QueryParameter → Parameter
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def required: Boolean
- Definition Classes
- QueryParameter → Parameter
- val style: QueryStyle
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toJson: String
- Definition Classes
- Parameter → OpenAPIBase
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])