Packages

t

endpoints.openapi

EndpointsWithCustomErrors

trait EndpointsWithCustomErrors extends algebra.EndpointsWithCustomErrors with Requests with Responses

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointsWithCustomErrors
  2. Responses
  3. StatusCodes
  4. Requests
  5. Methods
  6. Urls
  7. EndpointsWithCustomErrors
  8. Errors
  9. Responses
  10. StatusCodes
  11. Requests
  12. SemigroupalSyntax
  13. Methods
  14. Urls
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class CallbackDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. abstract type ClientErrors
    Definition Classes
    Errors
  4. case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable

    path

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

    item

    Item documentation

  5. type Endpoint[A, B] = DocumentedEndpoint
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  6. case class EndpointDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  7. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  8. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  9. type Path[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  10. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  11. type QueryString[A] = DocumentedQueryString
    Definition Classes
    Urls → Urls
  12. type QueryStringParam[A] = DocumentedQueryStringParam
    Definition Classes
    Urls → Urls
  13. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  14. type Request[A] = DocumentedRequest
    Definition Classes
    Requests → Requests
  15. type RequestEntity[A] = Map[String, MediaType]
    Definition Classes
    Requests → Requests
  16. type RequestHeaders[A] = DocumentedHeaders
    Definition Classes
    Requests → Requests
  17. type Response[A] = List[DocumentedResponse]
    Definition Classes
    Responses → Responses
  18. type ResponseEntity[A] = Map[String, MediaType]
    Definition Classes
    Responses → Responses
  19. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  20. type Segment[A] = Schema
    Definition Classes
    Urls → Urls
  21. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  22. abstract type ServerError
    Definition Classes
    Errors
  23. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  24. type Url[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  25. sealed trait Method extends AnyRef
    Definition Classes
    Methods
  26. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
    Definition Classes
    Requests
  27. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

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

    Definition Classes
    Requests
  28. case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType]) extends Product with Serializable
    Definition Classes
    Requests
  29. case class DocumentedResponse(status: (Responses.this)#StatusCode, documentation: String, content: Map[String, MediaType]) extends Product with Serializable

    status

    Response status code (e.g. OK or NotFound)

    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
  30. 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
  31. case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable

    parameters

    List of query string parameters

    Definition Classes
    Urls
  32. case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
    Definition Classes
    Urls
  33. 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

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  3. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  4. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  5. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  6. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    Errors

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def Accepted: Int
    Definition Classes
    StatusCodes → StatusCodes
  5. def BadRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: Int
    Definition Classes
    StatusCodes → StatusCodes
  7. def Forbidden: Int
    Definition Classes
    StatusCodes → StatusCodes
  8. def InternalServerError: Int
    Definition Classes
    StatusCodes → StatusCodes
  9. def NoContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  10. def NotFound: Int
    Definition Classes
    StatusCodes → StatusCodes
  11. def NotImplemented: Int
    Definition Classes
    StatusCodes → StatusCodes
  12. def OK: Int
    Definition Classes
    StatusCodes → StatusCodes
  13. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  14. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  15. final def badRequest(docs: Documentation): Response[ClientErrors]
    Definition Classes
    Responses
  16. def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls → Urls
  17. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  18. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    Responses → Responses
  19. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  20. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  21. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  22. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  23. def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls → Urls
  24. def doubleSegment: Segment[Double]
    Definition Classes
    Urls → Urls
  25. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
    Definition Classes
    Urls
  26. def emptyHeaders: DocumentedHeaders
    Definition Classes
    Requests → Requests
  27. lazy val emptyRequest: Map[String, MediaType]
    Definition Classes
    Requests → Requests
  28. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    Responses → Responses
  29. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  30. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  32. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  33. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  34. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  35. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def header(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    Requests → Requests
  37. def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls → Urls
  38. def intSegment: Segment[Int]
    Definition Classes
    Urls → Urls
  39. final def internalServerError(docs: Documentation): Response[ServerError]
    Definition Classes
    Responses
  40. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  41. def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls → Urls
  42. def longSegment: Segment[Long]
    Definition Classes
    Urls → Urls
  43. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  44. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  45. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def ok[A](entity: ResponseEntity[A], docs: Documentation): Response[A]
    Definition Classes
    Responses
  47. 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

  48. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    Requests → Requests
  49. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  50. val path: Path[Unit]
    Definition Classes
    Urls
  51. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  52. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  53. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  54. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  55. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  56. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  57. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  58. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  59. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]
    Definition Classes
    Requests → Requests
  60. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
    Definition Classes
    Requests → Requests
  61. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Requests → Requests
  62. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    Requests → Requests
  63. def response[A](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None): Response[A]
    Definition Classes
    Responses → Responses
  64. implicit lazy val responseInvFunctor: InvariantFunctor[Response]
    Definition Classes
    Responses → Responses
  65. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  66. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  67. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  68. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  69. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  70. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  71. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  72. lazy val textRequest: Map[String, MediaType]
    Definition Classes
    Requests → Requests
  73. def textResponse: ResponseEntity[String]
    Definition Classes
    Responses → Responses
  74. def toString(): String
    Definition Classes
    AnyRef → Any
  75. def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
    Definition Classes
    Urls
  76. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  77. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  78. def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls → Urls
  79. def uuidSegment: Segment[UUID]
    Definition Classes
    Urls → Urls
  80. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  81. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  82. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  83. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  84. object Delete extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  85. object Get extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  86. object Options extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  87. object Patch extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  88. object Post extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  89. object Put extends Method with Product with Serializable
    Definition Classes
    Methods → Methods

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Methods

Inherited from Urls

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped