Packages

c

endpoints4s.openapi.Responses

DocumentedResponse

case class DocumentedResponse(status: (Responses.this)#StatusCode, documentation: String, headers: (Responses.this)#DocumentedHeaders, content: Map[String, MediaType]) extends Product with Serializable

status

Response status code (e.g. OK or NotFound)

documentation

Human readable documentation. Not optional because its required by openapi

headers

Response headers documentation

content

Map that associates each possible content-type (e.g. “text/html”) with a MediaType description

Source
Responses.scala
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentedResponse
  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 DocumentedResponse(status: (Responses.this)#StatusCode, documentation: String, headers: (Responses.this)#DocumentedHeaders, content: Map[String, MediaType])

    status

    Response status code (e.g. OK or NotFound)

    documentation

    Human readable documentation. Not optional because its required by openapi

    headers

    Response headers documentation

    content

    Map that associates each possible content-type (e.g. “text/html”) with a MediaType description

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 (Responses.this)#DocumentedResponse toany2stringadd[(Responses.this)#DocumentedResponse] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): ((Responses.this)#DocumentedResponse, B)
    Implicit
    This member is added by an implicit conversion from (Responses.this)#DocumentedResponse toArrowAssoc[(Responses.this)#DocumentedResponse] 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 content: Map[String, MediaType]
  9. val documentation: String
  10. def ensuring(cond: ((Responses.this)#DocumentedResponse) => Boolean, msg: => Any): (Responses.this)#DocumentedResponse
    Implicit
    This member is added by an implicit conversion from (Responses.this)#DocumentedResponse toEnsuring[(Responses.this)#DocumentedResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: ((Responses.this)#DocumentedResponse) => Boolean): (Responses.this)#DocumentedResponse
    Implicit
    This member is added by an implicit conversion from (Responses.this)#DocumentedResponse toEnsuring[(Responses.this)#DocumentedResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: => Any): (Responses.this)#DocumentedResponse
    Implicit
    This member is added by an implicit conversion from (Responses.this)#DocumentedResponse toEnsuring[(Responses.this)#DocumentedResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): (Responses.this)#DocumentedResponse
    Implicit
    This member is added by an implicit conversion from (Responses.this)#DocumentedResponse toEnsuring[(Responses.this)#DocumentedResponse] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  16. val headers: (Responses.this)#DocumentedHeaders
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  21. def productElementNames: Iterator[String]
    Definition Classes
    Product
  22. val status: (Responses.this)#StatusCode
  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 (Responses.this)#DocumentedResponse toStringFormat[(Responses.this)#DocumentedResponse] 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): ((Responses.this)#DocumentedResponse, B)
    Implicit
    This member is added by an implicit conversion from (Responses.this)#DocumentedResponse toArrowAssoc[(Responses.this)#DocumentedResponse] 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 from(Responses.this)#DocumentedResponse to any2stringadd[(Responses.this)#DocumentedResponse]

Inherited by implicit conversion StringFormat from(Responses.this)#DocumentedResponse to StringFormat[(Responses.this)#DocumentedResponse]

Inherited by implicit conversion Ensuring from(Responses.this)#DocumentedResponse to Ensuring[(Responses.this)#DocumentedResponse]

Inherited by implicit conversion ArrowAssoc from(Responses.this)#DocumentedResponse to ArrowAssoc[(Responses.this)#DocumentedResponse]

Ungrouped