Packages

trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. BuiltInErrors
  3. EndpointsWithCustomErrors
  4. Responses
  5. StatusCodes
  6. Requests
  7. Methods
  8. Urls
  9. Endpoints
  10. BuiltInErrors
  11. EndpointsWithCustomErrors
  12. Errors
  13. Responses
  14. StatusCodes
  15. Requests
  16. SemigroupalSyntax
  17. Methods
  18. Urls
  19. PartialInvariantFunctorSyntax
  20. InvariantFunctorSyntax
  21. AnyRef
  22. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class CallbackDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. type ClientErrors = Invalid
    Definition Classes
    BuiltInErrors → Errors
  4. case class EndpointDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  5. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  6. type Method = String
    Definition Classes
    Methods → Methods
  7. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  8. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  9. type QueryString[A] = (A) ⇒ Seq[(String, String)]
    Definition Classes
    Urls → Urls
  10. type QueryStringParam[A] = (A) ⇒ List[String]
    Definition Classes
    Urls → Urls
  11. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  12. type Request[A] = (A) ⇒ HttpRequest
    Definition Classes
    Requests → Requests
  13. type RequestEntity[A] = (A, HttpRequest) ⇒ HttpRequest
    Definition Classes
    Requests → Requests
  14. type RequestHeaders[A] = (A) ⇒ Seq[(String, String)]
    Definition Classes
    Requests → Requests
  15. type Response[A] = (HttpResponse[String]) ⇒ Option[ResponseEntity[A]]
    Definition Classes
    Responses → Responses
  16. type ResponseEntity[A] = (String) ⇒ Either[Throwable, A]
    Definition Classes
    Responses → Responses
  17. type ResponseHeaders[A] = (Map[String, Seq[String]]) ⇒ Validated[A]
    Definition Classes
    Responses → Responses
  18. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  19. type Segment[A] = (A) ⇒ String
    Definition Classes
    Urls → Urls
  20. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  21. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  22. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  23. case class Endpoint[Req, Resp](request: EndpointsWithCustomErrors.Request[Req], response: EndpointsWithCustomErrors.Response[Resp]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  24. case class Path[A](toStr: (A) ⇒ String) extends Url[A] with Product with Serializable
    Definition Classes
    Urls
  25. class Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. abstract def address: String
    Definition Classes
    Urls

Concrete 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. def Accepted: Int
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: Int
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: Method
    Definition Classes
    Methods → Methods
  8. def Forbidden: Int
    Definition Classes
    StatusCodes → StatusCodes
  9. def Get: Method
    Definition Classes
    Methods → Methods
  10. def InternalServerError: Int
    Definition Classes
    StatusCodes → StatusCodes
  11. def NoContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  12. def NotFound: Int
    Definition Classes
    StatusCodes → StatusCodes
  13. def NotImplemented: Int
    Definition Classes
    StatusCodes → StatusCodes
  14. def OK: Int
    Definition Classes
    StatusCodes → StatusCodes
  15. def Options: Method
    Definition Classes
    Methods → Methods
  16. def Patch: Method
    Definition Classes
    Methods → Methods
  17. def Post: Method
    Definition Classes
    Methods → Methods
  18. def Put: Method
    Definition Classes
    Methods → Methods
  19. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  20. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  21. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  22. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  23. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  24. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    Responses → Responses
  25. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  26. def clientErrorsResponseEntity: ResponseEntity[Invalid]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  27. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  28. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  29. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  30. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  31. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  32. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  33. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
    Definition Classes
    Urls
  34. def emptyHeaders: RequestHeaders[Unit]
    Definition Classes
    Requests → Requests
  35. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    Requests → Requests
  36. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    Responses → Responses
  37. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    Responses → Responses
  38. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  39. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  41. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  42. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  45. def header(name: String, docs: Documentation): (String) ⇒ Seq[(String, String)]
    Definition Classes
    Requests → Requests
  46. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  47. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  48. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  49. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  50. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  51. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  52. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  55. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  56. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses
  57. def optHeader(name: String, docs: Documentation): (Option[String]) ⇒ Seq[(String, String)]
    Definition Classes
    Requests → Requests
  58. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    Responses → Responses
  59. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  60. val path: Path[Unit]
    Definition Classes
    Urls
  61. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  62. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  63. def protocol: String
    Definition Classes
    Urls
  64. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  65. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  66. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  67. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  68. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  69. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  70. implicit def reqEntityInvFunctor: InvariantFunctor[RequestEntity]
    Definition Classes
    Requests → Requests
  71. implicit def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
    Definition Classes
    Requests → Requests
  72. implicit def reqHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Requests → Requests
  73. def request[U, E, H, UE, Out](method: Method, url: Url[U], entity: RequestEntity[E] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[H] = emptyHeaders)(implicit tuplerUE: Tupler.Aux[U, E, UE], tuplerUEH: Tupler.Aux[UE, H, Out]): Request[Out]
    Definition Classes
    Requests → Requests
  74. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses → Responses
  75. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    Responses → Responses
  76. implicit def responseHeadersInvFunctor: PartialInvariantFunctor[ResponseHeaders]
    Definition Classes
    Responses → Responses
  77. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    Responses → Responses
  78. implicit lazy val responseInvFunctor: InvariantFunctor[Response]
    Definition Classes
    Responses → Responses
  79. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  80. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  81. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  82. def serverErrorResponseEntity: ResponseEntity[Throwable]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  83. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  84. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  85. implicit def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  86. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  87. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  88. def textRequest: (String, HttpRequest) ⇒ HttpRequest
    Definition Classes
    Requests → Requests
  89. def textResponse: ResponseEntity[String]
    Definition Classes
    Responses → Responses
  90. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  91. def toString(): String
    Definition Classes
    AnyRef → Any
  92. def tryParseString[A](type: String)(parse: (String) ⇒ A): (String) ⇒ Validated[A]
    Definition Classes
    Urls
  93. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  94. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Builds an URL from the given path and query string

    Builds an URL from the given path and query string

    Definition Classes
    Urls → Urls
  95. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  96. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  97. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  98. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  99. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  100. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

Inherited from BuiltInErrors

Inherited from EndpointsWithCustomErrors

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from algebra.BuiltInErrors

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped