Responses

Type Members

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
abstract type Response[A]

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

An HTTP response entity carrying an information of type A
implicit class ResponseSyntax[A] extends AnyRef

Extension methods for Response.
abstract type StatusCode

HTTP Status Code
HTTP Status Code

Definition Classes
StatusCodes

Abstract Value Members

abstract def Accepted: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def BadRequest: (Responses.this)#StatusCode

Definition Classes
StatusCodes
Note
You should use the badRequest constructor provided by the Responses trait to ensure that errors produced by endponits are consistently handled by interpreters.
abstract def Created: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def Forbidden: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def InternalServerError: (Responses.this)#StatusCode

Definition Classes
StatusCodes
Note
You should use the internalServerError constructor provided by the Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.
abstract def NoContent: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def NotFound: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def NotImplemented: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def OK: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract def Unauthorized: (Responses.this)#StatusCode

Definition Classes
StatusCodes
abstract 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.
abstract def emptyResponse: (Responses.this)#ResponseEntity[Unit]

Empty response entity
abstract def response[A](statusCode: (Responses.this)#StatusCode, entity: (Responses.this)#ResponseEntity[A], docs: Documentation = None): (Responses.this)#Response[A]

statusCode
Response status code
entity
Response entity
docs
Response documentation Server interpreters construct a response with the given status and entity. Client interpreters accept a response only if it has a corresponding status code.
implicit abstract def responseInvFunctor: InvariantFunctor[(Responses.this)#Response]
abstract def textResponse: (Responses.this)#ResponseEntity[String]

Text response entity

Concrete 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
final def asInstanceOf[T0]: T0

Definition Classes
Any
final def badRequest(docs: Documentation = None): (Responses.this)#Response[(Responses.this)#ClientErrors]

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

See also
endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def internalServerError(docs: Documentation = None): (Responses.this)#Response[(Responses.this)#ServerError]

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

See also
endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def ok[A](entity: (Responses.this)#ResponseEntity[A], docs: Documentation = None): (Responses.this)#Response[A]

OK (200) Response with the given entity
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
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).

Related Doc: package algebra

trait Responses extends StatusCodes with InvariantFunctorSyntax

Type Members

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

abstract type Response[A]

abstract type ResponseEntity[A]

implicit class ResponseSyntax[A] extends AnyRef

abstract type StatusCode

Abstract Value Members

abstract def Accepted: (Responses.this)#StatusCode

abstract def BadRequest: (Responses.this)#StatusCode

abstract def Created: (Responses.this)#StatusCode

abstract def Forbidden: (Responses.this)#StatusCode

abstract def InternalServerError: (Responses.this)#StatusCode

abstract def NoContent: (Responses.this)#StatusCode

abstract def NotFound: (Responses.this)#StatusCode

abstract def NotImplemented: (Responses.this)#StatusCode

abstract def OK: (Responses.this)#StatusCode

abstract def Unauthorized: (Responses.this)#StatusCode

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

abstract def emptyResponse: (Responses.this)#ResponseEntity[Unit]

abstract def response[A](statusCode: (Responses.this)#StatusCode, entity: (Responses.this)#ResponseEntity[A], docs: Documentation = None): (Responses.this)#Response[A]

implicit abstract def responseInvFunctor: InvariantFunctor[(Responses.this)#Response]

abstract def textResponse: (Responses.this)#ResponseEntity[String]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

final def badRequest(docs: Documentation = None): (Responses.this)#Response[(Responses.this)#ClientErrors]

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def internalServerError(docs: Documentation = None): (Responses.this)#Response[(Responses.this)#ServerError]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def ok[A](entity: (Responses.this)#ResponseEntity[A], docs: Documentation = None): (Responses.this)#Response[A]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def wheneverFound[A](responseA: (Responses.this)#Response[A], notFoundDocs: Documentation = None): (Responses.this)#Response[Option[A]]

Inherited from endpoints.InvariantFunctorSyntax

Inherited from StatusCodes

Inherited from AnyRef

Inherited from Any

Ungrouped