Requests

Type Members

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
InvariantFunctorSyntax
abstract type Method

HTTP Method
HTTP Method

Definition Classes
Methods
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
PartialInvariantFunctorSyntax
abstract type Path[A] <: Url[A]

An URL path carrying an A information
An URL path carrying an A information

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Convenient methods for Paths.
Convenient methods for Paths.

Definition Classes
Urls
abstract type QueryString[A]

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")
```
Definition Classes
Urls
abstract type QueryStringParam[A]

A single query string parameter carrying an A information.
A single query string parameter carrying an A information.

Definition Classes
Urls
implicit class QueryStringSyntax[A] extends AnyRef

Extension methods on QueryString.
Extension methods on QueryString.

Definition Classes
Urls
abstract type Request[A]

Information carried by a whole request (headers and entity)
abstract type RequestEntity[A]

Information carried by request entity
abstract type RequestHeaders[A]

Information carried by requests’ headers
abstract type Segment[A]

An URL path segment carrying an A information.
An URL path segment carrying an A information.

Definition Classes
Urls
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

Definition Classes
SemigroupalSyntax
abstract type Url[A]

An URL carrying an A information
An URL carrying an A information

Definition Classes
Urls

Abstract Value Members

abstract def Delete: Method

Definition Classes
Methods
abstract def Get: Method

Definition Classes
Methods
abstract def Options: Method

Definition Classes
Methods
abstract def Patch: Method

Definition Classes
Methods
abstract def Post: Method

Definition Classes
Methods
abstract def Put: Method

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

Chains the two paths
Chains the two paths

Definition Classes
Urls
abstract 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
abstract def emptyHeaders: RequestHeaders[Unit]

No particular information.
No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.
Use description of endpoints.algebra.Endpoints#endpoint to document empty headers.
abstract def emptyRequest: RequestEntity[Unit]

Empty request -- request without a body.
Empty request -- request without a body. Use description of endpoints.algebra.Endpoints#endpoint to document an empty body.
abstract def header(name: String, docs: Documentation = None): RequestHeaders[String]
abstract def optHeader(name: String, docs: Documentation = None): RequestHeaders[Option[String]]
implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

Make a query string parameter optional:
Make a query string parameter optional:
```
path / "articles" /? qs[Option[Int]]("page")
```
Client interpreters must omit optional query string parameters that are empty. Server interpreters must accept incoming requests whose optional query string parameters are missing. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.
Definition Classes
Urls
implicit abstract def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

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

Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
Examples:
```
qs[Int]("page")            // mandatory `page` parameter
qs[Option[String]]("lang") // optional `lang` parameter
qs[List[Long]]("id")       // repeated `id` parameter
```
A
Type of the value carried by the parameter
name
Parameter’s name

Definition Classes
Urls
implicit abstract def queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

Definition Classes
Urls
implicit abstract def queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

Definition Classes
Urls
abstract def remainingSegments(name: String = "", docs: Documentation = None): Path[String]

The remaining segments of the path.
The remaining segments of the path. The String value carried by this Path is still URL-encoded.

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

Support query string parameters with multiple values:
Support query string parameters with multiple values:
```
path / "articles" /? qs[List[Long]]("id")
```
Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
Definition Classes
Urls
implicit abstract def reqEntityInvFunctor: InvariantFunctor[RequestEntity]
implicit abstract def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
implicit abstract def reqHeadersSemigroupal: Semigroupal[RequestHeaders]
abstract def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Request for given parameters
Request for given parameters
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
method
Request method
url
Request URL
entity
Request entity
docs
Request documentation
headers
Request headers
abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

A path segment carrying an A information
A path segment carrying an A information

Definition Classes
Urls
implicit abstract def segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

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

A path segment whose value is the given segment
A path segment whose value is the given segment

Definition Classes
Urls
implicit abstract def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters
Ability to define String query string parameters

Definition Classes
Urls
implicit abstract def stringSegment: Segment[String]

Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.
Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.

Definition Classes
Urls
abstract def textRequest: RequestEntity[String]

Request with a String body.
implicit abstract def urlPartialInvFunctor: PartialInvariantFunctor[Url]

Definition Classes
Urls
abstract 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

Concrete 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
implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value
Query string parameter containing a Boolean value

Definition Classes
Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Helper method to perform DELETE request
Helper method to perform DELETE request
UrlP
Payload carried by url
HeadersP
Payload carried by headers
implicit def doubleQueryString: QueryStringParam[Double]

Definition Classes
Urls
implicit def doubleSegment: Segment[Double]

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

Implicit conversion to get rid of intellij errors when defining paths.
Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.

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 get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Helper method to perform GET request
Helper method to perform GET request
UrlP
Payload carried by url
HeadersP
Payload carried by headers
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Ability to define Int query string parameters
Ability to define Int query string parameters

Definition Classes
Urls
implicit def intSegment: Segment[Int]

Ability to define Int path segments
Ability to define Int path segments

Definition Classes
Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value
Query string parameter containing a Long value

Definition Classes
Urls
implicit def longSegment: Segment[Long]

Segment containing a Long value
Segment containing a Long value

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val path: Path[Unit]

An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int] /? qs[String]("bar")
```
Definition Classes
Urls
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform POST request
Helper method to perform POST request
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
docs
Request documentation
final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform PUT request
Helper method to perform PUT request
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def tryParseString[A](type: String)(parse: (String) ⇒ A): (String) ⇒ Validated[A]

Definition Classes
Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters
Ability to define UUID query string parameters

Definition Classes
Urls
implicit def uuidSegment: Segment[UUID]

Ability to define UUID path segments
Ability to define UUID path segments

Definition Classes
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 algebra

trait Requests extends Urls with Methods with SemigroupalSyntax

Type Members

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

abstract type Method

implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

abstract type Path[A] <: Url[A]

implicit class PathOps[A] extends AnyRef

abstract type QueryString[A]

abstract type QueryStringParam[A]

implicit class QueryStringSyntax[A] extends AnyRef

abstract type Request[A]

abstract type RequestEntity[A]

abstract type RequestHeaders[A]

abstract type Segment[A]

implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

abstract type Url[A]

Abstract Value Members

abstract def Delete: Method

abstract def Get: Method

abstract def Options: Method

abstract def Patch: Method

abstract def Post: Method

abstract def Put: Method

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

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

abstract def emptyHeaders: RequestHeaders[Unit]

abstract def emptyRequest: RequestEntity[Unit]

abstract def header(name: String, docs: Documentation = None): RequestHeaders[String]

abstract def optHeader(name: String, docs: Documentation = None): RequestHeaders[Option[String]]

implicit abstract def optionalQueryStringParam[A](implicit arg0: QueryStringParam[A]): QueryStringParam[Option[A]]

implicit abstract def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

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

implicit abstract def queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

implicit abstract def queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

abstract def remainingSegments(name: String = "", docs: Documentation = None): Path[String]

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

implicit abstract def reqEntityInvFunctor: InvariantFunctor[RequestEntity]

implicit abstract def reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

implicit abstract def reqHeadersSemigroupal: Semigroupal[RequestHeaders]

abstract def segment[A](name: String = "", docs: Documentation = None)(implicit s: Segment[A]): Path[A]

implicit abstract def segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

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

implicit abstract def stringQueryString: QueryStringParam[String]

implicit abstract def stringSegment: Segment[String]

abstract def textRequest: RequestEntity[String]

implicit abstract def urlPartialInvFunctor: PartialInvariantFunctor[Url]

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

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

implicit def booleanQueryString: QueryStringParam[Boolean]

def clone(): AnyRef

final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

implicit def doubleQueryString: QueryStringParam[Double]

implicit def doubleSegment: Segment[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 get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

implicit def intQueryString: QueryStringParam[Int]

implicit def intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

implicit def longQueryString: QueryStringParam[Long]

implicit def longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val path: Path[Unit]

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

def toString(): String

def tryParseString[A](type: String)(parse: (String) ⇒ A): (String) ⇒ Validated[A]

implicit def uuidQueryString: QueryStringParam[UUID]

implicit def uuidSegment: Segment[UUID]