algebra
API
Generated with
algebra/endpoints4s/endpoints4s.algebra/Requests

Requests

endpoints4s.algebra.Requests
trait Requests extends Urls, Methods, SemigroupalSyntax

Attributes

Graph
Supertypes
trait Methods
trait Urls
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Assets
trait Endpoints
trait JsonEntities
trait JsonCodecs
trait MuxEndpoints
Show all

Members list

Type members

Classlikes

implicit class RequestEntitySyntax[A](requestEntity: RequestEntity[A])

Attributes

Supertypes
class Object
trait Matchable
class Any
final implicit class RequestSyntax[A](request: Request[A])

Extension methods for Request.

Extension methods for Request.

Attributes

Supertypes
class Object
trait Matchable
class Any

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.

Attributes

Inherited from:
InvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])

Attributes

Inherited from:
PartialInvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Attributes

Inherited from:
Urls
Supertypes
class Object
trait Matchable
class Any
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Attributes

Inherited from:
Urls
Supertypes
class Object
trait Matchable
class Any
implicit class SemigroupalSyntax[A, F[_]](val f: F[A])(implicit ev: Semigroupal[F])

Attributes

Inherited from:
SemigroupalSyntax
Supertypes
class Object
trait Matchable
class Any

Types

type Request[A]

Information carried by a whole request (headers and entity)

Information carried by a whole request (headers and entity)

Values of type Request[A] can be constructed by using the operations request, get, post, put, or delete.

  • Server interpreters raise an error if they can’t parse the incoming request 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.

Attributes

Note

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

type RequestEntity[A]

Information carried by request entity

Information carried by request entity

Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

  • Server interpreters raise an error if they can’t parse the incoming request entity 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.

Attributes

Note

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

type RequestHeaders[A]

Information carried by requests’ headers.

Information carried by requests’ headers.

You can construct values of type RequestHeaders by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.

  • Server interpreters raise an error if they can’t parse the incoming request headers 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.

Attributes

Note

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

Inherited types

type Method

HTTP Method

HTTP Method

Attributes

Inherited from:
Methods
type Path[A] <: Url[A]

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.

Attributes

Note

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

Inherited from:
Urls
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")
  • 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.

Attributes

Note

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

Inherited from:
Urls
type QueryStringParam[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.

Attributes

Note

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

Inherited from:
Urls
type Segment[A]

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.

Attributes

Note

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

Inherited from:
Urls
type Url[A]

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.

Attributes

Note

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

Inherited from:
Urls
type WithDefault[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

Attributes

Inherited from:
Urls

Value members

Abstract methods

def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]

Alternative between two possible request entities, differentiated by the Content-Type header

Alternative between two possible request entities, differentiated by the Content-Type header

Attributes

Note

If A and B are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead

  • Server interpreters accept either of the request entities
  • Client interpreters provide one of the two request entities
  • Documentation interpreters list all possible content types and their entities
def emptyRequest: RequestEntity[Unit]

Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

Attributes

def emptyRequestHeaders: RequestHeaders[Unit]

Ignore headers

Ignore headers

  • Server interpreters don’t try to parse any information from the request headers,
  • Client interpreters supply no specific headers

Use description of endpoints4s.algebra.Endpoints#endpoint to document empty headers.

Attributes

def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

An optional request header

An optional request header

Value parameters

name

Header name (e.g., “Authorization”)

Attributes

def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Request for given parameters

Request for given parameters

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Value parameters

docs

Request documentation

entity

Request entity

headers

Request headers

method

Request method

url

Request URL

Attributes

def requestHeader(name: String, docs: Documentation): RequestHeaders[String]

A required request header

A required request header

Value parameters

name

Header name (e.g., “Authorization”)

Attributes

def textRequest: RequestEntity[String]

Request with a String body.

Request with a String body.

  • Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
  • Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
  • Client interpreters supply content-type text/plain with an explicit character encoding

Attributes

Concrete methods

def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]

Add the provided headers to the request.

Add the provided headers to the request.

Attributes

def addRequestQueryString[A, Q](request: Request[A], queryString: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]

Add the provided queryString to the request.

Add the provided queryString to the request.

Attributes

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

Helper method to perform DELETE request

Helper method to perform DELETE request

Type parameters

HeadersP

Payload carried by headers

UrlP

Payload carried by url

Attributes

final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Aux[UrlP, HeadersP, Out]): Request[Out]

Helper method to perform GET request

Helper method to perform GET request

Type parameters

HeadersP

Payload carried by headers

UrlP

Payload carried by url

Attributes

final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform PATCH request

Helper method to perform PATCH request

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Value parameters

docs

Request documentation

Attributes

final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform POST request

Helper method to perform POST request

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Value parameters

docs

Request documentation

Attributes

final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform PUT request

Helper method to perform PUT request

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Attributes

Inherited methods

def Delete: Method

Attributes

Inherited from:
Methods
def Get: Method

Attributes

Inherited from:
Methods
def Options: Method

Attributes

Inherited from:
Methods
def Patch: Method

Attributes

Inherited from:
Methods
def Post: Method

Attributes

Inherited from:
Methods
def Put: Method

Attributes

Inherited from:
Methods
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

Attributes

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

Concatenates two QueryStrings

Concatenates two QueryStrings

Attributes

Inherited from:
Urls
def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]

Builds a QueryString with one optional parameter, which has a default value.

Builds a QueryString with one optional parameter, which has a default value.

Examples:

 optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1

Type parameters

A

Type of the value carried by the parameter

Value parameters

name

Parameter’s name

Attributes

Inherited from:
Urls
def qs[A](name: String, docs: Documentation)(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

Type parameters

A

Type of the value carried by the parameter

Value parameters

name

Parameter’s name

Attributes

Inherited from:
Urls
def remainingSegments(name: String, docs: Documentation): Path[String]

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

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

Attributes

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

A path segment carrying an A information

A path segment carrying an A information

Attributes

Inherited from:
Urls
def staticPathSegment(segment: String): Path[Unit]

A path segment whose value is the given segment

A path segment whose value is the given segment

Attributes

Inherited from:
Urls
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

Attributes

Inherited from:
Urls

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")

Attributes

Inherited from:
Urls

Implicits

Implicits

final implicit def RequestEntitySyntax[A](requestEntity: RequestEntity[A]): RequestEntitySyntax[A]
final implicit def RequestSyntax[A](request: Request[A]): RequestSyntax[A]

Extension methods for Request.

Extension methods for Request.

Attributes

implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Attributes

See also

PartialInvariantFunctorSyntax

implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Attributes

See also

PartialInvariantFunctorSyntax

implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]

Provides ++ operation.

Provides ++ operation.

Attributes

See also

SemigroupalSyntax

implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Attributes

See also

PartialInvariantFunctorSyntax

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.

Attributes

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

Attributes

Inherited from:
PartialInvariantFunctorSyntax
final implicit def PathOps[A](first: Path[A]): PathOps[A]

Convenient methods for Paths.

Convenient methods for Paths.

Attributes

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

Extension methods on QueryString.

Extension methods on QueryString.

Attributes

Inherited from:
Urls
final implicit def SemigroupalSyntax[A, F[_]](f: F[A])(implicit ev: Semigroupal[F]): SemigroupalSyntax[A, F]

Attributes

Inherited from:
SemigroupalSyntax
implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value

Query string parameter containing a Boolean value

Attributes

Inherited from:
Urls
implicit def doubleQueryString: QueryStringParam[Double]

Codec for query string parameters of type Double

Codec for query string parameters of type Double

Attributes

Inherited from:
Urls
implicit def doubleSegment: Segment[Double]

Path segment codec for type Double

Path segment codec for type Double

Attributes

Inherited from:
Urls
implicit def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters

Ability to define Int query string parameters

Attributes

Inherited from:
Urls
implicit def intSegment: Segment[Int]

Path segment codec for type Int

Path segment codec for type Int

Attributes

Inherited from:
Urls
implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value

Query string parameter containing a Long value

Attributes

Inherited from:
Urls
implicit def longSegment: Segment[Long]

Path segment codec for type Long

Path segment codec for type Long

Attributes

Inherited from:
Urls
implicit def optionalQueryStringParam[A : QueryStringParam]: 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, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
  • Documentation interpreters should mark the parameter as optional.

Attributes

Inherited from:
Urls
implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def repeatedQueryStringParam[A : QueryStringParam, CC <: (Iterable)](implicit evidence$2: QueryStringParam[A], factory: 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.

Attributes

Inherited from:
Urls
implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters

Ability to define String query string parameters

Attributes

Inherited from:
Urls
implicit def stringSegment: Segment[String]

Path segment codec for type String

Path segment codec for type String

  • Server interpreters should return an URL-decoded string value,
  • Client interpreters should take an URL-decoded string value.

Attributes

Inherited from:
Urls
implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

Provides xmap and xmapPartial operations

Provides xmap and xmapPartial operations

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters

Ability to define UUID query string parameters

Attributes

Inherited from:
Urls
implicit def uuidSegment: Segment[UUID]

Path segment codec for type UUID

Path segment codec for type UUID

Attributes

Inherited from:
Urls
Generated with