endpoints.openapi

Endpoints

trait Endpoints extends algebra.Endpoints with Requests with Responses

Interpreter for algebra.Endpoints that produces an OpenApi instance for endpoints.

Source
Endpoints.scala
Linear Supertypes
Responses, Requests, Methods, Urls, algebra.Endpoints, algebra.Responses, algebra.Requests, endpoints.SemigroupalSyntax, endpoints.InvariantFunctorSyntax, algebra.Methods, algebra.Urls, AnyRef, Any
Known Subclasses
Assets, BasicAuthentication, JsonEntities, JsonSchemaEntities, MuxEndpoints
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Endpoints
  2. Responses
  3. Requests
  4. Methods
  5. Urls
  6. Endpoints
  7. Responses
  8. Requests
  9. SemigroupalSyntax
  10. InvariantFunctorSyntax
  11. Methods
  12. Urls
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

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

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

    Definition Classes
    Requests

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

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

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

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

    Definition Classes
    Requests

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

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

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

  10. type Endpoint[A, B] = DocumentedEndpoint

    Definition Classes
    Endpoints → Endpoints

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

    Definition Classes
    InvariantFunctorSyntax

  12. sealed trait Method extends AnyRef

    Definition Classes
    Methods → Methods

  13. type Path[A] = DocumentedUrl

    Definition Classes
    Urls → Urls

  14. implicit class PathOps[A] extends AnyRef

    Definition Classes
    Urls

  15. type QueryString[A] = DocumentedQueryString

    Definition Classes
    Urls → Urls

  16. implicit class QueryStringOps[A] extends AnyRef

    Definition Classes
    Urls

  17. type QueryStringParam[A] = Schema

    Definition Classes
    Urls → Urls

  18. type Request[A] = DocumentedRequest

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Requests → Requests

  20. type RequestHeaders[A] = DocumentedHeaders

    Definition Classes
    Requests → Requests

  21. type Response[A] = List[DocumentedResponse]

    Definition Classes
    Responses → Responses

  22. type Segment[A] = Schema

    Definition Classes
    Urls → Urls

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

    Definition Classes
    SemigroupalSyntax

  24. type Url[A] = DocumentedUrl

    Definition Classes
    Urls → Urls

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. object Delete extends Method with Product with Serializable

    Definition Classes
    Methods → Methods

  7. object Get extends Method with Product with Serializable

    Definition Classes
    Methods → Methods

  8. object Options extends Method with Product with Serializable

    Definition Classes
    Methods → Methods

  9. object Patch extends Method with Product with Serializable

    Definition Classes
    Methods → Methods

  10. object Post extends Method with Product with Serializable

    Definition Classes
    Methods → Methods

  11. object Put extends Method with Product with Serializable

    Definition Classes
    Methods → Methods

  12. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

    Definition Classes
    Urls → Urls

  14. def clone(): AnyRef

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

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

    Definition Classes
    Urls → Urls

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

    Definition Classes
    Urls

  17. def emptyHeaders: DocumentedHeaders

    Definition Classes
    Requests → Requests

  18. def emptyRequest: None.type

    Definition Classes
    Requests → Requests

  19. def emptyResponse(docs: Documentation): Response[Unit]

    Definition Classes
    Responses → Responses

  20. def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation = None, description: Documentation = None): Endpoint[A, B]

    Definition Classes
    Endpoints → Endpoints

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

    Definition Classes
    AnyRef

  22. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  23. def finalize(): Unit

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

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

    Definition Classes
    Requests

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

    Definition Classes
    AnyRef → Any

  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    Requests → Requests

  28. def intQueryString: QueryStringParam[Int]

    Definition Classes
    Urls → Urls

  29. def intSegment: Segment[Int]

    Definition Classes
    Urls → Urls

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  31. def longQueryString: QueryStringParam[Long]

    Definition Classes
    Urls → Urls

  32. def longSegment: Segment[Long]

    Definition Classes
    Urls → Urls

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

    Definition Classes
    AnyRef

  34. final def notify(): Unit

    Definition Classes
    AnyRef

  35. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  36. 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

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

    Definition Classes
    Requests → Requests

  38. def optQs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

    Definition Classes
    Urls → Urls

  39. def option[A](response: Response[A], notFoundDocs: Documentation): Response[Option[A]]

    Definition Classes
    Responses → Responses

  40. val path: Path[Unit]

    Definition Classes
    Urls

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

    Definition Classes
    Requests

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

    Definition Classes
    Urls → Urls

  43. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Definition Classes
    Requests → Requests

  44. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Definition Classes
    Requests → Requests

  45. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Urls → Urls

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

    Definition Classes
    Urls → Urls

  49. def stringQueryString: QueryStringParam[String]

    Definition Classes
    Urls → Urls

  50. def stringSegment: Segment[String]

    Definition Classes
    Urls → Urls

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Requests → Requests

  53. def textResponse(docs: Documentation): Response[String]

    Definition Classes
    Responses → Responses

  54. def toString(): String

    Definition Classes
    AnyRef → Any

  55. implicit lazy val urlInvFunctor: InvariantFunctor[Url]

    Definition Classes
    Urls → Urls

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

    Definition Classes
    Urls → Urls

  57. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Responses

Inherited from Requests

Inherited from Methods

Inherited from Urls

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