Trait

endpoints.akkahttp.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, Methods, Urls, StatusCodes, 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. Methods
  8. Urls
  9. StatusCodes
  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 class Directive0Ops extends AnyRef

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Endpoints

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

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

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

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

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

  7. trait JsonSchema[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  8. implicit final class JsonSchemaOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  9. type Method = HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

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

    Permalink
    Definition Classes
    PartialInvariantFunctorSyntax

  11. class Path[T] extends Url[T]

    Permalink
    Definition Classes
    Urls

  12. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  13. class QueryString[T] extends AnyRef

    Permalink
    Definition Classes
    Urls

  14. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  15. type QueryStringParam[T] = (String, Map[String, Seq[String]]) ⇒ Option[T]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    JsonSchemas

  17. implicit final class RecordOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  18. type Request[A] = Directive[(A)]

    Permalink
    Definition Classes
    Endpoints → Requests

  19. type RequestEntity[A] = Directive[(A)]

    Permalink
    Definition Classes
    Endpoints → Requests

  20. type RequestHeaders[A] = Directive[(A)]

    Permalink
    Definition Classes
    Endpoints → Requests

  21. type Response[A] = (A) ⇒ Route

    Permalink
    Definition Classes
    Endpoints → Responses

  22. implicit class ResponseExtensions[A] extends AnyRef

    Permalink
    Definition Classes
    Responses

  23. type Segment[T] = PathMatcher[(T)]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    SemigroupalSyntax

  25. type StatusCode = akka.http.scaladsl.model.StatusCode

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

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

    Permalink
    Definition Classes
    JsonSchemas

  27. implicit final class TaggedOps[A] extends AnyRef

    Permalink
    Definition Classes
    JsonSchemas

  28. class Url[T] extends AnyRef

    Permalink
    Definition Classes
    Urls

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: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  5. def Delete: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  6. def Get: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  7. def NotFound: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  8. def OK: Success

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  9. def Options: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  10. def Patch: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  11. def Post: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  12. def Put: HttpMethod

    Permalink
    Definition Classes
    Methods → Methods

  13. def Unauthorized: ClientError

    Permalink
    Definition Classes
    StatusCodes → StatusCodes

  14. 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

  15. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  16. implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  17. implicit def booleanJsonSchema: JsonSchema[Boolean]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  18. implicit def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls

  19. implicit def byteJsonSchema: JsonSchema[Byte]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  22. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    Urls → Urls

  24. def convToDirective1(directive: Directive0): Directive1[Unit]

    Permalink
    Attributes
    protected
    Definition Classes
    Urls

  25. def defaultDiscriminatorName: String

    Permalink
    Definition Classes
    JsonSchemas

  26. 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

  27. lazy val directive1InvFunctor: InvariantFunctor[Directive1]

    Permalink
    Definition Classes
    Endpoints

  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. def emptyHeaders: RequestHeaders[Unit]

    Permalink
    Definition Classes
    Endpoints → Requests

  33. def emptyRecord: Record[Unit]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  34. def emptyRequest: RequestEntity[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. 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

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

    Permalink
    Definition Classes
    AnyRef → Any

  45. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  46. def header(name: String, docs: Documentation): RequestHeaders[String]

    Permalink
    Definition Classes
    Endpoints → Requests

  47. implicit def intJsonSchema: JsonSchema[Int]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  48. implicit def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls

  49. implicit def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls

  50. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  51. def joinDirectives[T1, T2](dir1: Directive1[T1], dir2: Directive1[T2])(implicit tupler: Tupler[T1, T2]): Directive1[Out]

    Permalink
    Attributes
    protected
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

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

    Permalink
    Definition Classes
    JsonSchemaEntities → JsonEntities

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  55. implicit def longJsonSchema: JsonSchema[Long]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  56. implicit def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls

  57. implicit def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    AnyRef

  61. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  62. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  64. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  66. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  67. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

    Permalink
    Definition Classes
    Urls → Urls

  68. 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

  69. 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

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

    Permalink
    Definition Classes
    Urls → Urls

  71. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

    Permalink
    Definition Classes
    Urls → Urls

  72. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

    Permalink
    Definition Classes
    Urls → Urls

  73. def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

    Permalink
    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  75. 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

  76. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Endpoints → Requests

  77. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  78. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Endpoints → Requests

  79. 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

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

    Permalink
    Definition Classes
    Urls → Urls

  81. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  83. implicit def stringJsonSchema: JsonSchema[String]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  84. implicit lazy val stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  85. implicit def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  88. def textRequest(docs: Documentation): RequestEntity[String]

    Permalink
    Definition Classes
    Endpoints → Requests

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

    Permalink
    Definition Classes
    Endpoints → Responses

  90. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  91. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  93. implicit def uuidJsonSchema: JsonSchema[UUID]

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  94. implicit def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls

  95. implicit def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls

  96. final def wait(): Unit

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

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

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

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

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

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

    Permalink
    Definition Classes
    Endpoints → Responses

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

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

    Permalink
    Definition Classes
    JsonSchemas → JsonSchemas

  104. 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 Methods

Inherited from Urls

Inherited from StatusCodes

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