Type Members

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

   Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

   Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

   Definition Classes

   InvariantFunctorSyntax

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

   Definition Classes

   PartialInvariantFunctorSyntax

3.  implicit class PathOps[A] extends AnyRef

   Convenient methods for Paths.

   Convenient methods for Paths.

   Definition Classes

   Urls

4.  implicit class QueryStringSyntax[A] extends AnyRef

   Extension methods on QueryString.

   Extension methods on QueryString.

   Definition Classes

   Urls

5.  case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema) extends Product with Serializable
   name

   Name of the parameter

   required

   Whether this parameter is required or not (MUST be true for path parameters)

6.  case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable
   parameters

   List of query string parameters

7.  case class DocumentedQueryStringParam[A](schema: Schema, isRequired: Boolean, encoder: Encoder[A, Option[Value]]) extends Product with Serializable

   A query string parameter documentation description for type A

   A query string parameter documentation description for type A

   schema

   Schema that corresponds to type A

   isRequired

   Whether the query string parameter is required

   encoder

   JSON encoder for query string parameter value, primarily used for encoding of the parameter's default value. Result of the encoding is optional since the empty value of optional query string parameter should result in the empty encoded value.

8.  case class DocumentedUrl(path: List[Either[String, DocumentedParameter]], queryParameters: List[DocumentedParameter]) extends Product with Serializable
   path

   List of path segments. Left is a static segment, right is a path parameter

   queryParameters

   Query string parameters

9.  type Path[A] = DocumentedUrl

   An URL path carrying an A information

   An URL path carrying an A information

   Values of type Path[A] can be constructed by the operations path, segment, and remainingSegments.

   path / "user" / segment[UUID]("id")

   • Server interpreters raise an error if they can’t parse the incoming request path as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

   Definition Classes

   Urls → Urls

   Note

   This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

10.  type QueryString[A] = DocumentedQueryString

    A query string carrying an A information

    A query string carrying an A information

    QueryString values can be created with the qs operation, and can be combined with the & operation:

    val queryPageAndLang: QueryString[(Int, Option[String])] =
      qs[Int]("page") & qs[Option[String]]("lang")

    • Server interpreters raise an error if they can’t parse the incoming request query string parameters as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

    Definition Classes

    Urls → Urls

    Note

    This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

11.  type QueryStringParam[A] = DocumentedQueryStringParam[A]

    A query string parameter codec for type A.

    A query string parameter codec for type A.

    The trait Urls provides implicit instances of type QueryStringParam[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

    Definition Classes

    Urls → Urls

    Note

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

12.  type Segment[A] = Schema

    An URL path segment codec for type A.

    An URL path segment codec for type A.

    The trait Urls provides implicit instances of Segment[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

    Definition Classes

    Urls → Urls

    Note

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

13.  type Url[A] = DocumentedUrl

    An URL carrying an A information

    An URL carrying an A information

    Values of type URL[A] are typically constructed by first using the path constructor and then chaining it with segments and query parameters.

    path / "users" / segment[UUID]("id") /? qs[String]("apiKey")

    • Server interpreters raise an error if they can’t parse the incoming request URL as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

    Definition Classes

    Urls → Urls

    Note

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

14.  type WithDefault[A] = A

    This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

    This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

    • Client interpreters should define it as Option[A] and omit query string parameters with default value that are empty
    • Server interpreters should define it as A and accept incoming requests whose query string parameters with default value are missing, while providing the defined default value
    • Documentation interpreters should mark the parameter as optional and document the provided default value

    Definition Classes

    Urls → Urls