Packages

t

endpoints4s.play.server

JsonEntitiesFromSchemas

trait JsonEntitiesFromSchemas extends algebra.JsonEntitiesFromSchemas with JsonEntitiesFromCodecs with JsonSchemas

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonEntitiesFromSchemas
  2. JsonSchemas
  3. TuplesSchemas
  4. NoDocsJsonSchemas
  5. JsonEntitiesFromCodecs
  6. EndpointsWithCustomErrors
  7. StatusCodes
  8. Methods
  9. Urls
  10. JsonEntitiesFromCodecs
  11. JsonEntitiesFromSchemas
  12. JsonSchemas
  13. TuplesSchemas
  14. JsonCodecs
  15. JsonEntities
  16. EndpointsWithCustomErrors
  17. Errors
  18. Responses
  19. StatusCodes
  20. Requests
  21. SemigroupalSyntax
  22. Methods
  23. Urls
  24. PartialInvariantFunctorSyntax
  25. InvariantFunctorSyntax
  26. AnyRef
  27. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class Endpoint[A, B](request: Request[A], response: Response[B]) extends Product with Serializable

    Concrete representation of an Endpoint for routing purpose.

    Concrete representation of an Endpoint for routing purpose.

    Definition Classes
    EndpointsWithCustomErrors
  2. case class EndpointWithHandler[A, B](endpoint: Endpoint[A, B], service: (A) ⇒ Future[B]) extends ToPlayHandler with Product with Serializable

    An endpoint from which we can get a Play request handler.

    An endpoint from which we can get a Play request handler.

    Definition Classes
    EndpointsWithCustomErrors
  3. trait Request[A] extends AnyRef

    An HTTP request.

    An HTTP request.

    Has an instance of InvariantFunctor.

    Definition Classes
    EndpointsWithCustomErrors
  4. trait ToPlayHandler extends AnyRef

    Something that can be used as a Play request handler

    Something that can be used as a Play request handler

    Definition Classes
    EndpointsWithCustomErrors
  5. trait UrlAndHeaders[A] extends AnyRef

    The URL and HTTP headers of a request.

    The URL and HTTP headers of a request.

    Definition Classes
    EndpointsWithCustomErrors
  6. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  7. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  8. abstract type ClientErrors
    Definition Classes
    Errors
  9. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  10. type Enum[A] = JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  11. implicit final class EnumOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  12. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  13. type JsonCodec[A] = JsonSchema[A]
    Definition Classes
    JsonEntitiesFromSchemas → JsonCodecs
  14. type JsonRequest[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  15. type JsonResponse[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  16. trait JsonSchema[A] extends AnyRef
    Definition Classes
    JsonSchemas
  17. sealed trait JsonSchemaDocumentationOps[A] extends AnyRef
    Definition Classes
    JsonSchemas
  18. implicit final class JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  19. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  20. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  21. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  22. trait Record[A] extends JsonSchema[A]
    Definition Classes
    JsonSchemas
  23. implicit final class RecordOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  24. type RequestEntity[A] = (RequestHeader) ⇒ Option[BodyParser[A]]

    Decodes a request entity

    Decodes a request entity

    Definition Classes
    EndpointsWithCustomErrors → Requests
  25. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  26. type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

    Convenient type alias modeling the extraction of an A information from request headers.

    Convenient type alias modeling the extraction of an A information from request headers.

    This type has an instance of Applicative.

    Definition Classes
    Urls
  27. type RequestHeaders[A] = (Headers) ⇒ Validated[A]

    An attempt to extract an A from a request headers.

    An attempt to extract an A from a request headers.

    Models failure by returning a Left(result). That makes it possible to early return an HTTP response if a header is wrong (e.g. if an authentication information is missing)

    Definition Classes
    EndpointsWithCustomErrors → Requests
  28. type Response[A] = (A) ⇒ Result

    Turns the A information into a proper Play Result

    Turns the A information into a proper Play Result

    Definition Classes
    EndpointsWithCustomErrors → Responses
  29. type ResponseEntity[A] = (A) ⇒ HttpEntity
    Definition Classes
    EndpointsWithCustomErrors → Responses
  30. type ResponseHeaders[A] = (A) ⇒ Seq[(String, String)]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  31. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  32. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  33. abstract type ServerError
    Definition Classes
    Errors
  34. type StatusCode = play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  35. abstract class Tagged[A] extends Record[A]
    Definition Classes
    JsonSchemas
  36. implicit final class TaggedOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  37. case class Method(value: String) extends Product with Serializable
    Definition Classes
    Methods
  38. implicit final class ApplicativeMapSyntax[F[_], A] extends AnyRef
    Definition Classes
    Urls
  39. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  40. trait QueryString[A] extends AnyRef

    Query string encoding and decoding

    Query string encoding and decoding

    Definition Classes
    Urls
  41. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  42. trait Segment[A] extends AnyRef

    Defines how to decode and encode path segments

    Defines how to decode and encode path segments

    Definition Classes
    Urls
  43. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  3. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  4. abstract val playComponents: PlayComponents
    Definition Classes
    EndpointsWithCustomErrors
  5. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  7. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    Errors

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: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: Method
    Definition Classes
    Methods → Methods
  8. implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler
    Definition Classes
    EndpointsWithCustomErrors
  9. def Forbidden: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  10. def Get: Method
    Definition Classes
    Methods → Methods
  11. def InternalServerError: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def NoContent: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def NotFound: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  14. def NotImplemented: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  15. def OK: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def Options: Method
    Definition Classes
    Methods → Methods
  17. def Patch: Method
    Definition Classes
    Methods → Methods
  18. def PayloadTooLarge: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def Post: Method
    Definition Classes
    Methods → Methods
  20. def Put: Method
    Definition Classes
    Methods → Methods
  21. def TooManyRequests: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def Unauthorized: play.api.mvc.Results.Status
    Definition Classes
    StatusCodes → StatusCodes
  23. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]
    Definition Classes
    Urls
  24. implicit def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], factory: scala.collection.compat.Factory[A, C[A]]): JsonSchema[C[A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  25. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  26. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  27. implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]
    Definition Classes
    JsonSchemas → JsonSchemas
  28. implicit def booleanJsonSchema: JsonSchema[Boolean]
    Definition Classes
    JsonSchemas → JsonSchemas
  29. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  30. implicit def byteJsonSchema: JsonSchema[Byte]
    Definition Classes
    JsonSchemas → JsonSchemas
  31. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  32. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  33. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  34. def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]
    Definition Classes
    JsonSchemas → JsonSchemas
  35. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  36. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  37. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  38. def defaultDiscriminatorName: String
    Definition Classes
    JsonSchemas
  39. implicit final def defaultStringJsonSchema: JsonSchema[String]
    Definition Classes
    JsonSchemas
  40. 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
  41. implicit def doubleJsonSchema: JsonSchema[Double]
    Definition Classes
    JsonSchemas → JsonSchemas
  42. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  43. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  44. lazy val emptyRecord: Record[Unit]
    Definition Classes
    JsonSchemas → JsonSchemas
  45. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  46. lazy val emptyRequestHeaders: RequestHeaders[Unit]

    Always succeeds in extracting no information from the headers

    Always succeeds in extracting no information from the headers

    Definition Classes
    EndpointsWithCustomErrors → Requests
  47. def emptyResponse: ResponseEntity[Unit]

    An empty response entity

    An empty response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  48. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  49. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  50. def enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  51. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  53. def extractMethodUrlAndHeaders[A, B](method: Method, url: Url[A], headers: RequestHeaders[B]): UrlAndHeaders[(A, B)]
    Attributes
    protected
    Definition Classes
    EndpointsWithCustomErrors
  54. def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  55. implicit def floatJsonSchema: JsonSchema[Float]
    Definition Classes
    JsonSchemas → JsonSchemas
  56. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]
    Definition Classes
    Urls
  57. 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
  58. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  59. def handleClientErrors(invalid: Invalid): Result

    This method is called by endpoints when decoding a request failed.

    This method is called by endpoints when decoding a request failed.

    The provided implementation calls clientErrorsResponse to construct a response containing the errors.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    Urls
  60. def handleServerError(throwable: Throwable): Result

    This method is called by endpoints when an exception is thrown during request processing.

    This method is called by endpoints when an exception is thrown during request processing.

    The provided implementation calls serverErrorResponse to construct a response containing the error message.

    This method can be overridden to customize the error reporting logic.

    Definition Classes
    EndpointsWithCustomErrors
  61. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  62. lazy val htmlResponse: ResponseEntity[Html]

    A successful HTTP response (status code 200) with an HTML entity

    A successful HTTP response (status code 200) with an HTML entity

    Definition Classes
    EndpointsWithCustomErrors
  63. implicit def intJsonSchema: JsonSchema[Int]
    Definition Classes
    JsonSchemas → JsonSchemas
  64. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  65. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  66. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  67. implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors
  68. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  69. def jsonRequest[A](implicit codec: JsonCodec[A]): RequestEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  70. def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  71. implicit def jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]
    Definition Classes
    JsonSchemas → JsonSchemas
  72. def lazyRecord[A](schema: ⇒ Record[A], name: String): JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  73. def lazyTagged[A](schema: ⇒ Tagged[A], name: String): JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  74. final def literal[A](value: A)(implicit tpe: JsonSchema[A]): JsonSchema[Unit]
    Definition Classes
    JsonSchemas
  75. implicit def longJsonSchema: JsonSchema[Long]
    Definition Classes
    JsonSchemas → JsonSchemas
  76. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  77. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  78. implicit def mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  79. def namedEnum[A](enumeration: Enum[A], name: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  80. def namedRecord[A](record: Record[A], name: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  81. def namedTagged[A](tagged: Tagged[A], name: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  82. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  83. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  84. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  85. 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
  86. def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  87. def optRequestHeader(name: String, docs: Option[String]): (Headers) ⇒ Validated[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  88. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  89. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  90. def orElseMergeTagged[A, C >: A, B <: C](taggedA: Tagged[A], taggedB: Tagged[B])(implicit arg0: ClassTag[A], arg1: ClassTag[B]): Tagged[C]
    Definition Classes
    JsonSchemas
  91. def orFallbackToJsonSchema[A, B](schemaA: JsonSchema[A], schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]
    Definition Classes
    JsonSchemas → JsonSchemas
  92. final def patch[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
  93. val path: Path[Unit]
    Definition Classes
    Urls
  94. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  95. 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
  96. 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
  97. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  98. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  99. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  100. implicit def recordPartialInvFunctor: PartialInvariantFunctor[Record]
    Definition Classes
    JsonSchemas → JsonSchemas
  101. def redirect[A](other: ⇒ Endpoint[A, _])(args: A): Response[Unit]

    other

    Endpoint to redirect to

    args

    Arguments to pass to the endpoint to generate its URL

    returns

    An HTTP response redirecting to another endpoint (using 303 code status).

    Definition Classes
    EndpointsWithCustomErrors
  102. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  103. 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
  104. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Decodes a request.

    Decodes a request.

    url

    Request URL

    entity

    Request entity

    docs

    Request documentation

    headers

    Request headers

    Definition Classes
    EndpointsWithCustomErrors → Requests
  105. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  106. def requestHeader(name: String, docs: Option[String]): (Headers) ⇒ Validated[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  107. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  108. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  109. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  110. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  112. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  113. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  114. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  115. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  116. def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

    Builds a Play router out of endpoint definitions.

    Builds a Play router out of endpoint definitions.

    val routes = routesFromEndpoints(
  inc.implementedBy(x => x + 1)
)
    Definition Classes
    EndpointsWithCustomErrors
  117. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  118. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  119. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  120. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  121. def stringCodec[A](implicit codec: JsonCodec[A]): Codec[String, A]
    Definition Classes
    JsonEntitiesFromSchemas → JsonEntitiesFromCodecs
  122. final def stringEnumeration[A](values: Seq[A])(encode: (A) ⇒ String)(implicit tpe: JsonSchema[String]): Enum[A]
    Definition Classes
    JsonSchemas
  123. def stringJsonSchema(format: Option[String]): JsonSchema[String]
    Definition Classes
    JsonSchemas → JsonSchemas
  124. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  125. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  126. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  127. implicit def taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]
    Definition Classes
    JsonSchemas → JsonSchemas
  128. def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  129. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  130. def textResponse: ResponseEntity[String]

    A text entity

    A text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  131. def toString(): String
    Definition Classes
    AnyRef → Any
  132. implicit def tuple10JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  133. implicit def tuple11JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  134. implicit def tuple12JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  135. implicit def tuple13JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  136. implicit def tuple14JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  137. implicit def tuple15JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  138. implicit def tuple16JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  139. implicit def tuple17JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  140. implicit def tuple18JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  141. implicit def tuple19JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  142. implicit def tuple20JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  143. implicit def tuple21JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  144. implicit def tuple22JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21], schema22: JsonSchema[T22]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  145. implicit def tuple2JsonSchema[T1, T2](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2]): JsonSchema[(T1, T2)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  146. implicit def tuple3JsonSchema[T1, T2, T3](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3]): JsonSchema[(T1, T2, T3)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  147. implicit def tuple4JsonSchema[T1, T2, T3, T4](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4]): JsonSchema[(T1, T2, T3, T4)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  148. implicit def tuple5JsonSchema[T1, T2, T3, T4, T5](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5]): JsonSchema[(T1, T2, T3, T4, T5)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  149. implicit def tuple6JsonSchema[T1, T2, T3, T4, T5, T6](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6]): JsonSchema[(T1, T2, T3, T4, T5, T6)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  150. implicit def tuple7JsonSchema[T1, T2, T3, T4, T5, T6, T7](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  151. implicit def tuple8JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  152. implicit def tuple9JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  153. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  154. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  155. val utf8Name: String
    Definition Classes
    Urls
  156. implicit final lazy val uuidJsonSchema: JsonSchema[UUID]
    Definition Classes
    JsonSchemas
  157. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  158. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  159. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  160. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  161. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  162. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  163. def withDescriptionEnum[A](enumeration: Enum[A], description: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  164. def withDescriptionJsonSchema[A](schema: JsonSchema[A], description: String): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  165. def withDescriptionRecord[A](record: Record[A], description: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  166. def withDescriptionTagged[A](tagged: Tagged[A], description: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  167. def withDiscriminatorTagged[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  168. def withExampleEnum[A](enumeration: Enum[A], example: A): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  169. def withExampleJsonSchema[A](schema: JsonSchema[A], example: A): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  170. def withExampleRecord[A](record: Record[A], example: A): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  171. def withExampleTagged[A](tagged: Tagged[A], example: A): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  172. def withTitleEnum[A](enumeration: Enum[A], title: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  173. def withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  174. def withTitleRecord[A](record: Record[A], title: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  175. def withTitleTagged[A](tagged: Tagged[A], title: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  176. def zipRecords[A, B](recordA: Record[A], recordB: Record[B])(implicit t: Tupler[A, B]): Record[Out]
    Definition Classes
    JsonSchemas → JsonSchemas
  177. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from JsonSchemas

Inherited from TuplesSchemas

Inherited from NoDocsJsonSchemas

Inherited from JsonEntitiesFromCodecs

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.JsonEntitiesFromCodecs

Inherited from algebra.JsonEntitiesFromSchemas

Inherited from JsonSchemas

Inherited from TuplesSchemas

Inherited from JsonCodecs

Inherited from JsonEntities

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped