openapi/endpoints4s.openapi/Urls

Urls

trait Urls extends Urls

Interpreter for algebra.Urls

trait Urls
class Object
trait Matchable
class Any
trait Requests
trait Assets
trait Endpoints

Type members

Classlikes

case class DocumentedParameter(name: String, required: Boolean, description: Option[String], schema: Schema)
Value parameters:
name

Name of the parameter

required

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

case class DocumentedQueryString(parameters: List[DocumentedParameter])
Value parameters:
parameters

List of query string parameters

case class DocumentedQueryStringParam[A](schema: Schema, isRequired: Boolean, encoder: Encoder[A, Option[Value]])

A query string parameter documentation description for type A

A query string parameter documentation description for type A

Value parameters:
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.

isRequired

Whether the query string parameter is required

schema

Schema that corresponds to type A

case class DocumentedUrl(path: List[Either[String, DocumentedParameter]], queryParameters: List[DocumentedParameter])
Value parameters:
path

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

queryParameters

Query string parameters

Inherited classlikes

implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

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.

Inherited from:
InvariantFunctorSyntax
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])
implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls

Types

type Segment[A] = Schema
type Url[A] = DocumentedUrl
type WithDefault[A] = A

Value members

Concrete methods

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
override def doubleSegment: Segment[Double]
Definition Classes
override def intQueryString: DocumentedQueryStringParam[Int]
Definition Classes
override def intSegment: Segment[Int]
Definition Classes
override def longQueryString: DocumentedQueryStringParam[Long]
Definition Classes
override def longSegment: Segment[Long]
Definition Classes
override def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: DocumentedQueryStringParam[A]): QueryString[WithDefault[A]]
Definition Classes
def qs[A](name: String, docs: Documentation)(implicit value: DocumentedQueryStringParam[A]): QueryString[A]
def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
override def uuidQueryString: DocumentedQueryStringParam[UUID]
Definition Classes
override def uuidSegment: Segment[UUID]
Definition Classes

Inherited fields

val path: Path[Unit]

An empty path.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")
Inherited from:
Urls

Implicits

Implicits

implicit def repeatedQueryStringParam[A, CC <: (Iterable)](implicit param: DocumentedQueryStringParam[A], factory: Factory[A, CC[A]]): DocumentedQueryStringParam[CC[A]]

Inherited implicits

final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

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.

Inherited from:
InvariantFunctorSyntax
final implicit def PartialInvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: PartialInvariantFunctor[F]): PartialInvariantFunctorSyntax[A, F]
final implicit def PathOps[A](first: Path[A]): PathOps[A]

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
final implicit def QueryStringSyntax[A](first: QueryString[A]): QueryStringSyntax[A]

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls