Trait

endpoints.play.server.circe

JsonSchemaEntities

Related Doc: package circe

Permalink

trait JsonSchemaEntities extends Endpoints with algebra.JsonSchemaEntities with JsonSchemas

Interpreter for algebra.JsonEntities that uses circe’s io.circe.Decoder to decode JSON entities in HTTP requests, and circe’s io.circe.Encoder to build JSON entities in HTTP responses.

Source
JsonSchemaEntities.scala
Linear Supertypes
JsonSchemas, algebra.JsonSchemaEntities, JsonSchemas, algebra.JsonEntities, Endpoints, StatusCodes, Methods, Urls, algebra.Endpoints, Responses, algebra.StatusCodes, Requests, endpoints.SemigroupalSyntax, endpoints.PartialInvariantFunctorSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonSchemaEntities
  2. JsonSchemas
  3. JsonSchemaEntities
  4. JsonSchemas
  5. JsonEntities
  6. Endpoints
  7. StatusCodes
  8. Methods
  9. Urls
  10. Endpoints
  11. Responses
  12. StatusCodes
  13. Requests
  14. SemigroupalSyntax
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. Methods
  18. Urls
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink
    Definition Classes
    Urls

  2. case class Endpoint[A, B] extends Product with Serializable

    Permalink
    Definition Classes
    Endpoints

  3. case class EndpointWithHandler[A, B] extends ToPlayHandler with Product with Serializable

    Permalink
    Definition Classes
    Endpoints

  4. type Enum[A] = JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

  6. type JsonRequest[A] = JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  7. type JsonResponse[A] = JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  8. trait JsonSchema[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  9. implicit final class JsonSchemaOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  10. case class Method extends Product with Serializable

    Permalink
    Definition Classes
    Methods

  11. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    PartialInvariantFunctorSyntax

  12. trait Path[A] extends Url[A]

    Permalink
    Definition Classes
    Urls

  13. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  14. trait QueryString[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  15. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  16. trait QueryStringParam[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  17. trait Record[A] extends JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas

  18. implicit final class RecordOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  19. trait Request[A] extends AnyRef

    Permalink
    Definition Classes
    Endpoints

  20. type RequestEntity[A] = BodyParser[A]

    Permalink
    Definition Classes
    Endpoints → Requests

  21. type RequestExtractor[A] = (RequestHeader) ⇒ Option[A]

    Permalink
    Definition Classes
    Urls

  22. type RequestHeaders[A] = (Headers) ⇒ Either[Result, A]

    Permalink
    Definition Classes
    Endpoints → Requests

  23. type Response[A] = (A) ⇒ Result

    Permalink
    Definition Classes
    Endpoints → Responses

  24. implicit class ResponseExtensions[A] extends AnyRef

    Permalink
    Definition Classes
    Responses

  25. trait Segment[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  26. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

    Permalink
    Definition Classes
    SemigroupalSyntax

  27. type StatusCode = play.api.mvc.Results.Status

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  28. trait Tagged[A] extends Record[A]

    Permalink
    Definition Classes
    JsonSchemas

  29. implicit final class TaggedOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  30. trait ToPlayHandler extends AnyRef

    Permalink
    Definition Classes
    Endpoints

  31. trait Url[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  32. trait UrlAndHeaders[A] extends AnyRef

    Permalink
    Definition Classes
    Endpoints

Abstract Value Members

  1. abstract val playComponents: PlayComponents

    Permalink
    Attributes
    protected
    Definition Classes
    Endpoints

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def BadRequest: play.api.mvc.Results.Status

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  5. def Delete: Method

    Permalink
    Definition Classes
    Methods → Methods

  6. implicit def EmptyEndpointToPlayHandler[A, B](endpoint: Endpoint[A, B])(implicit ev: =:=[Unit, B]): ToPlayHandler

    Permalink
    Definition Classes
    Endpoints

  7. def Get: Method

    Permalink
    Definition Classes
    Methods → Methods

  8. def NotFound: play.api.mvc.Results.Status

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  9. def OK: play.api.mvc.Results.Status

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  10. def Options: Method

    Permalink
    Definition Classes
    Methods → Methods

  11. def Patch: Method

    Permalink
    Definition Classes
    Methods → Methods

  12. def Post: Method

    Permalink
    Definition Classes
    Methods → Methods

  13. def Put: Method

    Permalink
    Definition Classes
    Methods → Methods

  14. def Unauthorized: play.api.mvc.Results.Status

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  15. implicit lazy val applicativeRequestExtractor: Applicative[RequestExtractor]

    Permalink
    Definition Classes
    Urls

  16. implicit def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], factory: scala.collection.compat.Factory[A, C[A]]): JsonSchema[C[A]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  17. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  18. implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  19. implicit def booleanJsonSchema: JsonSchema[Boolean]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  20. implicit def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls

  21. implicit def byteJsonSchema: JsonSchema[Byte]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  22. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

    Permalink
    Definition Classes
    Urls → Urls

  23. def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  24. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Permalink
    Definition Classes
    Urls → Urls

  26. def defaultDiscriminatorName: String

    Permalink
    Definition Classes
    JsonSchemas

  27. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

  28. implicit def doubleJsonSchema: JsonSchema[Double]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  29. implicit def doubleQueryString: QueryStringParam[Double]

    Permalink
    Definition Classes
    Urls

  30. implicit def doubleSegment: Segment[Double]

    Permalink
    Definition Classes
    Urls

  31. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

    Permalink
    Definition Classes
    Urls

  32. lazy val emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  33. def emptyRecord: Record[Unit]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  34. lazy val emptyRequest: BodyParser[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  35. def emptyResponse(docs: Documentation): Response[Unit]

    Permalink
    Definition Classes
    Endpoints → Responses

  36. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

    Permalink
    Definition Classes
    Endpoints → Endpoints

  37. def enumeration[A](values: Seq[A])(encode: (A) ⇒ String)(implicit tpe: JsonSchema[String]): Enum[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  38. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  39. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  40. def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  41. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  42. implicit def floatJsonSchema: JsonSchema[Float]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  43. implicit lazy val functorRequestExtractor: Functor[RequestExtractor]

    Permalink
    Definition Classes
    Urls

  44. final def get[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

  45. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  46. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  47. def header(name: String, docs: Option[String]): (Headers) ⇒ Either[Result, String]

    Permalink
    Definition Classes
    Endpoints → Requests

  48. lazy val htmlResponse: Response[Html]

    Permalink
    Definition Classes
    Endpoints

  49. implicit def intJsonSchema: JsonSchema[Int]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  50. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls

  51. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls

  52. implicit lazy val invariantFunctorRequest: play.api.libs.functional.InvariantFunctor[Request]

    Permalink
    Definition Classes
    Endpoints

  53. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  54. def jsonRequest[A](docs: Documentation)(implicit arg0: JsonSchema[A]): RequestEntity[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  55. def jsonResponse[A](docs: Documentation)(implicit arg0: JsonSchema[A]): Response[A]

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  56. def lazySchema[A](schema: ⇒ JsonSchema[A], name: String): JsonSchema[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  57. implicit def longJsonSchema: JsonSchema[Long]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  58. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls

  59. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls

  60. implicit def mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  61. def named[A, S[T] <: JsonSchema[T]](schema: S[A], name: String): S[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  62. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  63. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  64. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  65. def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  66. def optHeader(name: String, docs: Option[String]): (Headers) ⇒ Either[Result, Option[String]]

    Permalink
    Definition Classes
    Endpoints → Requests

  67. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

    Permalink
    Definition Classes
    Urls → Urls

  68. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  69. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Permalink
    Definition Classes
    Urls → Urls

  70. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

  71. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

    Permalink
    Definition Classes
    Requests

  72. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

    Permalink
    Definition Classes
    Urls → Urls

  73. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

    Permalink
    Definition Classes
    Urls → Urls

  74. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

    Permalink
    Definition Classes
    Urls → Urls

  75. def redirect[A](other: ⇒ Endpoint[A, _])(args: A): Response[Unit]

    Permalink
    Definition Classes
    Endpoints

  76. def remainingSegments(name: String, docs: Documentation): Path[String]

    Permalink
    Definition Classes
    Urls → Urls

  77. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

    Permalink
    Definition Classes
    Urls → Urls

  78. implicit def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests

  79. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  80. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  81. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

    Permalink
    Definition Classes
    Endpoints → Requests

  82. def routesFromEndpoints(endpoints: ToPlayHandler*): PartialFunction[RequestHeader, Handler]

    Permalink
    Definition Classes
    Endpoints

  83. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]

    Permalink
    Definition Classes
    Urls → Urls

  84. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

    Permalink
    Definition Classes
    Urls → Urls

  85. def staticPathSegment(segment: String): Path[Unit]

    Permalink
    Definition Classes
    Urls → Urls

  86. implicit def stringJsonSchema: JsonSchema[String]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  87. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  88. implicit def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  90. def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  91. def textRequest(docs: Documentation): BodyParser[String]

    Permalink
    Definition Classes
    Endpoints → Requests

  92. def textResponse(docs: Documentation): Response[String]

    Permalink
    Definition Classes
    Endpoints → Responses

  93. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  94. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

  95. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

    Permalink
    Definition Classes
    Urls → Urls

  96. val utf8Name: String

    Permalink
    Definition Classes
    Urls

  97. implicit def uuidJsonSchema: JsonSchema[UUID]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  98. implicit def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls

  99. implicit def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls

  100. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  102. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  103. def wheneverFound[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

    Permalink
    Definition Classes
    Endpoints → Responses

  104. def withDiscriminator[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  105. def xmapJsonSchema[A, B](jsonSchema: JsonSchema[A], f: (A) ⇒ B, g: (B) ⇒ A): JsonSchema[B]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  106. def xmapRecord[A, B](record: Record[A], f: (A) ⇒ B, g: (B) ⇒ A): Record[B]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  107. def xmapTagged[A, B](tagged: Tagged[A], f: (A) ⇒ B, g: (B) ⇒ A): Tagged[B]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  108. def zipRecords[A, B](recordA: Record[A], recordB: Record[B]): Record[(A, B)]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

Inherited from JsonSchemas

Inherited from algebra.JsonSchemaEntities

Inherited from JsonSchemas

Inherited from algebra.JsonEntities

Inherited from Endpoints

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped