Packages

t

endpoints4s.openapi

ChunkedEntities

trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors

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

Type Members

  1. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. type Chunks[A] = Unit
    Definition Classes
    ChunkedEntities → ChunkedEntities
  4. abstract type ClientErrors
    Definition Classes
    Errors
  5. type Endpoint[A, B] = DocumentedEndpoint
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  6. final class EndpointDocs extends 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. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  17. type RequestHeaders[A] = DocumentedHeaders
    Definition Classes
    Requests → Requests
  18. type Response[A] = List[DocumentedResponse]
    Definition Classes
    Responses → Responses
  19. type ResponseEntity[A] = Map[String, MediaType]
    Definition Classes
    Responses → Responses
  20. type ResponseHeaders[A] = DocumentedHeaders
    Definition Classes
    Responses → Responses
  21. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  22. type Segment[A] = Schema
    Definition Classes
    Urls → Urls
  23. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  24. abstract type ServerError
    Definition Classes
    Errors
  25. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  26. type Url[A] = DocumentedUrl
    Definition Classes
    Urls → Urls
  27. case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable

    path

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

    item

    Item documentation

    Definition Classes
    EndpointsWithCustomErrors
  28. case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
    Definition Classes
    Headers
  29. case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable

    value

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

    Definition Classes
    Headers
  30. sealed trait Method extends AnyRef
    Definition Classes
    Methods
  31. case class DocumentedRequest(method: Requests.Method, url: Requests.DocumentedUrl, headers: Requests.DocumentedHeaders, documentation: Documentation, entity: Map[String, MediaType]) extends Product with Serializable
    Definition Classes
    Requests
  32. case class DocumentedResponse(status: (Responses.this)#StatusCode, documentation: String, headers: (Responses.this)#DocumentedHeaders, 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

    headers

    Response headers documentation

    content

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

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

    parameters

    List of query string parameters

    Definition Classes
    Urls
  35. case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
    Definition Classes
    Urls
  36. 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 AlreadyReported: Int
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Int
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Int
    Definition Classes
    StatusCodes → StatusCodes
  9. def ExpectationFailed: Int
    Definition Classes
    StatusCodes → StatusCodes
  10. def FailedDependency: Int
    Definition Classes
    StatusCodes → StatusCodes
  11. def Forbidden: Int
    Definition Classes
    StatusCodes → StatusCodes
  12. def Gone: Int
    Definition Classes
    StatusCodes → StatusCodes
  13. def IMUsed: Int
    Definition Classes
    StatusCodes → StatusCodes
  14. def InternalServerError: Int
    Definition Classes
    StatusCodes → StatusCodes
  15. def LengthRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  16. def Locked: Int
    Definition Classes
    StatusCodes → StatusCodes
  17. def MethodNotAllowed: Int
    Definition Classes
    StatusCodes → StatusCodes
  18. def MisdirectedRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  19. def MultiStatus: Int
    Definition Classes
    StatusCodes → StatusCodes
  20. def NoContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  21. def NonAuthoritativeInformation: Int
    Definition Classes
    StatusCodes → StatusCodes
  22. def NotAcceptable: Int
    Definition Classes
    StatusCodes → StatusCodes
  23. def NotFound: Int
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotImplemented: Int
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotModified: Int
    Definition Classes
    StatusCodes → StatusCodes
  26. def OK: Int
    Definition Classes
    StatusCodes → StatusCodes
  27. def PartialContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  28. def PayloadTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  29. def PaymentRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  30. def PreconditionFailed: Int
    Definition Classes
    StatusCodes → StatusCodes
  31. def PreconditionRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  32. def ProxyAuthenticationRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  33. def RangeNotSatisfiable: Int
    Definition Classes
    StatusCodes → StatusCodes
  34. def RequestHeaderFieldsTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  35. def RequestTimeout: Int
    Definition Classes
    StatusCodes → StatusCodes
  36. def ResetContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  37. def TooEarly: Int
    Definition Classes
    StatusCodes → StatusCodes
  38. def TooManyRequests: Int
    Definition Classes
    StatusCodes → StatusCodes
  39. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  40. def UnavailableForLegalReasons: Int
    Definition Classes
    StatusCodes → StatusCodes
  41. def UnprocessableEntity: Int
    Definition Classes
    StatusCodes → StatusCodes
  42. def UnsupportedMediaType: Int
    Definition Classes
    StatusCodes → StatusCodes
  43. def UpgradeRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  44. def UriTooLong: Int
    Definition Classes
    StatusCodes → StatusCodes
  45. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  46. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  47. def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls → Urls
  48. def bytesChunksRequest: RequestEntity[Chunks[Array[Byte]]]
    Definition Classes
    ChunkedEntities → ChunkedEntities
  49. def bytesChunksResponse: ResponseEntity[Chunks[Array[Byte]]]
    Definition Classes
    ChunkedEntities → ChunkedEntities
  50. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  51. def choiceRequestEntity[A, B](requestEntityA: Map[String, MediaType], requestEntityB: Map[String, MediaType]): Map[String, MediaType]
    Definition Classes
    Requests → Requests
  52. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    Responses → Responses
  53. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  54. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  55. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  56. 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
  57. def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls → Urls
  58. def doubleSegment: Segment[Double]
    Definition Classes
    Urls → Urls
  59. lazy val emptyRequest: Map[String, MediaType]
    Definition Classes
    Requests → Requests
  60. def emptyRequestHeaders: DocumentedHeaders
    Definition Classes
    Requests → Requests
  61. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    Responses → Responses
  62. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    Responses → Responses
  63. def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors → EndpointsWithCustomErrors
  64. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  65. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  66. 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
  67. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  68. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  69. def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls → Urls
  70. def intSegment: Segment[Int]
    Definition Classes
    Urls → Urls
  71. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  72. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  73. def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls → Urls
  74. def longSegment: Segment[Long]
    Definition Classes
    Urls → Urls
  75. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  76. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  77. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  78. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses
  79. 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
    EndpointsWithCustomErrors
  80. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    Requests → Requests
  81. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    Responses → Responses
  82. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  83. final def patch[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
  84. val path: Path[Unit]
    Definition Classes
    Urls
  85. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  86. 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
  87. 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
  88. def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  89. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  90. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  91. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  92. 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
  93. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B] = emptyRequest, docs: Documentation = None, headers: RequestHeaders[C] = emptyRequestHeaders)(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    Requests → Requests
  94. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    Requests → Requests
  95. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    Requests → Requests
  96. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    Requests → Requests
  97. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    Requests → Requests
  98. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    Requests → Requests
  99. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses → Responses
  100. implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    Responses → Responses
  101. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    Responses → Responses
  102. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    Responses → Responses
  103. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    Responses → Responses
  104. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    Responses → Responses
  105. def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  106. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  107. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  108. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  109. def stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  110. def stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  111. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  112. def textChunksRequest: RequestEntity[Chunks[String]]
    Definition Classes
    ChunkedEntities → ChunkedEntities
  113. def textChunksResponse: ResponseEntity[Chunks[String]]
    Definition Classes
    ChunkedEntities → ChunkedEntities
  114. lazy val textRequest: Map[String, MediaType]
    Definition Classes
    Requests → Requests
  115. def textResponse: ResponseEntity[String]
    Definition Classes
    Responses → Responses
  116. def toString(): String
    Definition Classes
    AnyRef → Any
  117. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  118. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  119. def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls → Urls
  120. def uuidSegment: Segment[UUID]
    Definition Classes
    Urls → Urls
  121. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  122. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  123. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  124. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  125. object CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  126. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  127. object Delete extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  128. object Get extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  129. object Options extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  130. object Patch extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  131. object Post extends Method with Product with Serializable
    Definition Classes
    Methods → Methods
  132. object Put extends Method with Product with Serializable
    Definition Classes
    Methods → Methods

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from EndpointsWithCustomErrors

Inherited from Responses

Inherited from StatusCodes

Inherited from Requests

Inherited from Headers

Inherited from Methods

Inherited from Urls

Inherited from algebra.ChunkedEntities

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from algebra.Responses

Inherited from algebra.StatusCodes

Inherited from algebra.Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped