endpoints.openapi

Assets

trait Assets extends algebra.Assets with Endpoints

Interpreter for algebra.Assets

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

Type Members

  1. type AssetPath = Nothing

    Definition Classes
    Assets → Assets

  2. type AssetRequest = Nothing

    Definition Classes
    Assets → Assets

  3. type AssetResponse = Nothing

    Definition Classes
    Assets → Assets

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

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

    Definition Classes
    Requests

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

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

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

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

    Definition Classes
    Requests

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

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

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

  13. type Endpoint[A, B] = DocumentedEndpoint

    Definition Classes
    Endpoints → Endpoints

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

    Definition Classes
    InvariantFunctorSyntax

  15. sealed trait Method extends AnyRef

    Definition Classes
    Methods → Methods

  16. type Path[A] = DocumentedUrl

    Definition Classes
    Urls → Urls

  17. implicit class PathOps[A] extends AnyRef

    Definition Classes
    Urls

  18. type QueryString[A] = DocumentedQueryString

    Definition Classes
    Urls → Urls

  19. implicit class QueryStringOps[A] extends AnyRef

    Definition Classes
    Urls

  20. type QueryStringParam[A] = Schema

    Definition Classes
    Urls → Urls

  21. type Request[A] = DocumentedRequest

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Requests → Requests

  23. type RequestHeaders[A] = DocumentedHeaders

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Responses → Responses

  25. type Segment[A] = Schema

    Definition Classes
    Urls → Urls

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

    Definition Classes
    SemigroupalSyntax

  27. 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 assetSegments(name: String, description: Option[String]): Path[AssetPath]

    Definition Classes
    Assets → Assets

  14. def assetsEndpoint(url: Url[AssetPath], docs: Documentation, notFoundDocs: Documentation): Endpoint[AssetRequest, AssetResponse]

    Definition Classes
    Assets → Assets

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

    Definition Classes
    Urls → Urls

  16. def clone(): AnyRef

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

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

    Definition Classes
    Urls → Urls

  18. def digests: Map[String, String]

    Definition Classes
    Assets → Assets

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

    Definition Classes
    Urls

  20. def emptyHeaders: DocumentedHeaders

    Definition Classes
    Requests → Requests

  21. def emptyRequest: None.type

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Responses → Responses

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

    Definition Classes
    Endpoints → Endpoints

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

    Definition Classes
    AnyRef

  25. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  26. def finalize(): Unit

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

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

    Definition Classes
    Requests

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

    Definition Classes
    AnyRef → Any

  29. def hashCode(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    Requests → Requests

  31. def intQueryString: QueryStringParam[Int]

    Definition Classes
    Urls → Urls

  32. def intSegment: Segment[Int]

    Definition Classes
    Urls → Urls

  33. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  34. def longQueryString: QueryStringParam[Long]

    Definition Classes
    Urls → Urls

  35. def longSegment: Segment[Long]

    Definition Classes
    Urls → Urls

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

    Definition Classes
    AnyRef

  37. final def notify(): Unit

    Definition Classes
    AnyRef

  38. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

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

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Urls → Urls

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

    Definition Classes
    Responses → Responses

  43. val path: Path[Unit]

    Definition Classes
    Urls

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

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

    Definition Classes
    Urls → Urls

  46. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

    Definition Classes
    Requests → Requests

  47. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

    Definition Classes
    Requests → Requests

  48. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

    Definition Classes
    Requests → Requests

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

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

    Definition Classes
    Urls → Urls

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

    Definition Classes
    Urls → Urls

  52. def stringQueryString: QueryStringParam[String]

    Definition Classes
    Urls → Urls

  53. def stringSegment: Segment[String]

    Definition Classes
    Urls → Urls

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Requests → Requests

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

    Definition Classes
    Responses → Responses

  57. def toString(): String

    Definition Classes
    AnyRef → Any

  58. implicit lazy val urlInvFunctor: InvariantFunctor[Url]

    Definition Classes
    Urls → Urls

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

    Definition Classes
    Urls → Urls

  60. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Endpoints

Inherited from Responses

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from algebra.Assets

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