Type Members

1.  final class CaseInsensitive extends Ordered[CaseInsensitive] with Serializable
2.  sealed abstract class HttpBinding extends Product with Serializable
3.  sealed trait HttpContractError extends Throwable with NoStackTrace
4.  sealed trait HttpDiscriminator extends Product with Serializable
5.  trait HttpEndpoint[I] extends AnyRef
6.  type HttpMediaType = http.HttpMediaType.Type
7.  sealed trait HttpMethod extends Product with Serializable
8.  type HttpPayloadDecoder[A] = Decoder[[β$0$]Either[HttpContractError, β$0$], Blob, A]
9.  case class HttpPayloadError(path: PayloadPath, expected: String, message: String) extends Throwable with HttpContractError with Product with Serializable
10.  final case class HttpRequest[+A](method: HttpMethod, uri: HttpUri, headers: Map[CaseInsensitive, Seq[String]], body: A) extends Product with Serializable
11.  final case class HttpResponse[+A](statusCode: Int, headers: Map[CaseInsensitive, Seq[String]], body: A) extends Product with Serializable
12.  sealed trait HttpRestSchema[A] extends AnyRef

    This construct indicates how a schema is split between http metadata (ie headers, path parameters, query parameters, status code) and body.

    This construct indicates how a schema is split between http metadata (ie headers, path parameters, query parameters, status code) and body.

    When the input or the output of an http operation has some elements that are coming from the body and some elements that are coming from the metadata, the schema is split in two schemas that each track the relevant subset.

    The partial data resulting from the successful decoding of both subsets can be reconciled to recover the total data.

    On the encoding side, the split allows to only encode the relevant subset of data as http headers, and the other subset as http body.

13.  trait HttpStatusCode[A] extends AnyRef

    Typeclass construct allowing to retrieve the status code associated to a value.

14.  final case class HttpUri(scheme: HttpUriScheme, host: String, port: Option[Int], path: IndexedSeq[String], queryParams: Map[String, Seq[String]], pathParams: Option[Map[String, String]]) extends Product with Serializable
15.  sealed trait HttpUriScheme extends AnyRef
16.  case class Metadata(path: Map[String, String] = Map.empty, query: Map[String, Seq[String]] = Map.empty, headers: Map[CaseInsensitive, Seq[String]] = Map.empty, statusCode: Option[Int] = None) extends Product with Serializable

    Datatype containing metadata associated to a http message.

    Datatype containing metadata associated to a http message.

    The metadata is what is found in the http headers, and can be derived from the http path, the query parameters, or the headers.

    Associated to it are a pair of Encoder/Decoder typeclasses, that can be derived from a schema.

    path

    the path parameters of the http message

    query

    the query parameters of the http message

    headers

    the header parameters of the http message

17.  sealed trait MetadataError extends Throwable with HttpContractError
18.  type PathParams = Map[String, String]
19.  sealed trait PathSegment extends AnyRef
20.  case class UnknownErrorResponse(code: Int, headers: Map[CaseInsensitive, Seq[String]], body: String) extends Throwable with Product with Serializable
21.  final case class UrlForm(values: List[FormData]) extends Product with Serializable

    Represents data that was encoded using the application/x-www-form-urlencoded format.

22.  final case class UrlFormDecodeError(path: PayloadPath, message: String) extends Throwable with Product with Serializable