Packages

c

endpoints4s.openapi.Urls

DocumentedParameter

case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable

name

Name of the parameter

required

Whether this parameter is required or not (MUST be true for path parameters)

Source
Urls.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentedParameter
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema)

    name

    Name of the parameter

    required

    Whether this parameter is required or not (MUST be true for path parameters)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toany2stringadd[DocumentedParameter] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (DocumentedParameter, B)
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toArrowAssoc[DocumentedParameter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. val description: Option[String]
  9. def ensuring(cond: (DocumentedParameter) => Boolean, msg: => Any): DocumentedParameter
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toEnsuring[DocumentedParameter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (DocumentedParameter) => Boolean): DocumentedParameter
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toEnsuring[DocumentedParameter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): DocumentedParameter
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toEnsuring[DocumentedParameter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): DocumentedParameter
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toEnsuring[DocumentedParameter] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val name: String
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val required: Boolean
  22. val schema: Schema
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toStringFormat[DocumentedParameter] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (DocumentedParameter, B)
    Implicit
    This member is added by an implicit conversion from DocumentedParameter toArrowAssoc[DocumentedParameter] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromDocumentedParameter to any2stringadd[DocumentedParameter]

Inherited by implicit conversion StringFormat fromDocumentedParameter to StringFormat[DocumentedParameter]

Inherited by implicit conversion Ensuring fromDocumentedParameter to Ensuring[DocumentedParameter]

Inherited by implicit conversion ArrowAssoc fromDocumentedParameter to ArrowAssoc[DocumentedParameter]

Ungrouped