object Parameter extends Serializable

Linear Supertypes
Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Parameter
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final case class Content(key: String, mediaType: MediaType) extends Product with Serializable
  2. sealed trait PathStyle extends AnyRef
  3. sealed trait QueryStyle extends AnyRef

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. def cookieParameter(name: String, description: Option[Doc], required: Boolean, deprecated: Boolean = false, definition: Option[ReferenceOr[JsonSchema]] = None, explode: Boolean = false, 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.

    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.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def headerParameter(name: String, description: Option[Doc], required: Boolean, deprecated: Boolean = false, definition: Option[ReferenceOr[JsonSchema]] = None, explode: Boolean = false, examples: Map[String, ReferenceOr[Example]]): Parameter

    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.

  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. def pathParameter(name: String, description: Option[Doc], deprecated: Boolean = false, definition: Option[ReferenceOr[JsonSchema]] = None, style: PathStyle = Style.Simple, explode: Boolean = false, examples: Map[String, ReferenceOr[Example]]): Parameter

    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.

    deprecated

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

  17. def queryParameter(name: String, description: Option[Doc], schema: Option[ReferenceOr[JsonSchema]], examples: Map[String, ReferenceOr[Example]], deprecated: Boolean = false, explode: Boolean = true, required: Boolean = false, allowReserved: Boolean = false, style: QueryStyle = Style.Form): Parameter

    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.

  18. implicit val schema: Schema[Parameter]
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. object Style

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped