ChunkedEntities

trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors

Interpreter for the algebra.ChunkedEntities algebra in the endpoints.openapi family.

Source: ChunkedEntities.scala

Known Subclasses

ChunkedJsonEntities

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

ChunkedEntities
EndpointsWithCustomErrors
Responses
StatusCodes
Requests
Headers
Methods
Urls
ChunkedEntities
EndpointsWithCustomErrors
Errors
Responses
StatusCodes
Requests
SemigroupalSyntax
Methods
Urls
PartialInvariantFunctorSyntax
InvariantFunctorSyntax
AnyRef
Any

Implicitly

by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Type Members

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.
Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.
Definition Classes
InvariantFunctorSyntax
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
Definition Classes
PartialInvariantFunctorSyntax
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
Definition Classes
SemigroupalSyntax
case class CallbackDocs(method: EndpointsWithCustomErrors.Method, entity: EndpointsWithCustomErrors.RequestEntity[_], response: EndpointsWithCustomErrors.Response[_], requestDocs: Documentation = None) extends Product with Serializable
method
HTTP method used for the callback
entity
Contents of the callback message
response
Expected response
Definition Classes
EndpointsWithCustomErrors
case class EndpointDocs(summary: Documentation = None, description: Documentation = None, tags: List[String] = Nil, callbacks: Map[String, CallbacksDocs] = Map.empty, deprecated: Boolean = false) extends Product with Serializable
summary
Short description
description
Detailed description
tags
OpenAPI tags
callbacks
Callbacks indexed by event name
deprecated
Indicates whether this endpoint is deprecated or not
Definition Classes
EndpointsWithCustomErrors
implicit class ResponseSyntax[A] extends AnyRef
Extension methods for Response.
Extension methods for Response.
Definition Classes
Responses
implicit class PathOps[A] extends AnyRef
Convenient methods for Paths.
Convenient methods for Paths.
Definition Classes
Urls
implicit class QueryStringSyntax[A] extends AnyRef
Extension methods on QueryString.
Extension methods on QueryString.
Definition Classes
Urls
type CallbacksDocs = Map[String, CallbackDocs]
Callbacks indexed by URL pattern
Callbacks indexed by URL pattern
Definition Classes
EndpointsWithCustomErrors
See also
Swagger Documentation at https://swagger.io/docs/specification/callbacks/
type Chunks[A] = Unit
A stream of chunks of type A.
A stream of chunks of type A.
Definition Classes
ChunkedEntities → ChunkedEntities
abstract type ClientErrors
Errors in a request built by a client
Errors in a request built by a client
Definition Classes
Errors
type Endpoint[A, B] = DocumentedEndpoint
Information carried by an HTTP endpoint
Information carried by an HTTP endpoint
Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
type Path[A] = DocumentedUrl
An URL path carrying an A information
An URL path carrying an A information
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
type QueryString[A] = DocumentedQueryString
A query string carrying an A information
A query string carrying an A information
QueryString values can be created with the qs operation, and can be combined with the & operation:
```
val queryPageAndLang: QueryString[(Int, Option[String])] =
  qs[Int]("page") & qs[Option[String]]("lang")
```
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.
type QueryStringParam[A] = DocumentedQueryStringParam
A query string parameter codec for type A.
A query string parameter codec for type A.
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
type Request[A] = DocumentedRequest
Information carried by a whole request (headers and entity)
Information carried by a whole request (headers and entity)
Definition Classes
Requests → Requests
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax class.
type RequestEntity[A] = Map[String, MediaType]
Information carried by request entity
Information carried by request entity
Definition Classes
Requests → Requests
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax class.
type RequestHeaders[A] = DocumentedHeaders
Information carried by requests’ headers.
Information carried by requests’ headers.
You can construct values of type RequestHeaders by using the operations requestHeader, optRequestHeader, or emptyRequestHeaders.
Definition Classes
Requests → Requests
Note
This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.
type Response[A] = List[DocumentedResponse]
An HTTP response (status, headers, and entity) carrying an information of type A
An HTTP response (status, headers, and entity) carrying an information of type A
Definition Classes
Responses → Responses
Note
This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes
type ResponseEntity[A] = Map[String, MediaType]
An HTTP response entity carrying an information of type A
An HTTP response entity carrying an information of type A
Definition Classes
Responses → Responses
Note
This type has implicit methods provided by the InvariantFunctorSyntax class
type ResponseHeaders[A] = DocumentedHeaders
Information carried by responses’ headers.
Information carried by responses’ headers.
You can construct values of type ResponseHeaders by using the operations responseHeader, optResponseHeader, or emptyResponseHeaders.
Definition Classes
Responses → Responses
Note
This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.
type Segment[A] = Schema
An URL path segment codec for type A.
An URL path segment codec for type A.
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.
abstract type ServerError
Error raised by the business logic of a server
Error raised by the business logic of a server
Definition Classes
Errors
type StatusCode = Int
HTTP Status Code
HTTP Status Code
Definition Classes
StatusCodes → StatusCodes
type Url[A] = DocumentedUrl
An URL carrying an A information
An URL carrying an A information
Definition Classes
Urls → Urls
Note
This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.
case class DocumentedEndpoint(path: String, item: PathItem) extends Product with Serializable
path
Path template (e.g. “/user/{id}”)
item
Item documentation
Definition Classes
EndpointsWithCustomErrors
case class DocumentedHeader(name: String, description: Option[String], required: Boolean, schema: Schema) extends Product with Serializable
Definition Classes
Headers
case class DocumentedHeaders(value: List[DocumentedHeader]) extends Product with Serializable
value
List of request header names (e.g. “Authorization”)
Definition Classes
Headers
sealed trait Method extends AnyRef
Definition Classes
Methods
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
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
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
case class DocumentedQueryString(parameters: List[DocumentedParameter]) extends Product with Serializable
parameters
List of query string parameters
Definition Classes
Urls
case class DocumentedQueryStringParam(schema: Schema, isRequired: Boolean) extends Product with Serializable
Definition Classes
Urls
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

abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
Format of the response entity carrying the client errors.
Format of the response entity carrying the client errors.
Definition Classes
Errors
abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
Convert the ClientErrors type into the endpoints internal client error type
Convert the ClientErrors type into the endpoints internal client error type
Definition Classes
Errors
abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
Convert the endpoints internal client error type into the ClientErrors type
Convert the endpoints internal client error type into the ClientErrors type
Definition Classes
Errors
abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
Format of the response entity carrying the server error.
Format of the response entity carrying the server error.
Definition Classes
Errors
abstract def serverErrorToThrowable(serverError: ServerError): Throwable
Convert the ServerError type into the endpoints internal server error type
Convert the ServerError type into the endpoints internal server error type
Definition Classes
Errors
abstract def throwableToServerError(throwable: Throwable): ServerError
Convert the endpoints internal server error type into the ServerError type
Convert the endpoints internal server error type into the ServerError type
Definition Classes
Errors

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
def ->[B](y: B): (ChunkedEntities, B)
Implicit
This member is added by an implicit conversion from ChunkedEntities toArrowAssoc[ChunkedEntities] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def Accepted: Int
Definition Classes
StatusCodes → StatusCodes
def BadRequest: Int
Definition Classes
StatusCodes → StatusCodes
Note
You should use the badRequest constructor provided by the endpoints.algebra.Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.
def Created: Int
Definition Classes
StatusCodes → StatusCodes
def Forbidden: Int
Definition Classes
StatusCodes → StatusCodes
def InternalServerError: Int
Definition Classes
StatusCodes → StatusCodes
Note
You should use the internalServerError constructor provided by the endpoints.algebra.Responses trait to ensure that errors produced by endpoints are consistently handled by interpreters.
def NoContent: Int
Definition Classes
StatusCodes → StatusCodes
def NotFound: Int
Definition Classes
StatusCodes → StatusCodes
def NotImplemented: Int
Definition Classes
StatusCodes → StatusCodes
def OK: Int
Definition Classes
StatusCodes → StatusCodes
def Unauthorized: Int
Definition Classes
StatusCodes → StatusCodes
final def asInstanceOf[T0]: T0
Definition Classes
Any
final def badRequest[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
Bad Request (400) response, with an entity of type ClientErrors.
Bad Request (400) response, with an entity of type ClientErrors.
Definition Classes
Responses
See also
endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors
def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Definition Classes
Urls → Urls
def bytesChunksRequest: RequestEntity[Chunks[Array[Byte]]]
A request entity carrying chunks of Array[Byte] values
A request entity carrying chunks of Array[Byte] values
Definition Classes
ChunkedEntities → ChunkedEntities
def bytesChunksResponse: ResponseEntity[Chunks[Array[Byte]]]
A response entity carrying chunks of Array[Byte] values
A response entity carrying chunks of Array[Byte] values
Definition Classes
ChunkedEntities → ChunkedEntities
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
Chains the two paths
Chains the two paths
Definition Classes
Urls → Urls
def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
Alternative between two possible choices of responses.
Alternative between two possible choices of responses.
Server interpreters construct either one or the other response. Client interpreters accept either one or the other response. Documentation interpreters list all the possible responses.
Definition Classes
Responses → Responses
lazy val clientErrorsResponse: Response[ClientErrors]
Response used by the endpoints library when decoding a request fails.
Response used by the endpoints library when decoding a request fails.
The provided implementation forwards to badRequest.
Definition Classes
Errors
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
Concatenates two QueryStrings
Concatenates two QueryStrings
Definition Classes
Urls → Urls
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
Helper method to perform DELETE request
Helper method to perform DELETE request
UrlP
Payload carried by url
HeadersP
Payload carried by headers
Definition Classes
Requests
def doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Definition Classes
Urls → Urls
def doubleSegment: Segment[Double]
Segment codec for type Double
Segment codec for type Double
Definition Classes
Urls → Urls
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
Implicit conversion to get rid of intellij errors when defining paths.
Implicit conversion to get rid of intellij errors when defining paths. Effectively should not be called.
Definition Classes
Urls
See also
https://youtrack.jetbrains.com/issue/SCL-16284
lazy val emptyRequest: Map[String, MediaType]
Empty request -- request without a body.
Empty request -- request without a body. Use description of endpoints.algebra.Endpoints#endpoint to document an empty body.
Definition Classes
Requests → Requests
def emptyRequestHeaders: DocumentedHeaders
No particular information.
No particular information. Does not mean that the headers *have to* be empty. Just that, from a server point of view no information will be extracted from them, and from a client point of view no particular headers will be built in the request.
Use description of endpoints.algebra.Endpoints#endpoint to document empty headers.
Definition Classes
Requests → Requests
def emptyResponse: ResponseEntity[Unit]
Empty response entity
Empty response entity
Definition Classes
Responses → Responses
def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header. Client interpreters should ignore information carried by response headers.
Definition Classes
Responses → Responses
def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
HTTP endpoint.
HTTP endpoint.
request
Request
response
Response
docs
Documentation (used by documentation interpreters)
Definition Classes
EndpointsWithCustomErrors → EndpointsWithCustomErrors
def ensuring(cond: (ChunkedEntities) => Boolean, msg: => Any): ChunkedEntities
Implicit
This member is added by an implicit conversion from ChunkedEntities toEnsuring[ChunkedEntities] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (ChunkedEntities) => Boolean): ChunkedEntities
Implicit
This member is added by an implicit conversion from ChunkedEntities toEnsuring[ChunkedEntities] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): ChunkedEntities
Implicit
This member is added by an implicit conversion from ChunkedEntities toEnsuring[ChunkedEntities] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): ChunkedEntities
Implicit
This member is added by an implicit conversion from ChunkedEntities toEnsuring[ChunkedEntities] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from ChunkedEntities toStringFormat[ChunkedEntities] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
Helper method to perform GET request
Helper method to perform GET request
UrlP
Payload carried by url
HeadersP
Payload carried by headers
Definition Classes
Requests
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
def intQueryString: QueryStringParam[Int]
Ability to define Int query string parameters
Ability to define Int query string parameters
Definition Classes
Urls → Urls
def intSegment: Segment[Int]
Ability to define Int path segments
Ability to define Int path segments
Definition Classes
Urls → Urls
final def internalServerError[A, R](docs: Documentation = None, headers: ResponseHeaders[A] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
Internal Server Error (500) response, with an entity of type ServerError.
Internal Server Error (500) response, with an entity of type ServerError.
Definition Classes
Responses
See also
endpoints.algebra.Errors and endpoints.algebra.BuiltInErrors
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
def longQueryString: QueryStringParam[Long]
Query string parameter containing a Long value
Query string parameter containing a Long value
Definition Classes
Urls → Urls
def longSegment: Segment[Long]
Segment containing a Long value
Segment containing a Long value
Definition Classes
Urls → Urls
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
OK (200) Response with the given entity
OK (200) Response with the given entity
Definition Classes
Responses
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
def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
An optional request header
An optional request header
name
Header name (e.g., “Authorization”)
Definition Classes
Requests → Requests
def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
Response headers optionally containing a header with the given name.
Response headers optionally containing a header with the given name. Client interpreters should model the header value as Some[String], or None if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.
Definition Classes
Responses → Responses
implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
Make a query string parameter optional:
Make a query string parameter optional:
```
path / "articles" /? qs[Option[Int]]("page")
```
Client interpreters must omit optional query string parameters that are empty. Server interpreters must accept incoming requests whose optional query string parameters are missing. Server interpreters must report a failure for incoming requests whose optional query string parameters are present, but malformed.
Definition Classes
Urls → Urls
val path: Path[Unit]
An empty path.
An empty path.
Useful to begin a path definition:
```
path / "foo" / segment[Int] /? qs[String]("bar")
```
Definition Classes
Urls
implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform POST request
Helper method to perform POST request
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
docs
Request documentation
Definition Classes
Requests
final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation = None, headers: RequestHeaders[HeadersP] = emptyRequestHeaders)(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
Helper method to perform PUT request
Helper method to perform PUT request
UrlP
Payload carried by url
BodyP
Payload carried by body
HeadersP
Payload carried by headers
UrlAndBodyPTupled
Payloads of Url and Body tupled together by Tupler
Definition Classes
Requests
def qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
Builds a QueryString with one parameter.
Builds a QueryString with one parameter.
Examples:
```
qs[Int]("page")            // mandatory `page` parameter
qs[Option[String]]("lang") // optional `lang` parameter
qs[List[Long]]("id")       // repeated `id` parameter
```
A
Type of the value carried by the parameter
name
Parameter’s name
Definition Classes
Urls → Urls
implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
def remainingSegments(name: String, docs: Documentation): Path[String]
The remaining segments of the path.
The remaining segments of the path. The String value carried by this Path is still URL-encoded.
Definition Classes
Urls → Urls
implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
Support query string parameters with multiple values:
Support query string parameters with multiple values:
```
path / "articles" /? qs[List[Long]]("id")
```
Server interpreters must accept incoming requests where such parameters are missing (in such a case, its value is an empty collection), and report a failure if at least one value is malformed.
Definition Classes
Urls → Urls
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]
Request for given parameters
Request for given parameters
method
Request method
url
Request URL
entity
Request entity
docs
Request documentation
headers
Request headers
Definition Classes
Requests → Requests
implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
Requests → Requests
See also
PartialInvariantFunctorSyntax
def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
A required request header
A required request header
name
Header name (e.g., “Authorization”)
Definition Classes
Requests → Requests
implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
Requests → Requests
See also
PartialInvariantFunctorSyntax
implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
Requests → Requests
See also
SemigroupalSyntax
implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
Requests → Requests
See also
PartialInvariantFunctorSyntax
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]
Server interpreters construct a response with the given status and entity.
Server interpreters construct a response with the given status and entity. Client interpreters accept a response only if it has a corresponding status code.
statusCode
Response status code
entity
Response entity
docs
Response documentation
headers
Response headers
Definition Classes
Responses → Responses
implicit lazy val responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
Definition Classes
Responses → Responses
def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
Response headers containing a header with the given name.
Response headers containing a header with the given name. Client interpreters should model the header value as String, or fail if the response header is missing. Server interpreters should produce such a response header. Documentation interpreters should document this header.
Example:
```
val versionedResource: Endpoint[Unit, (SomeResource, String)] =
  endpoint(
    get(path / "versioned-resource"),
    ok(
      jsonResponse[SomeResource],
      headers = responseHeader("ETag")
    )
  )
```
Definition Classes
Responses → Responses
implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides xmap operation.
Provides xmap operation.
Definition Classes
Responses → Responses
See also
InvariantFunctorSyntax
implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
Responses → Responses
See also
SemigroupalSyntax
implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
Provides the operation xmap to the type Response
Provides the operation xmap to the type Response
Definition Classes
Responses → Responses
See also
InvariantFunctorSyntax
def segment[A](name: String, docs: Documentation)(implicit A: Segment[A]): Path[A]
A path segment carrying an A information
A path segment carrying an A information
Definition Classes
Urls → Urls
implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
Provides xmap and xmapPartial operations.
Provides xmap and xmapPartial operations.
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
lazy val serverErrorResponse: Response[ServerError]
Response used by the endpoints library when the business logic of an endpoint fails.
Response used by the endpoints library when the business logic of an endpoint fails.
The provided implementation forwards to internalServerError
Definition Classes
Errors
def staticPathSegment(segment: String): Path[Unit]
A path segment whose value is the given segment
A path segment whose value is the given segment
Definition Classes
Urls → Urls
def stringQueryString: QueryStringParam[String]
Ability to define String query string parameters
Ability to define String query string parameters
Definition Classes
Urls → Urls
def stringSegment: Segment[String]
Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.
Ability to define String path segments Servers should return an URL-decoded string value, and clients should take an URL-decoded string value.
Definition Classes
Urls → Urls
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def textChunksRequest: RequestEntity[Chunks[String]]
A request entity carrying chunks of String values
A request entity carrying chunks of String values
Definition Classes
ChunkedEntities → ChunkedEntities
def textChunksResponse: ResponseEntity[Chunks[String]]
A response entity carrying chunks of String values
A response entity carrying chunks of String values
Definition Classes
ChunkedEntities → ChunkedEntities
lazy val textRequest: Map[String, MediaType]
Request with a String body.
Request with a String body.
Definition Classes
Requests → Requests
def textResponse: ResponseEntity[String]
Text response entity
Text response entity
Definition Classes
Responses → Responses
def toString(): String
Definition Classes
AnyRef → Any
def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
Definition Classes
Urls
implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
Provides xmap and xmapPartial operations
Provides xmap and xmapPartial operations
Definition Classes
Urls → Urls
See also
PartialInvariantFunctorSyntax and InvariantFunctorSyntax
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
Builds an URL from the given path and query string
Builds an URL from the given path and query string
Definition Classes
Urls → Urls
def uuidQueryString: QueryStringParam[UUID]
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Definition Classes
Urls → Urls
def uuidSegment: Segment[UUID]
Ability to define UUID path segments
Ability to define UUID path segments
Definition Classes
Urls → Urls
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()
final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation = None): Response[Option[A]]
Turns a Response[A] into a Response[Option[A]].
Turns a Response[A] into a Response[Option[A]].
Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).
Definition Classes
Responses
object Delete extends Method with Product with Serializable
Definition Classes
Methods → Methods
object Get extends Method with Product with Serializable
Definition Classes
Methods → Methods
object Options extends Method with Product with Serializable
Definition Classes
Methods → Methods
object Patch extends Method with Product with Serializable
Definition Classes
Methods → Methods
object Post extends Method with Product with Serializable
Definition Classes
Methods → Methods
object Put extends Method with Product with Serializable
Definition Classes
Methods → Methods

Deprecated Value Members

def →[B](y: B): (ChunkedEntities, B)
Implicit
This member is added by an implicit conversion from ChunkedEntities toArrowAssoc[ChunkedEntities] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Packages

ChunkedEntities

trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

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 endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromChunkedEntities to StringFormat[ChunkedEntities]

Inherited by implicit conversion Ensuring fromChunkedEntities to Ensuring[ChunkedEntities]

Inherited by implicit conversion ArrowAssoc fromChunkedEntities to ArrowAssoc[ChunkedEntities]

Types

Operations

Ungrouped

Packages

ChunkedEntities

trait ChunkedEntities extends algebra.ChunkedEntities with EndpointsWithCustomErrors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

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 endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromChunkedEntities to StringFormat[ChunkedEntities]

Inherited by implicit conversion Ensuring fromChunkedEntities to Ensuring[ChunkedEntities]

Inherited by implicit conversion ArrowAssoc fromChunkedEntities to ArrowAssoc[ChunkedEntities]

Types

Operations

Ungrouped

ChunkedEntities