Packages

t

endpoints4s.http4s.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. Urls
  8. StatusCodes
  9. Methods
  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. Protected

Type Members

  1. case class Endpoint[A, B](request: Request[A], response: Response[B], operationId: Option[String]) extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  3. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  4. abstract type ClientErrors
    Definition Classes
    Errors
  5. abstract type Effect[A]
    Definition Classes
    EndpointsWithCustomErrors → Urls
  6. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  7. type Enum[A] = JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  8. implicit final class EnumOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  9. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  10. type JsonCodec[A] = JsonSchema[A]
    Definition Classes
    JsonEntitiesFromSchemas → JsonCodecs
  11. type JsonRequest[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  12. type JsonResponse[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  13. trait JsonSchema[A] extends AnyRef
    Definition Classes
    JsonSchemas
  14. sealed trait JsonSchemaDocumentationOps[A] extends AnyRef
    Definition Classes
    JsonSchemas
  15. implicit final class JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
    Definition Classes
    JsonSchemas
  16. type Method = org.http4s.Method
    Definition Classes
    Methods → Methods
  17. type Params = Map[String, Seq[String]]
    Definition Classes
    Urls
  18. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  19. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  20. type QueryString[A] = (Params) => Validated[A]
    Definition Classes
    Urls → 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 Request[A] = PartialFunction[org.http4s.Request[Effect], Effect[Either[org.http4s.Response[Effect], A]]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  25. type RequestEntity[A] = (org.http4s.Request[Effect]) => Effect[Either[org.http4s.Response[Effect], A]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  26. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  27. type RequestHeaders[A] = (Headers) => Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  28. type Response[A] = (A) => org.http4s.Response[Effect]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  29. type ResponseEntity[A] = EntityEncoder[Effect, A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  30. type ResponseHeaders[A] = (A) => Headers
    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 = 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. trait Path[A] extends EndpointsWithCustomErrors.Url[A]
    Definition Classes
    Urls
  38. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  39. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  40. trait Url[A] extends AnyRef
    Definition Classes
    Urls

Abstract Value Members

  1. implicit abstract def Effect: Sync[Effect]
    Definition Classes
    EndpointsWithCustomErrors
  2. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  3. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  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: Status
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: Status
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Status
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Status
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: Method
    Definition Classes
    Methods → Methods
  10. def ExpectationFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  11. def FailedDependency: Status
    Definition Classes
    StatusCodes → StatusCodes
  12. def Forbidden: Status
    Definition Classes
    StatusCodes → StatusCodes
  13. def Get: Method
    Definition Classes
    Methods → Methods
  14. def Gone: Status
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Status
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: Status
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: Status
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: Status
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: Status
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Status
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Status
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: Status
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: Status
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: Status
    Definition Classes
    StatusCodes → StatusCodes
  27. def OK: Status
    Definition Classes
    StatusCodes → StatusCodes
  28. def Options: Method
    Definition Classes
    Methods → Methods
  29. def PartialContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  30. def Patch: Method
    Definition Classes
    Methods → Methods
  31. def PayloadTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  32. def PaymentRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  33. def Post: Method
    Definition Classes
    Methods → Methods
  34. def PreconditionFailed: Status
    Definition Classes
    StatusCodes → StatusCodes
  35. def PreconditionRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  36. def ProxyAuthenticationRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  37. def Put: Method
    Definition Classes
    Methods → Methods
  38. def RangeNotSatisfiable: Status
    Definition Classes
    StatusCodes → StatusCodes
  39. def RequestHeaderFieldsTooLarge: Status
    Definition Classes
    StatusCodes → StatusCodes
  40. def RequestTimeout: Status
    Definition Classes
    StatusCodes → StatusCodes
  41. def ResetContent: Status
    Definition Classes
    StatusCodes → StatusCodes
  42. def TooEarly: Status
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooManyRequests: Status
    Definition Classes
    StatusCodes → StatusCodes
  44. def Unauthorized: Status
    Definition Classes
    StatusCodes → StatusCodes
  45. def UnavailableForLegalReasons: Status
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnprocessableEntity: Status
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnsupportedMediaType: Status
    Definition Classes
    StatusCodes → StatusCodes
  48. def UpgradeRequired: Status
    Definition Classes
    StatusCodes → StatusCodes
  49. def UriTooLong: Status
    Definition Classes
    StatusCodes → StatusCodes
  50. implicit def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], factory: Factory[A, C[A]]): JsonSchema[C[A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  51. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  52. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  53. implicit def bigdecimalJsonSchema: JsonSchema[BigDecimal]
    Definition Classes
    JsonSchemas → JsonSchemas
  54. implicit def booleanJsonSchema: JsonSchema[Boolean]
    Definition Classes
    JsonSchemas → JsonSchemas
  55. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  56. implicit def byteJsonSchema: JsonSchema[Byte]
    Definition Classes
    JsonSchemas → JsonSchemas
  57. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  58. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  59. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  60. def choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]
    Definition Classes
    JsonSchemas → JsonSchemas
  61. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  62. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  63. 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
  64. def defaultDiscriminatorName: String
    Definition Classes
    JsonSchemas
  65. implicit final def defaultStringJsonSchema: JsonSchema[String]
    Definition Classes
    JsonSchemas
  66. 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
  67. implicit def doubleJsonSchema: JsonSchema[Double]
    Definition Classes
    JsonSchemas → JsonSchemas
  68. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  69. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  70. lazy val emptyRecord: Record[Unit]
    Definition Classes
    JsonSchemas → JsonSchemas
  71. def emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  72. def emptyRequestHeaders: RequestHeaders[Unit]

    HEADERS

    HEADERS

    Definition Classes
    EndpointsWithCustomErrors → Requests
  73. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  74. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  75. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  76. def enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  77. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  78. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  79. def field[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  80. implicit def floatJsonSchema: JsonSchema[Float]
    Definition Classes
    JsonSchemas → JsonSchemas
  81. 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
  82. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  83. def handleClientErrors(invalid: Invalid): org.http4s.Response[Effect]

    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
  84. def handleServerError(throwable: Throwable): org.http4s.Response[Effect]

    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
  85. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  86. implicit def intJsonSchema: JsonSchema[Int]
    Definition Classes
    JsonSchemas → JsonSchemas
  87. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  88. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  89. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  90. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  91. def jsonRequest[A](implicit codec: JsonCodec[A]): RequestEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  92. def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  93. implicit def jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]
    Definition Classes
    JsonSchemas → JsonSchemas
  94. def lazyRecord[A](schema: => Record[A], name: String): JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  95. def lazyTagged[A](schema: => Tagged[A], name: String): JsonSchema[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  96. final def literal[A](value: A)(implicit tpe: JsonSchema[A]): JsonSchema[Unit]
    Definition Classes
    JsonSchemas
  97. implicit def longJsonSchema: JsonSchema[Long]
    Definition Classes
    JsonSchemas → JsonSchemas
  98. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  99. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  100. implicit def mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  101. def namedEnum[A](enumeration: Enum[A], name: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  102. def namedRecord[A](record: Record[A], name: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  103. def namedTagged[A](tagged: Tagged[A], name: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  104. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  105. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  106. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  107. 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
  108. def optField[A](name: String, documentation: Option[String])(implicit tpe: JsonSchema[A]): Record[Option[A]]
    Definition Classes
    JsonSchemas → JsonSchemas
  109. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  110. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  112. 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
  113. def orFallbackToJsonSchema[A, B](schemaA: JsonSchema[A], schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]
    Definition Classes
    JsonSchemas → JsonSchemas
  114. 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
  115. val path: Path[Unit]
    Definition Classes
    Urls
  116. implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  117. 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
  118. 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
  119. def qs[A](name: String, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  120. implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  121. implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  122. implicit def recordPartialInvFunctor: PartialInvariantFunctor[Record]
    Definition Classes
    JsonSchemas → JsonSchemas
  123. def remainingSegments(name: String = "", docs: Documentation = None): Path[String]
    Definition Classes
    Urls → Urls
  124. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  125. 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
    EndpointsWithCustomErrors → Requests
  126. implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  127. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  128. implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  129. implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  130. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  131. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  132. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  133. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  134. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  135. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  136. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  137. def routesFromEndpoints(endpoints: PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]*): PartialFunction[org.http4s.Request[Effect], Effect[org.http4s.Response[Effect]]]
    Definition Classes
    EndpointsWithCustomErrors
  138. def segment[A](name: String = "", docs: Documentation = None)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  139. implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  140. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  141. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  142. def stringCodec[A](implicit codec: JsonCodec[A]): Codec[String, A]
    Definition Classes
    JsonEntitiesFromSchemas → JsonEntitiesFromCodecs
  143. final def stringEnumeration[A](values: Seq[A])(encode: (A) => String)(implicit tpe: JsonSchema[String]): Enum[A]
    Definition Classes
    JsonSchemas
  144. def stringJsonSchema(format: Option[String]): JsonSchema[String]
    Definition Classes
    JsonSchemas → JsonSchemas
  145. implicit def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  146. implicit def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  147. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  148. implicit def taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]
    Definition Classes
    JsonSchemas → JsonSchemas
  149. def taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  150. def textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  151. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  152. def toString(): String
    Definition Classes
    AnyRef → Any
  153. 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
  154. 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
  155. 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
  156. 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
  157. 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
  158. 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
  159. 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
  160. 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
  161. 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
  162. 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
  163. 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
  164. 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
  165. 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
  166. implicit def tuple2JsonSchema[T1, T2](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2]): JsonSchema[(T1, T2)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  167. implicit def tuple3JsonSchema[T1, T2, T3](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3]): JsonSchema[(T1, T2, T3)]
    Definition Classes
    TuplesSchemas → TuplesSchemas
  168. 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
  169. 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
  170. 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
  171. 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
  172. 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
  173. 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
  174. implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  175. 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
  176. val utf8Name: String
    Definition Classes
    Urls
  177. implicit final lazy val uuidJsonSchema: JsonSchema[UUID]
    Definition Classes
    JsonSchemas
  178. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  179. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  180. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  181. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  182. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  183. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  184. def withDescriptionEnum[A](enumeration: Enum[A], description: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  185. def withDescriptionJsonSchema[A](schema: JsonSchema[A], description: String): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  186. def withDescriptionRecord[A](record: Record[A], description: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  187. def withDescriptionTagged[A](tagged: Tagged[A], description: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  188. def withDiscriminatorTagged[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]
    Definition Classes
    JsonSchemas → JsonSchemas
  189. def withExampleEnum[A](enumeration: Enum[A], example: A): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  190. def withExampleJsonSchema[A](schema: JsonSchema[A], example: A): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  191. def withExampleRecord[A](record: Record[A], example: A): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  192. def withExampleTagged[A](tagged: Tagged[A], example: A): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  193. def withTitleEnum[A](enumeration: Enum[A], title: String): Enum[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  194. def withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  195. def withTitleRecord[A](record: Record[A], title: String): Record[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  196. def withTitleTagged[A](tagged: Tagged[A], title: String): Tagged[A]
    Definition Classes
    NoDocsJsonSchemas → JsonSchemas
  197. def zipRecords[A, B](recordA: Record[A], recordB: Record[B])(implicit t: Tupler[A, B]): Record[Out]
    Definition Classes
    JsonSchemas → JsonSchemas
  198. 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 Urls

Inherited from StatusCodes

Inherited from Methods

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