t

endpoints.uzhttp.server

JsonEntitiesFromSchemas

trait JsonEntitiesFromSchemas extends algebra.JsonEntitiesFromSchemas with JsonEntitiesFromCodecs with JsonSchemas

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

Type Members

  1. case class Endpoint[A, B](request: EndpointsWithCustomErrors.Request[A], response: EndpointsWithCustomErrors.Response[B]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. case class CallbackDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  4. type ClientErrors = Invalid
    Definition Classes
    BuiltInErrors → Errors
  5. case class EndpointDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. type Enum[A] = JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  7. implicit final class EnumOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  8. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  9. type JsonCodec[A] = JsonSchema[A]
    Definition Classes
    JsonEntitiesFromSchemas → JsonCodecs
  10. type JsonRequest[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  11. type JsonResponse[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  12. trait JsonSchema[A] extends AnyRef
    Definition Classes
    JsonSchemas
  13. sealed trait JsonSchemaDocumentationOps[A] extends AnyRef
    Definition Classes
    JsonSchemas
  14. implicit final class JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  15. type Method = uzhttp.Request.Method
    Definition Classes
    Methods → Methods
  16. type Params = Map[String, Seq[String]]
    Definition Classes
    Urls
  17. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  18. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  19. type QueryString[A] = (Params) => Validated[A]
    Definition Classes
    Urls → Urls
  20. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  21. trait Record[A] extends JsonSchema[A]
    Definition Classes
    JsonSchemas
  22. implicit final class RecordOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  23. type Request[A] = (uzhttp.Request) => Option[UIO[Validated[A]]]

    An HTTP request.

    An HTTP request.

    It receives uzhttp.Request and returns: - None if request url cannot be matched - Some(Valid(a)) if A can be extracted from request - Invalid if A cannot be extracted from request

    Has an instance of InvariantFunctor.

    Definition Classes
    Requests → Requests
  24. type RequestEntity[A] = (uzhttp.Request) => UIO[Validated[A]]

    Information carried by request entity.

    Information carried by request entity. It is modeled as UIO[Validate[A]] because it is result of collecting data from stream chunk. If any error happens during collecting data or collected data cannot be transformed to wanted information we store error in Invalid data structure which is later transformed to Bad Request response.

    Definition Classes
    Requests → Requests
  25. type RequestHeaders[A] = (Map[String, String]) => 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
    Requests → Requests
  26. type Response[A] = (A) => RIO[Blocking, uzhttp.Response]

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

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

    Definition Classes
    Responses → Responses
    Note

    This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax class

  27. type ResponseEntity[A] = (A) => (Array[Byte], String)

    An HTTP response entity carrying an information of type A It is modeled as function that receives A and returns it value serialized to byte array together with content type.

    An HTTP response entity carrying an information of type A It is modeled as function that receives A and returns it value serialized to byte array together with content type.

    Definition Classes
    Responses → Responses
  28. type ResponseHeaders[A] = (A) => List[(String, String)]

    Information carried by responses’ headers.

    Information carried by responses’ headers.

    You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.

    Definition Classes
    Responses → Responses
    Note

    This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.

  29. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  30. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  31. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  32. type StatusCode = Status
    Definition Classes
    StatusCodes → StatusCodes
  33. abstract class Tagged[A] extends Record[A]
    Definition Classes
    JsonSchemas
  34. implicit final class TaggedOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  35. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  36. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  37. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  38. trait Url[A] extends AnyRef
    Definition Classes
    Urls

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: uzhttp.Status.Accepted
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: uzhttp.Status.Created
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: Method
    Definition Classes
    Methods → Methods
  8. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def Get: Method
    Definition Classes
    Methods → Methods
  10. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  11. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  14. def OK: Ok
    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: Status
    Definition Classes
    StatusCodes → StatusCodes
  20. implicit def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], factory: Factory[A, C[A]]): JsonSchema[C[A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  21. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  22. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  23. implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]
    Definition Classes
    JsonSchemas → JsonSchemas
  24. implicit def booleanJsonSchema: JsonSchema[Boolean]
    Definition Classes
    JsonSchemas → JsonSchemas
  25. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  26. implicit def byteJsonSchema: JsonSchema[Byte]
    Definition Classes
    JsonSchemas → JsonSchemas
  27. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  28. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    Responses → Responses
  29. def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]
    Definition Classes
    JsonSchemas → JsonSchemas
  30. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  31. def clientErrorsResponseEntity: (ClientErrors) => (Array[Byte], String)
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  32. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  33. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  34. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

    Concatenates two QueryStrings

    Concatenates two QueryStrings

    Definition Classes
    Urls → Urls
  35. def defaultDiscriminatorName: String
    Definition Classes
    JsonSchemas
  36. implicit final def defaultStringJsonSchema: JsonSchema[String]
    Definition Classes
    JsonSchemas
  37. 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
  38. implicit def doubleJsonSchema: JsonSchema[Double]
    Definition Classes
    JsonSchemas → JsonSchemas
  39. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  40. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  41. lazy val emptyRecord: Record[Unit]
    Definition Classes
    JsonSchemas → JsonSchemas
  42. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    Requests → Requests
  43. def emptyRequestHeaders: RequestHeaders[Unit]

    Always succeeds in extracting no information from the headers

    Always succeeds in extracting no information from the headers

    Definition Classes
    Requests → Requests
  44. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    Responses → Responses
  45. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    Responses → Responses
  46. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  47. def enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  48. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  49. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  50. def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  51. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  52. implicit def floatJsonSchema: JsonSchema[Float]
    Definition Classes
    JsonSchemas → JsonSchemas
  53. 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
  54. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  55. def handleClientErrors(invalid: Invalid): RIO[Blocking, uzhttp.Response]

    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
    EndpointsWithCustomErrors
  56. def handleServerError(throwable: Throwable): RIO[Blocking, uzhttp.Response]

    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
  57. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  58. implicit def intJsonSchema: JsonSchema[Int]
    Definition Classes
    JsonSchemas → JsonSchemas
  59. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  60. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  61. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  62. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  63. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  64. def jsonRequest[A](implicit arg0: JsonCodec[A]): (uzhttp.Request) => UIO[Validated[A]]

    Defines a RequestEntity[A] given an implicit JsonRequest[A]

    Defines a RequestEntity[A] given an implicit JsonRequest[A]

    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  65. def jsonResponse[A](implicit arg0: JsonCodec[A]): (A) => (Array[Byte], String)

    Defines a Response[A] given an implicit JsonResponse[A]

    Defines a Response[A] given an implicit JsonResponse[A]

    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  66. implicit def jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]
    Definition Classes
    JsonSchemas → JsonSchemas
  67. def lazyRecord[A](schema: => Record[A], name: String): JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  68. def lazyTagged[A](schema: => Tagged[A], name: String): JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  69. final def literal[A](value: A)(implicit tpe: JsonSchema[A]): JsonSchema[Unit]
    Definition Classes
    JsonSchemas
  70. implicit def longJsonSchema: JsonSchema[Long]
    Definition Classes
    JsonSchemas → JsonSchemas
  71. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  72. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  73. implicit def mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  74. def namedEnum[A](enumeration: Enum[A], name: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  75. def namedRecord[A](record: Record[A], name: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  76. def namedTagged[A](tagged: Tagged[A], name: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  77. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. 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
  81. def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  82. def optRequestHeader(name: String, docs: Documentation = None): RequestHeaders[Option[String]]
    Definition Classes
    Requests → Requests
  83. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]

    Response headers optionally containing a header with the given name.

    Response headers optionally containing a header with the given name. Client interpreters should model the header value as Some[String], or None if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.

    Definition Classes
    Responses → Responses
  84. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  85. 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
  86. def orFallbackToJsonSchema[A, B](schemaA: JsonSchema[A], schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]
    Definition Classes
    JsonSchemas → JsonSchemas
  87. 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
  88. val path: Path[Unit]
    Definition Classes
    Urls
  89. implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  90. 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
  91. 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
  92. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): (Params) => Validated[A]
    Definition Classes
    Urls → Urls
  93. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  94. implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  95. implicit def recordPartialInvFunctor: PartialInvariantFunctor[Record]
    Definition Classes
    JsonSchemas → JsonSchemas
  96. def remainingSegments(name: String = "", docs: Documentation = None): Path[String]
    Definition Classes
    Urls → Urls
  97. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  98. def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests → Requests
  99. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    Requests → Requests
  100. def requestHeader(name: String, docs: Documentation = None): RequestHeaders[String]
    Definition Classes
    Requests → Requests
  101. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    Requests → Requests
  102. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Requests → Requests
  103. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    Requests → Requests
  104. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]

    Server interpreters construct a response with the given status and entity.

    Server interpreters construct a response with the given status and entity. Client interpreters accept a response only if it has a corresponding status code.

    statusCode

    Response status code

    entity

    Response entity

    docs

    Response documentation

    headers

    Response headers

    Definition Classes
    Responses → Responses
  105. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    Responses → Responses
  106. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]

    Response headers containing a header with the given name.

    Response headers containing a header with the given name. Client interpreters should model the header value as String, or fail if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.

    Example:

    val versionedResource: Endpoint[Unit, (SomeResource, String)] =
  endpoint(
    get(path / "versioned-resource"),
    ok(
      jsonResponse[SomeResource],
      headers = responseHeader("ETag")
    )
  )
    Definition Classes
    Responses → Responses
  107. implicit lazy val responseHeadersInvariantFunctor: PartialInvariantFunctor[ResponseHeaders]
    Definition Classes
    Responses → Responses
  108. implicit lazy val responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    Responses → Responses
  109. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    Responses → Responses
  110. def segment[A](name: String = "", docs: Documentation = None)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  111. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  112. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  113. def serverErrorResponseEntity: (ServerError) => (Array[Byte], String)
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  114. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  115. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  116. def stringCodec[A](implicit codec: JsonCodec[A]): Codec[String, A]
    Definition Classes
    JsonEntitiesFromSchemas → JsonEntitiesFromCodecs
  117. final def stringEnumeration[A](values: Seq[A])(encode: (A) => String)(implicit tpe: JsonSchema[String]): Enum[A]
    Definition Classes
    JsonSchemas
  118. def stringJsonSchema(format: Option[String]): JsonSchema[String]
    Definition Classes
    JsonSchemas → JsonSchemas
  119. implicit def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  120. implicit val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  121. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  122. implicit def taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]
    Definition Classes
    JsonSchemas → JsonSchemas
  123. def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  124. def textRequest: RequestEntity[String]
    Definition Classes
    Requests → Requests
  125. def textResponse: ResponseEntity[String]
    Definition Classes
    Responses → Responses
  126. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  127. def toString(): String
    Definition Classes
    AnyRef → Any
  128. 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
  129. 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
  130. 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
  131. 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
  132. 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
  133. 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
  134. 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
  135. 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
  136. 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
  137. 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
  138. 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
  139. 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
  140. 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
  141. implicit def tuple2JsonSchema[T1, T2](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2]): JsonSchema[(T1, T2)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  142. implicit def tuple3JsonSchema[T1, T2, T3](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3]): JsonSchema[(T1, T2, T3)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  143. 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
  144. 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
  145. 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
  146. 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
  147. 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
  148. 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
  149. implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  150. 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
  151. val utf8Name: String
    Definition Classes
    Urls
  152. implicit final lazy val uuidJsonSchema: JsonSchema[UUID]
    Definition Classes
    JsonSchemas
  153. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  154. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  155. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  156. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  157. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  158. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  159. def withDescriptionEnum[A](enumeration: Enum[A], description: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  160. def withDescriptionJsonSchema[A](schema: JsonSchema[A], description: String): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  161. def withDescriptionRecord[A](record: Record[A], description: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  162. def withDescriptionTagged[A](tagged: Tagged[A], description: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  163. def withDiscriminatorTagged[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  164. def withExampleEnum[A](enumeration: Enum[A], example: A): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  165. def withExampleJsonSchema[A](schema: JsonSchema[A], example: A): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  166. def withExampleRecord[A](record: Record[A], example: A): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  167. def withExampleTagged[A](tagged: Tagged[A], example: A): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  168. def withTitleEnum[A](enumeration: Enum[A], title: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  169. def withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  170. def withTitleRecord[A](record: Record[A], title: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  171. def withTitleTagged[A](tagged: Tagged[A], title: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  172. def zipRecords[A, B](recordA: Record[A], recordB: Record[B])(implicit t: Tupler[A, B]): Record[Out]
    Definition Classes
    JsonSchemas → JsonSchemas

Inherited from JsonSchemas

Inherited from TuplesSchemas

Inherited from NoDocsJsonSchemas

Inherited from JsonEntitiesFromCodecs

Inherited from Endpoints

Inherited from BuiltInErrors

Inherited from EndpointsWithCustomErrors

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Urls

Inherited from Methods

Inherited from algebra.Endpoints

Inherited from algebra.BuiltInErrors

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

operations

types

Ungrouped