Trait

endpoints.openapi

Requests

Related Doc: package openapi

Permalink

trait Requests extends algebra.Requests with Urls with Methods

Interpreter for algebra.Requests.

Source
Requests.scala
Linear Supertypes
Methods, Urls, algebra.Requests, endpoints.SemigroupalSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Known Subclasses
Assets, BasicAuthentication, Endpoints, JsonEntities, JsonSchemaEntities, MuxEndpoints
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Requests
  2. Methods
  3. Urls
  4. Requests
  5. SemigroupalSyntax
  6. InvariantFunctorSyntax
  7. Methods
  8. Urls
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

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

    Permalink

    value

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

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

    Permalink

    name

    Name of the parameter

    required

    Whether this parameter is required or not (MUST be true for path parameters)

    Definition Classes
    Urls

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

    Permalink

    parameters

    List of query string parameters

    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    Urls

  6. case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, entity: Option[DocumentedRequestEntity]) extends Product with Serializable

    Permalink

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

    Permalink

    documentation

    Human readable documentation of the request entity

    content

    Map that associates each possible content-type (e.g. “text/html”) with a MediaType description

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

    Permalink

    path

    List of path segments. Left is a static segment, right i path parameter

    queryParameters

    Query string parameters

    Definition Classes
    Urls

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

    Permalink
    Definition Classes
    InvariantFunctorSyntax

  10. sealed trait Method extends AnyRef

    Permalink
    Definition Classes
    Methods

  11. type Path[A] = DocumentedUrl

    Permalink
    Definition Classes
    Urls → Urls

  12. implicit class PathOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  13. type QueryString[A] = DocumentedQueryString

    Permalink
    Definition Classes
    Urls → Urls

  14. implicit class QueryStringOps[A] extends AnyRef

    Permalink
    Definition Classes
    Urls

  15. type QueryStringParam[A] = DocumentedQueryStringParam

    Permalink
    Definition Classes
    Urls → Urls

  16. type Request[A] = DocumentedRequest

    Permalink
    Definition Classes
    Requests → Requests

  17. type RequestEntity[A] = Option[DocumentedRequestEntity]

    Permalink
    Definition Classes
    Requests → Requests

  18. type RequestHeaders[A] = DocumentedHeaders

    Permalink
    Definition Classes
    Requests → Requests

  19. type Segment[A] = Schema

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    SemigroupalSyntax

  21. type Url[A] = DocumentedUrl

    Permalink
    Definition Classes
    Urls → Urls

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. object Delete extends Method with Product with Serializable

    Permalink
    Definition Classes
    Methods → Methods

  5. object Get extends Method with Product with Serializable

    Permalink
    Definition Classes
    Methods → Methods

  6. object Options extends Method with Product with Serializable

    Permalink
    Definition Classes
    Methods → Methods

  7. object Patch extends Method with Product with Serializable

    Permalink
    Definition Classes
    Methods → Methods

  8. object Post extends Method with Product with Serializable

    Permalink
    Definition Classes
    Methods → Methods

  9. object Put extends Method with Product with Serializable

    Permalink
    Definition Classes
    Methods → Methods

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  11. def booleanQueryString: QueryStringParam[Boolean]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  13. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Requests

  16. def doubleQueryString: QueryStringParam[Double]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls

  18. def emptyHeaders: DocumentedHeaders

    Permalink
    Definition Classes
    Requests → Requests

  19. def emptyRequest: None.type

    Permalink
    Definition Classes
    Requests → Requests

  20. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  22. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

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

    Permalink
    Definition Classes
    Requests

  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  25. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

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

    Permalink
    Definition Classes
    Requests → Requests

  27. def intQueryString: QueryStringParam[Int]

    Permalink
    Definition Classes
    Urls → Urls

  28. def intSegment: Segment[Int]

    Permalink
    Definition Classes
    Urls → Urls

  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  30. def longQueryString: QueryStringParam[Long]

    Permalink
    Definition Classes
    Urls → Urls

  31. def longSegment: Segment[Long]

    Permalink
    Definition Classes
    Urls → Urls

  32. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  33. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  34. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

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

    Permalink
    Definition Classes
    Requests → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

  37. val path: Path[Unit]

    Permalink
    Definition Classes
    Urls

  38. 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]

    Permalink
    Definition Classes
    Requests

  39. 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]

    Permalink
    Definition Classes
    Requests

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  44. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Permalink
    Definition Classes
    Requests → Requests

  45. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Permalink
    Definition Classes
    Requests → Requests

  46. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Permalink
    Definition Classes
    Requests → Requests

  47. 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]

    Permalink
    Definition Classes
    Requests → Requests

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

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  50. def stringQueryString: QueryStringParam[String]

    Permalink
    Definition Classes
    Urls → Urls

  51. def stringSegment: Segment[String]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    AnyRef

  53. def textRequest(docs: Documentation): Option[DocumentedRequestEntity]

    Permalink
    Definition Classes
    Requests → Requests

  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  55. implicit lazy val urlInvFunctor: InvariantFunctor[Url]

    Permalink
    Definition Classes
    Urls → Urls

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

    Permalink
    Definition Classes
    Urls → Urls

  57. def uuidQueryString: QueryStringParam[UUID]

    Permalink
    Definition Classes
    Urls → Urls

  58. def uuidSegment: Segment[UUID]

    Permalink
    Definition Classes
    Urls → Urls

  59. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  61. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Methods

Inherited from Urls

Inherited from algebra.Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from AnyRef

Inherited from Any

Ungrouped