Urls

Type Members

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)
case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

parameters
List of query string parameters
case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
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 i path parameter
queryParameters
Query string parameters
type Path[A] = DocumentedUrl

Definition Classes
Urls → Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
type QueryString[A] = DocumentedQueryString

Definition Classes
Urls → Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
type QueryStringParam[A] = DocumentedQueryStringParam

Definition Classes
Urls → Urls
type Segment[A] = Schema

Definition Classes
Urls → Urls
type Url[A] = DocumentedUrl

Definition Classes
Urls → Urls

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def booleanQueryString: QueryStringParam[Boolean]

Definition Classes
Urls → Urls
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Definition Classes
Urls → Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Definition Classes
Urls → Urls
def doubleQueryString: QueryStringParam[Double]

Definition Classes
Urls → Urls
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

Definition Classes
Urls
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def intQueryString: QueryStringParam[Int]

Definition Classes
Urls → Urls
def intSegment: Segment[Int]

Definition Classes
Urls → Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def longQueryString: QueryStringParam[Long]

Definition Classes
Urls → Urls
def longSegment: Segment[Long]

Definition Classes
Urls → Urls
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

Definition Classes
Urls → Urls
val path: Path[Unit]

Definition Classes
Urls
def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

Definition Classes
Urls → Urls
def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]

Definition Classes
Urls → Urls
implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

Definition Classes
Urls → Urls
def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]

Definition Classes
Urls → Urls
def staticPathSegment(segment: String): Path[Unit]

Definition Classes
Urls → Urls
def stringQueryString: QueryStringParam[String]

Definition Classes
Urls → Urls
def stringSegment: Segment[String]

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
implicit lazy val urlInvFunctor: InvariantFunctor[Url]

Definition Classes
Urls → Urls
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Definition Classes
Urls → Urls
def uuidQueryString: QueryStringParam[UUID]

Definition Classes
Urls → Urls
def uuidSegment: Segment[UUID]

Definition Classes
Urls → Urls
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package openapi

trait Urls extends algebra.Urls

Type Members

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

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

case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable

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

type Path[A] = DocumentedUrl

implicit class PathOps[A] extends AnyRef

type QueryString[A] = DocumentedQueryString

implicit class QueryStringOps[A] extends AnyRef

type QueryStringParam[A] = DocumentedQueryStringParam

type Segment[A] = Schema

type Url[A] = DocumentedUrl

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def booleanQueryString: QueryStringParam[Boolean]

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

def doubleQueryString: QueryStringParam[Double]

implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

def intQueryString: QueryStringParam[Int]

def intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

def longQueryString: QueryStringParam[Long]

def longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

val path: Path[Unit]

def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]

def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]

def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]

implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]

def staticPathSegment(segment: String): Path[Unit]

def stringQueryString: QueryStringParam[String]

def stringSegment: Segment[String]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

implicit lazy val urlInvFunctor: InvariantFunctor[Url]

def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

def uuidQueryString: QueryStringParam[UUID]

def uuidSegment: Segment[UUID]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped