openapi/endpoints4s.openapi/Requests

Requests

trait Requests extends Requests with Urls with Methods with Headers

Interpreter for algebra.Requests.

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

Type members

Classlikes

case class DocumentedRequest(method: Method, url: DocumentedUrl, headers: DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType])

Inherited classlikes

case object Delete extends Method
Inherited from:
Methods
case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema)
Inherited from:
Headers
case class DocumentedHeaders(value: List[DocumentedHeader])
Value parameters:
value

List of request header names (e.g. “Authorization”)

Inherited from:
Headers
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)

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

List of query string parameters

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

Inherited from:
Urls
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 from:
Urls
case object Get extends Method
Inherited from:
Methods
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
sealed trait Method
Inherited from:
Methods
case object Options extends Method
Inherited from:
Methods
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])
case object Patch extends Method
Inherited from:
Methods
implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
case object Post extends Method
Inherited from:
Methods
case object Put extends Method
Inherited from:
Methods
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls
implicit class RequestEntitySyntax[A](requestEntity: RequestEntity[A])
Inherited from:
Requests
final implicit class RequestSyntax[A](request: Request[A])

Extension methods for Request.

Extension methods for Request.

Inherited from:
Requests
implicit class SemigroupalSyntax[A, F[_]](val f: F[A])(implicit ev: Semigroupal[F])
Inherited from:
SemigroupalSyntax

Types

Inherited types

type Path[A] = DocumentedUrl
Inherited from:
Urls
type QueryString[A] = DocumentedQueryString
Inherited from:
Urls
type Segment[A] = Schema
Inherited from:
Urls
type Url[A] = DocumentedUrl
Inherited from:
Urls
type WithDefault[A] = A
Inherited from:
Urls

Value members

Concrete methods

override def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
Definition Classes
override def addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
Definition Classes
def choiceRequestEntity[A, B](requestEntityA: Map[String, MediaType], requestEntityB: Map[String, MediaType]): Map[String, MediaType]
def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Aux[A, B, AB], tuplerABC: Aux[AB, C, Out]): Request[Out]

Inherited methods

override def booleanQueryString: DocumentedQueryStringParam[Boolean]
Definition Classes
Inherited from:
Urls
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
Inherited from:
Urls
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
Inherited from:
Urls
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

Inherited from:
Requests
override def doubleQueryString: DocumentedQueryStringParam[Double]
Definition Classes
Inherited from:
Urls
override def doubleSegment: Segment[Double]
Definition Classes
Inherited from:
Urls
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

Inherited from:
Requests
override def intQueryString: DocumentedQueryStringParam[Int]
Definition Classes
Inherited from:
Urls
override def intSegment: Segment[Int]
Definition Classes
Inherited from:
Urls
override def longQueryString: DocumentedQueryStringParam[Long]
Definition Classes
Inherited from:
Urls
override def longSegment: Segment[Long]
Definition Classes
Inherited from:
Urls
override def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: DocumentedQueryStringParam[A]): QueryString[WithDefault[A]]
Definition Classes
Inherited from:
Urls
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

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

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

Inherited from:
Requests
def qs[A](name: String, docs: Documentation)(implicit value: DocumentedQueryStringParam[A]): QueryString[A]
Inherited from:
Urls
def remainingSegments(name: String, docs: Documentation): Path[String]
Inherited from:
Urls
def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
Inherited from:
Urls
def staticPathSegment(segment: String): Path[Unit]
Inherited from:
Urls
def stringSegment: Segment[String]
Inherited from:
Urls
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
Inherited from:
Urls
override def uuidQueryString: DocumentedQueryStringParam[UUID]
Definition Classes
Inherited from:
Urls
override def uuidSegment: Segment[UUID]
Definition Classes
Inherited from:
Urls

Concrete fields

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

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
final implicit def RequestEntitySyntax[A](requestEntity: RequestEntity[A]): RequestEntitySyntax[A]
Inherited from:
Requests
final implicit def RequestSyntax[A](request: Request[A]): RequestSyntax[A]

Extension methods for Request.

Extension methods for Request.

Inherited from:
Requests
final implicit def SemigroupalSyntax[A, F[_]](f: F[A])(implicit ev: Semigroupal[F]): SemigroupalSyntax[A, F]
Inherited from:
SemigroupalSyntax
implicit def optionalQueryStringParam[A](implicit param: DocumentedQueryStringParam[A]): DocumentedQueryStringParam[Option[A]]
Inherited from:
Urls
implicit def repeatedQueryStringParam[A, CC <: (Iterable)](implicit param: DocumentedQueryStringParam[A], factory: Factory[A, CC[A]]): DocumentedQueryStringParam[CC[A]]
Inherited from:
Urls