Packages

t

endpoints.openapi

MuxEndpoints

trait MuxEndpoints extends algebra.MuxEndpoints with Endpoints

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MuxEndpoints
  2. Endpoints
  3. Responses
  4. Requests
  5. Methods
  6. Urls
  7. MuxEndpoints
  8. Endpoints
  9. Responses
  10. Requests
  11. SemigroupalSyntax
  12. InvariantFunctorSyntax
  13. Methods
  14. Urls
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable

    path

    Path template (e.g. “/user/{id}”)

    item

    Item documentation

    Definition Classes
    Endpoints
  2. sealed trait Method extends AnyRef
    Definition Classes
    Methods
  3. type Endpoint[A, B] = DocumentedEndpoint
    Definition Classes
    Endpoints → Endpoints
  4. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  5. type MuxEndpoint[Req <: MuxRequest, Resp, Transport] = DocumentedEndpoint
    Definition Classes
    MuxEndpoints → MuxEndpoints
  6. type Path[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  7. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  8. type QueryString[A] = DocumentedQueryString
    Definition Classes
    Urls → Urls
  9. implicit class QueryStringOps[A] extends AnyRef
    Definition Classes
    Urls
  10. type QueryStringParam[A] = DocumentedQueryStringParam
    Definition Classes
    Urls → Urls
  11. type Request[A] = DocumentedRequest
    Definition Classes
    Requests → Requests
  12. type RequestEntity[A] = Option[DocumentedRequestEntity]
    Definition Classes
    Requests → Requests
  13. type RequestHeaders[A] = DocumentedHeaders
    Definition Classes
    Requests → Requests
  14. type Response[A] = List[DocumentedResponse]
    Definition Classes
    Responses → Responses
  15. implicit class ResponseExtensions[A] extends AnyRef
    Definition Classes
    Responses
  16. type Segment[A] = Schema
    Definition Classes
    Urls → Urls
  17. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  18. type Url[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  19. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
    Definition Classes
    Requests
  20. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

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

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

    Definition Classes
    Requests
  23. case class DocumentedResponse(status: Int, documentation: String, content: Map[String, MediaType]) extends Product with Serializable

    status

    Response status code (e.g. 200)

    documentation

    Human readable documentation. Not optional because its required by openapi

    content

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

    Definition Classes
    Responses
  24. 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
  25. case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

    parameters

    List of query string parameters

    Definition Classes
    Urls
  26. case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
    Definition Classes
    Urls
  27. 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 i path parameter

    queryParameters

    Query string parameters

    Definition Classes
    Urls

Value Members

  1. object Delete extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  2. object Get extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  3. object Options extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  4. object Patch extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  5. object Post extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  6. object Put extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  7. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def ##(): Int
    Definition Classes
    AnyRef → Any
  9. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls → Urls
  12. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  13. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  14. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    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]
    Definition Classes
    Requests
  16. def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls → Urls
  17. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
    Definition Classes
    Urls
  18. def emptyHeaders: DocumentedHeaders
    Definition Classes
    Requests → Requests
  19. def emptyRequest: None.type
    Definition Classes
    Requests → Requests
  20. def emptyResponse(docs: Documentation): Response[Unit]
    Definition Classes
    Responses → Responses
  21. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil): Endpoint[A, B]
    Definition Classes
    Endpoints → Endpoints
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def get[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  26. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def header(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    Requests → Requests
  29. def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls → Urls
  30. def intSegment: Segment[Int]
    Definition Classes
    Urls → Urls
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls → Urls
  33. def longSegment: Segment[Long]
    Definition Classes
    Urls → Urls
  34. def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]
    Definition Classes
    MuxEndpoints → MuxEndpoints
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def openApi(info: Info)(endpoints: DocumentedEndpoint*): OpenApi

    info

    General information about the documentation to generate

    endpoints

    The endpoints to generate the documentation for

    returns

    An OpenApi instance for the given endpoint descriptions

    Definition Classes
    Endpoints
  39. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    Requests → Requests
  40. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  41. val path: Path[Unit]
    Definition Classes
    Urls
  42. 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
  43. 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
  44. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  45. def refineQueryStringParam[A, B](pa: QueryStringParam[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): QueryStringParam[B]
    Definition Classes
    Urls → Urls
  46. def refineSegment[A, B](sa: Segment[A])(f: (A) ⇒ Option[B])(g: (B) ⇒ A): Segment[B]
    Definition Classes
    Urls → Urls
  47. 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
  48. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]
    Definition Classes
    Requests → Requests
  49. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
    Definition Classes
    Requests → Requests
  50. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Requests → Requests
  51. 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
  52. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  53. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  54. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  55. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  56. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  57. def textRequest(docs: Documentation): Option[DocumentedRequestEntity]
    Definition Classes
    Requests → Requests
  58. def textResponse(docs: Documentation): Response[String]
    Definition Classes
    Responses → Responses
  59. def toString(): String
    Definition Classes
    AnyRef → Any
  60. implicit lazy val urlInvFunctor: InvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  61. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  62. def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls → Urls
  63. def uuidSegment: Segment[UUID]
    Definition Classes
    Urls → Urls
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  67. def wheneverFound[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses → Responses

Inherited from Endpoints

Inherited from Responses

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from algebra.MuxEndpoints

Inherited from algebra.Endpoints

Inherited from algebra.Responses

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