Packages

trait Responses extends algebra.Responses with StatusCodes with Headers

Interpreter for algebra.Responses

Self Type
Responses with Errors
Source
Responses.scala
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Responses
  2. Headers
  3. StatusCodes
  4. Responses
  5. InvariantFunctorSyntax
  6. StatusCodes
  7. AnyRef
  8. 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

Type Members

  1. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

    Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

    Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

    Definition Classes
    InvariantFunctorSyntax
  2. implicit class ResponseSyntax[A] extends AnyRef

    Extension methods for Response.

    Extension methods for Response.

    Definition Classes
    Responses
  3. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
    Definition Classes
    Headers
  4. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

    List of request header names (e.g. “Authorization”)

    Definition Classes
    Headers
  5. 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

  6. type Response[A] = List[(Responses.this)#DocumentedResponse]

    An HTTP response (status, headers, and entity) carrying an information of type A

    An HTTP response (status, headers, and entity) carrying an information of type A

    Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

    Definition Classes
    ResponsesResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes

  7. type ResponseEntity[A] = Map[String, MediaType]

    An HTTP response entity carrying an information of type A

    An HTTP response entity carrying an information of type A

    Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

    Definition Classes
    ResponsesResponses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax class

  8. type ResponseHeaders[A] = (Responses.this)#DocumentedHeaders

    Information carried by responses’ headers.

    Information carried by responses’ headers.

    You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

    Definition Classes
    ResponsesResponses
    Note

    This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.

  9. type StatusCode = Int

    HTTP Status Code

    HTTP Status Code

    Definition Classes
    StatusCodesStatusCodes

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 toany2stringadd[Responses] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Responses, B)
    Implicit
    This member is added by an implicit conversion from Responses toArrowAssoc[Responses] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def Accepted: Int

    Definition Classes
    StatusCodesStatusCodes
  7. def AlreadyReported: Int

    Definition Classes
    StatusCodesStatusCodes
  8. def BadRequest: Int

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the badRequest constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

  9. def Conflict: Int

    Definition Classes
    StatusCodesStatusCodes
  10. def Created: Int

    Definition Classes
    StatusCodesStatusCodes
  11. def ExpectationFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  12. def FailedDependency: Int

    Definition Classes
    StatusCodesStatusCodes
  13. def Forbidden: Int

    Definition Classes
    StatusCodesStatusCodes
  14. def Gone: Int

    Definition Classes
    StatusCodesStatusCodes
  15. def IMUsed: Int

    Definition Classes
    StatusCodesStatusCodes
  16. def InternalServerError: Int

    Definition Classes
    StatusCodesStatusCodes
    Note

    You should use the internalServerError constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

  17. def LengthRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  18. def Locked: Int

    Definition Classes
    StatusCodesStatusCodes
  19. def MethodNotAllowed: Int

    Definition Classes
    StatusCodesStatusCodes
  20. def MisdirectedRequest: Int

    Definition Classes
    StatusCodesStatusCodes
  21. def MultiStatus: Int

    Definition Classes
    StatusCodesStatusCodes
  22. def NoContent: Int

    Definition Classes
    StatusCodesStatusCodes
  23. def NonAuthoritativeInformation: Int

    Definition Classes
    StatusCodesStatusCodes
  24. def NotAcceptable: Int

    Definition Classes
    StatusCodesStatusCodes
  25. def NotFound: Int

    Definition Classes
    StatusCodesStatusCodes
  26. def NotImplemented: Int

    Definition Classes
    StatusCodesStatusCodes
  27. def NotModified: Int

    Definition Classes
    StatusCodesStatusCodes
  28. def OK: Int

    Definition Classes
    StatusCodesStatusCodes
  29. def PartialContent: Int

    Definition Classes
    StatusCodesStatusCodes
  30. def PayloadTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  31. def PaymentRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  32. def PreconditionFailed: Int

    Definition Classes
    StatusCodesStatusCodes
  33. def PreconditionRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  34. def ProxyAuthenticationRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  35. def RangeNotSatisfiable: Int

    Definition Classes
    StatusCodesStatusCodes
  36. def RequestHeaderFieldsTooLarge: Int

    Definition Classes
    StatusCodesStatusCodes
  37. def RequestTimeout: Int

    Definition Classes
    StatusCodesStatusCodes
  38. def ResetContent: Int

    Definition Classes
    StatusCodesStatusCodes
  39. def TooEarly: Int

    Definition Classes
    StatusCodesStatusCodes
  40. def TooManyRequests: Int

    Definition Classes
    StatusCodesStatusCodes
  41. def Unauthorized: Int

    Definition Classes
    StatusCodesStatusCodes
  42. def UnavailableForLegalReasons: Int

    Definition Classes
    StatusCodesStatusCodes
  43. def UnprocessableEntity: Int

    Definition Classes
    StatusCodesStatusCodes
  44. def UnsupportedMediaType: Int

    Definition Classes
    StatusCodesStatusCodes
  45. def UpgradeRequired: Int

    Definition Classes
    StatusCodesStatusCodes
  46. def UriTooLong: Int

    Definition Classes
    StatusCodesStatusCodes
  47. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  48. final def badRequest[A, R](docs: Documentation = None, headers: (Responses.this)#ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[(Responses.this)#ClientErrors, A, R]): (Responses.this)#Response[R]

    Bad Request (400) response, with an entity of type ClientErrors.

    Bad Request (400) response, with an entity of type ClientErrors.

    Definition Classes
    Responses
    See also

    endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors

  49. def choiceResponse[A, B](responseA: (Responses.this)#Response[A], responseB: (Responses.this)#Response[B]): (Responses.this)#Response[Either[A, B]]

    Alternative between two possible choices of responses.

    Alternative between two possible choices of responses.

    Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.

    Definition Classes
    ResponsesResponses
  50. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  51. def emptyResponse: (Responses.this)#ResponseEntity[Unit]

    Empty response entity

    Empty response entity

    • Server interpreters produce no response entity,
    • Client interpreters ignore the response entity.
    Definition Classes
    ResponsesResponses
  52. def emptyResponseHeaders: (Responses.this)#ResponseHeaders[Unit]

    No particular response header.

    No particular response header.

    • Client interpreters should ignore information carried by response headers.
    Definition Classes
    ResponsesResponses
  53. def ensuring(cond: (Responses) => Boolean, msg: => Any): Responses
    Implicit
    This member is added by an implicit conversion from Responses toEnsuring[Responses] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  54. def ensuring(cond: (Responses) => Boolean): Responses
    Implicit
    This member is added by an implicit conversion from Responses toEnsuring[Responses] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  55. def ensuring(cond: Boolean, msg: => Any): Responses
    Implicit
    This member is added by an implicit conversion from Responses toEnsuring[Responses] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  56. def ensuring(cond: Boolean): Responses
    Implicit
    This member is added by an implicit conversion from Responses toEnsuring[Responses] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  57. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  58. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  59. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Responses toStringFormat[Responses] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  60. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  61. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. final def internalServerError[A, R](docs: Documentation = None, headers: (Responses.this)#ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[(Responses.this)#ServerError, A, R]): (Responses.this)#Response[R]

    Internal Server Error (500) response, with an entity of type ServerError.

    Internal Server Error (500) response, with an entity of type ServerError.

    Definition Classes
    Responses
    See also

    endpoints4s.algebra.Errors and endpoints4s.algebra.BuiltInErrors

  63. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  64. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  66. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  67. final def ok[A, B, R](entity: (Responses.this)#ResponseEntity[A], docs: Documentation = None, headers: (Responses.this)#ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): (Responses.this)#Response[R]

    OK (200) Response with the given entity

    OK (200) Response with the given entity

    Definition Classes
    Responses
  68. def optResponseHeader(name: String, docs: Documentation = None): (Responses.this)#ResponseHeaders[Option[String]]

    Response headers optionally containing a header with the given name.

    Response headers optionally containing a header with the given name.

    • Client interpreters should model the header value as Some[String], or None if the response header is missing.
    • Server interpreters should produce such a response header.
    • Documentation interpreters should document this header.
    Definition Classes
    ResponsesResponses
  69. def response[A, B, R](statusCode: (Responses.this)#StatusCode, entity: (Responses.this)#ResponseEntity[A], docs: Documentation = None, headers: (Responses.this)#ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): (Responses.this)#Response[R]

    Define an HTTP response

    Define an HTTP response

    • Server interpreters construct a response with the given status and entity.
    • Client interpreters accept a response only if it has a corresponding status code.
    statusCode

    Response status code

    entity

    Response entity

    docs

    Response documentation

    headers

    Response headers

    Definition Classes
    ResponsesResponses
  70. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[(Responses.this)#ResponseEntity]
    Definition Classes
    ResponsesResponses
  71. def responseHeader(name: String, docs: Documentation = None): (Responses.this)#ResponseHeaders[String]

    Response headers containing a header with the given name.

    Response headers containing a header with the given name.

    • Client interpreters should model the header value as String, or fail if the response header is missing.
    • Server interpreters should produce such a response header.
    • Documentation interpreters should document this header.

    Example:

    val versionedResource: Endpoint[Unit, (SomeResource, String)] =
      endpoint(
        get(path / "versioned-resource"),
        ok(
          jsonResponse[SomeResource],
          headers = responseHeader("ETag")
        )
      )
    Definition Classes
    ResponsesResponses
  72. implicit def responseHeadersInvariantFunctor: InvariantFunctor[(Responses.this)#ResponseHeaders]

    Provides xmap operation.

    Provides xmap operation.

    Definition Classes
    ResponsesResponses
    See also

    InvariantFunctorSyntax

  73. implicit def responseHeadersSemigroupal: Semigroupal[(Responses.this)#ResponseHeaders]

    Provides ++ operation.

    Provides ++ operation.

    Definition Classes
    ResponsesResponses
    See also

    SemigroupalSyntax

  74. implicit lazy val responseInvariantFunctor: InvariantFunctor[(Responses.this)#Response]

    Provides the operation xmap to the type Response

    Provides the operation xmap to the type Response

    Definition Classes
    ResponsesResponses
    See also

    InvariantFunctorSyntax

  75. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  76. def textResponse: (Responses.this)#ResponseEntity[String]

    Text response entity

    Text response entity

    • Server interpreters produce an HTTP response with a text/plain content type.
    Definition Classes
    ResponsesResponses
  77. def toString(): String
    Definition Classes
    AnyRef → Any
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  80. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  81. final def wheneverFound[A](responseA: (Responses.this)#Response[A], notFoundDocs: Documentation = None): (Responses.this)#Response[Option[A]]

    Turns a Response[A] into a Response[Option[A]].

    Turns a Response[A] into a Response[Option[A]].

    Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).

    Definition Classes
    Responses

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated
  2. def [B](y: B): (Responses, B)
    Implicit
    This member is added by an implicit conversion from Responses toArrowAssoc[Responses] 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 Headers

Inherited from StatusCodes

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromResponses to any2stringadd[Responses]

Inherited by implicit conversion StringFormat fromResponses to StringFormat[Responses]

Inherited by implicit conversion Ensuring fromResponses to Ensuring[Responses]

Inherited by implicit conversion ArrowAssoc fromResponses to ArrowAssoc[Responses]

Types

Types introduced by the algebra

Operations

Operations creating and transforming values

Ungrouped