Requests

Type Members

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

value
List of request header names (e.g. “Authorization”)
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)

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

parameters
List of query string parameters

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

Definition Classes
Urls
case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, entity: Option[DocumentedRequestEntity]) extends Product with Serializable
case class DocumentedRequestEntity(documentation: Option[String], content: Map[String, MediaType]) extends Product with Serializable

documentation
Human readable documentation of the request entity
content
Map that associates each possible content-type (e.g. “text/html”) with a MediaType description
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 is a path parameter
queryParameters
Query string parameters

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

Definition Classes
InvariantFunctorSyntax
sealed trait Method extends AnyRef

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

Definition Classes
PartialInvariantFunctorSyntax
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 Request[A] = DocumentedRequest

Definition Classes
Requests → Requests
type RequestEntity[A] = Option[DocumentedRequestEntity]

Definition Classes
Requests → Requests
type RequestHeaders[A] = DocumentedHeaders

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

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

Definition Classes
SemigroupalSyntax
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
object Delete extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Get extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Options extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Patch extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Post extends Method with Product with Serializable

Definition Classes
Methods → Methods
object Put extends Method with Product with Serializable

Definition Classes
Methods → Methods
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
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
def doubleQueryString: QueryStringParam[Double]

Definition Classes
Urls → Urls
def doubleSegment: Segment[Double]

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

Definition Classes
Urls
def emptyHeaders: DocumentedHeaders

Definition Classes
Requests → Requests
def emptyRequest: None.type

Definition Classes
Requests → Requests
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], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(name: String, docs: Documentation): RequestHeaders[String]

Definition Classes
Requests → Requests
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
def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

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

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

Definition Classes
Urls
implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

Definition Classes
Urls → Urls
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Definition Classes
Requests
final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

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

Definition Classes
Urls → Urls
implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

Definition Classes
Urls → Urls
implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

Definition Classes
Urls → Urls
def remainingSegments(name: String, docs: Documentation): Path[String]

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
implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
Requests → Requests
implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
Requests → Requests
implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

Definition Classes
Requests → Requests
def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

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

Definition Classes
Urls → Urls
implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

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 textRequest(docs: Documentation): Option[DocumentedRequestEntity]

Definition Classes
Requests → Requests
def toString(): String

Definition Classes
AnyRef → Any
implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[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 Requests extends algebra.Requests with Urls with Methods

Type Members

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

case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

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 DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, entity: Option[DocumentedRequestEntity]) extends Product with Serializable

case class DocumentedRequestEntity(documentation: Option[String], content: Map[String, MediaType]) extends Product with Serializable

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

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

sealed trait Method extends AnyRef

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

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 Request[A] = DocumentedRequest

type RequestEntity[A] = Option[DocumentedRequestEntity]

type RequestHeaders[A] = DocumentedHeaders

type Segment[A] = Schema

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

type Url[A] = DocumentedUrl

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

object Delete extends Method with Product with Serializable

object Get extends Method with Product with Serializable

object Options extends Method with Product with Serializable

object Patch extends Method with Product with Serializable

object Post extends Method with Product with Serializable

object Put extends Method with Product with Serializable

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]

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

def doubleQueryString: QueryStringParam[Double]

def doubleSegment: Segment[Double]

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

def emptyHeaders: DocumentedHeaders

def emptyRequest: None.type

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

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

final def getClass(): Class[_]

def hashCode(): Int

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

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

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

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

val path: Path[Unit]

implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

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

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

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

implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

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

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

implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]

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

implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

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