Assets

trait Assets extends algebra.Assets with EndpointsWithCustomErrors

Client that relies on the web browser to handle gzip compression

Source: Assets.scala

Linear Supertypes

EndpointsWithCustomErrors, StatusCodes, Methods, Urls, algebra.Assets, algebra.EndpointsWithCustomErrors, Errors, Responses, algebra.StatusCodes, Requests, endpoints.SemigroupalSyntax, algebra.Methods, algebra.Urls, endpoints.PartialInvariantFunctorSyntax, endpoints.InvariantFunctorSyntax, AnyRef, Any

Type Hierarchy

Ordering

Grouped
Alphabetic
By Inheritance

Inherited

Assets
EndpointsWithCustomErrors
StatusCodes
Methods
Urls
Assets
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
case class AssetPath(path: String, name: String) extends Product with Serializable
```
// foo/bar/baz-123abc
AssetPath("foo/bar", "baz")
```
type AssetRequest = AssetPath
As a client, we just need to give the path of the asset we are interested in, the web browser will automatically set HTTP headers to handle gzip compression (Accept-Encoding) and decompress the response.
As a client, we just need to give the path of the asset we are interested in, the web browser will automatically set HTTP headers to handle gzip compression (Accept-Encoding) and decompress the response.
Definition Classes
Assets → Assets
type AssetResponse = ArrayBuffer
As we request the asset via an XMLHttpRequest, we get its content as an ArrayBuffer
As we request the asset via an XMLHttpRequest, we get its content as an ArrayBuffer
Definition Classes
Assets → Assets
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/
abstract type ClientErrors
Errors in a request built by a client
Errors in a request built by a client
Definition Classes
Errors
type Method = String
HTTP Method
HTTP Method
Definition Classes
Methods → Methods
type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]
A function that, given information A and an XMLHttpRequest, returns a request entity.
A function that, given information A and an XMLHttpRequest, returns a request entity. Also, as a side-effect, the function can set the corresponding Content-Type header on the given XMLHttpRequest.
Definition Classes
EndpointsWithCustomErrors → Requests
type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]
A function that takes the information A and the XMLHttpRequest and sets up some headers on it.
A function that takes the information A and the XMLHttpRequest and sets up some headers on it.
Definition Classes
EndpointsWithCustomErrors → Requests
type Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]
Attempts to decode an A from an XMLHttpRequest’s response
Attempts to decode an A from an XMLHttpRequest’s response
Definition Classes
EndpointsWithCustomErrors → Responses
type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
An HTTP response entity carrying an information of type A
An HTTP response entity carrying an information of type A
Definition Classes
EndpointsWithCustomErrors → Responses
Note
This type has implicit methods provided by the InvariantFunctorSyntax class
type ResponseHeaders[A] = (XMLHttpRequest) => Validated[A]
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
EndpointsWithCustomErrors → Responses
Note
This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.
abstract type Result[A]
A value that eventually yields an A.
A value that eventually yields an A.
Typically, concrete representation of Result will have an instance of MonadError, so that we can perform requests (sequentially and in parallel) and recover errors.
Definition Classes
EndpointsWithCustomErrors
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
abstract class Endpoint[A, B] extends AnyRef
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
Definition Classes
EndpointsWithCustomErrors
trait Request[A] extends AnyRef
A function that takes the information A and returns an XMLHttpRequest with an optional request entity.
A function that takes the information A and returns an XMLHttpRequest with an optional request entity. If provided, the request entity must be compatible with the send method of XMLHttpRequest.
Definition Classes
EndpointsWithCustomErrors
trait Path[A] extends Url[A]
Builds an URL path from an A
Builds an URL path from an A
Definition Classes
Urls
trait QueryString[A] extends AnyRef
Defines how to build a query string from an A
Defines how to build a query string from an A
Definition Classes
Urls
trait QueryStringParam[A] extends AnyRef
Defines how to build a query string parameter value from an A
Defines how to build a query string parameter value from an A
Definition Classes
Urls
trait Segment[A] extends AnyRef
Defines how to build a path segment from an A
Defines how to build a path segment from an A
Definition Classes
Urls
trait Url[A] extends AnyRef
Builds an URL from an A
Builds an URL from an A
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 digests: Map[String, String]
The digests of the assets
The digests of the assets
Definition Classes
Assets
abstract 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
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): (Assets, B)
Implicit
This member is added by an implicit conversion from Assets toArrowAssoc[Assets] 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 Delete: String
Definition Classes
Methods → Methods
def Forbidden: Int
Definition Classes
StatusCodes → StatusCodes
def Get: String
Definition Classes
Methods → Methods
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 Options: String
Definition Classes
Methods → Methods
def Patch: String
Definition Classes
Methods → Methods
def Post: String
Definition Classes
Methods → Methods
def Put: String
Definition Classes
Methods → Methods
def Unauthorized: Int
Definition Classes
StatusCodes → StatusCodes
final def asInstanceOf[T0]: T0
Definition Classes
Any
def asset(path: String, name: String): AssetRequest
Convenient constructor for building an AssetRequest from its path and name.
Convenient constructor for building an AssetRequest from its path and name.
```
myAssetsEndpoint(asset("foo/bar", "baz"))
```
def assetSegments(name: String, docs: Documentation): Path[AssetPath]
Encodes an AssetPath as a request path.
Encodes an AssetPath as a request path. Throws an exception if the asset digest is not found.
Definition Classes
Assets → Assets
def assetsEndpoint(url: Url[AssetPath], docs: Documentation, notFoundDocs: Documentation): Endpoint[AssetRequest, AssetResponse]
An endpoint for requesting assets.
An endpoint for requesting assets.
If the server fails to find the requested asset, this endpoint returns a failed response.
url
URL description
docs
description of a response when asset is found. Required by openapi
notFoundDocs
description of a not found asset response. Required by openapi
returns
An HTTP endpoint for requesting assets
Definition Classes
Assets → Assets
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
implicit def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Definition Classes
Urls
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
EndpointsWithCustomErrors → 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
implicit def doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Definition Classes
Urls
implicit def doubleSegment: Segment[Double]
Segment codec for type Double
Segment codec for type Double
Definition Classes
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: RequestEntity[Unit]
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
EndpointsWithCustomErrors → Requests
lazy val emptyRequestHeaders: RequestHeaders[Unit]
Sets up no headers on the given XMLHttpRequest
Sets up no headers on the given XMLHttpRequest
Definition Classes
EndpointsWithCustomErrors → Requests
def emptyResponse: ResponseEntity[Unit]
Discards response entity
Discards response entity
Definition Classes
EndpointsWithCustomErrors → Responses
def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header. Client interpreters should ignore information carried by response headers.
Definition Classes
EndpointsWithCustomErrors → Responses
def ensuring(cond: (Assets) => Boolean, msg: => Any): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Assets) => Boolean): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] 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 Assets toStringFormat[Assets] 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()
implicit def intQueryString: QueryStringParam[Int]
Ability to define Int query string parameters
Ability to define Int query string parameters
Definition Classes
Urls
implicit def intSegment: Segment[Int]
Ability to define Int path segments
Ability to define Int path segments
Definition Classes
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
implicit def longQueryString: QueryStringParam[Long]
Query string parameter containing a Long value
Query string parameter containing a Long value
Definition Classes
Urls
implicit def longSegment: Segment[Long]
Segment containing a Long value
Segment containing a Long value
Definition Classes
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 optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
An optional request header
An optional request header
name
Header name (e.g., “Authorization”)
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → 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 performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) => Unit, onerror: (XMLHttpRequest) => Unit): Unit
Attributes
protected
Definition Classes
EndpointsWithCustomErrors
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 param: 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], docs: Documentation, headers: RequestHeaders[C])(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
EndpointsWithCustomErrors → Requests
implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Requests
implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
SemigroupalSyntax
implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(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
EndpointsWithCustomErrors → Responses
implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides xmap operation.
Provides xmap operation.
Definition Classes
EndpointsWithCustomErrors → Responses
See also
InvariantFunctorSyntax
implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
See also
InvariantFunctorSyntax
def segment[A](name: String, docs: Documentation)(implicit s: 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 stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
Definition Classes
EndpointsWithCustomErrors
implicit lazy val stringQueryString: QueryStringParam[String]
Ability to define String query string parameters
Ability to define String query string parameters
Definition Classes
Urls → Urls
implicit lazy val 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
lazy val textRequest: RequestEntity[String]
Request with a String body.
Request with a String body.
Definition Classes
EndpointsWithCustomErrors → Requests
def textResponse: ResponseEntity[String]
Decodes a text entity
Decodes a text entity
Definition Classes
EndpointsWithCustomErrors → 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
implicit def uuidQueryString: QueryStringParam[UUID]
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Definition Classes
Urls
implicit def uuidSegment: Segment[UUID]
Ability to define UUID path segments
Ability to define UUID path segments
Definition Classes
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

Deprecated Value Members

def →[B](y: B): (Assets, B)
Implicit
This member is added by an implicit conversion from Assets toArrowAssoc[Assets] 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.

Inherited from EndpointsWithCustomErrors

Value Members

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
EndpointsWithCustomErrors → Responses
lazy val emptyRequest: RequestEntity[Unit]
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
EndpointsWithCustomErrors → Requests
lazy val emptyRequestHeaders: RequestHeaders[Unit]
Sets up no headers on the given XMLHttpRequest
Sets up no headers on the given XMLHttpRequest
Definition Classes
EndpointsWithCustomErrors → Requests
def emptyResponse: ResponseEntity[Unit]
Discards response entity
Discards response entity
Definition Classes
EndpointsWithCustomErrors → Responses
def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header. Client interpreters should ignore information carried by response headers.
Definition Classes
EndpointsWithCustomErrors → Responses
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
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) => Unit, onerror: (XMLHttpRequest) => Unit): Unit
Attributes
protected
Definition Classes
EndpointsWithCustomErrors
def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(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
EndpointsWithCustomErrors → Requests
implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Requests
implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
SemigroupalSyntax
implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(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
EndpointsWithCustomErrors → Responses
implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides xmap operation.
Provides xmap operation.
Definition Classes
EndpointsWithCustomErrors → Responses
See also
InvariantFunctorSyntax
implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
See also
InvariantFunctorSyntax
def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
Definition Classes
EndpointsWithCustomErrors
lazy val textRequest: RequestEntity[String]
Request with a String body.
Request with a String body.
Definition Classes
EndpointsWithCustomErrors → Requests
def textResponse: ResponseEntity[String]
Decodes a text entity
Decodes a text entity
Definition Classes
EndpointsWithCustomErrors → Responses

Inherited from StatusCodes

Value Members

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

Inherited from Methods

Value Members

def Delete: String
Definition Classes
Methods → Methods
def Get: String
Definition Classes
Methods → Methods
def Options: String
Definition Classes
Methods → Methods
def Patch: String
Definition Classes
Methods → Methods
def Post: String
Definition Classes
Methods → Methods
def Put: String
Definition Classes
Methods → Methods

Inherited from Urls

Value Members

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 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
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
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
def qs[A](name: String, docs: Documentation)(implicit param: 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 segment[A](name: String, docs: Documentation)(implicit s: 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
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
implicit lazy val stringQueryString: QueryStringParam[String]
Ability to define String query string parameters
Ability to define String query string parameters
Definition Classes
Urls → Urls
implicit lazy val 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
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

Inherited from algebra.Assets

Value Members

abstract def digests: Map[String, String]
The digests of the assets
The digests of the assets
Definition Classes
Assets

Inherited from algebra.EndpointsWithCustomErrors

Value Members

abstract 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

Inherited from Errors

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

Inherited from Responses

Value Members

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

Inherited from Requests

Value Members

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

Inherited from algebra.Urls

Value Members

implicit def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Definition Classes
Urls
implicit def doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Definition Classes
Urls
implicit def doubleSegment: Segment[Double]
Segment codec for type Double
Segment codec for type Double
Definition Classes
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
implicit def intQueryString: QueryStringParam[Int]
Ability to define Int query string parameters
Ability to define Int query string parameters
Definition Classes
Urls
implicit def intSegment: Segment[Int]
Ability to define Int path segments
Ability to define Int path segments
Definition Classes
Urls
implicit def longQueryString: QueryStringParam[Long]
Query string parameter containing a Long value
Query string parameter containing a Long value
Definition Classes
Urls
implicit def longSegment: Segment[Long]
Segment containing a Long value
Segment containing a Long value
Definition Classes
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
def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
Definition Classes
Urls
implicit def uuidQueryString: QueryStringParam[UUID]
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Definition Classes
Urls
implicit def uuidSegment: Segment[UUID]
Ability to define UUID path segments
Ability to define UUID path segments
Definition Classes
Urls

Inherited from AnyRef

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
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])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
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 synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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()

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Inherited by implicit conversion StringFormat fromAssets to StringFormat[Assets]

Value Members

def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from Assets toStringFormat[Assets] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

Inherited by implicit conversion Ensuring fromAssets to Ensuring[Assets]

Value Members

def ensuring(cond: (Assets) => Boolean, msg: => Any): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Assets) => Boolean): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc fromAssets to ArrowAssoc[Assets]

Value Members

def ->[B](y: B): (Assets, B)
Implicit
This member is added by an implicit conversion from Assets toArrowAssoc[Assets] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (Assets, B)
Implicit
This member is added by an implicit conversion from Assets toArrowAssoc[Assets] 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.

Types

Types introduced by the algebra

type AssetRequest = AssetPath
As a client, we just need to give the path of the asset we are interested in, the web browser will automatically set HTTP headers to handle gzip compression (Accept-Encoding) and decompress the response.
As a client, we just need to give the path of the asset we are interested in, the web browser will automatically set HTTP headers to handle gzip compression (Accept-Encoding) and decompress the response.
Definition Classes
Assets → Assets
type AssetResponse = ArrayBuffer
As we request the asset via an XMLHttpRequest, we get its content as an ArrayBuffer
As we request the asset via an XMLHttpRequest, we get its content as an ArrayBuffer
Definition Classes
Assets → Assets
abstract type ClientErrors
Errors in a request built by a client
Errors in a request built by a client
Definition Classes
Errors
type Method = String
HTTP Method
HTTP Method
Definition Classes
Methods → Methods
type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]
A function that, given information A and an XMLHttpRequest, returns a request entity.
A function that, given information A and an XMLHttpRequest, returns a request entity. Also, as a side-effect, the function can set the corresponding Content-Type header on the given XMLHttpRequest.
Definition Classes
EndpointsWithCustomErrors → Requests
type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]
A function that takes the information A and the XMLHttpRequest and sets up some headers on it.
A function that takes the information A and the XMLHttpRequest and sets up some headers on it.
Definition Classes
EndpointsWithCustomErrors → Requests
type Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]
Attempts to decode an A from an XMLHttpRequest’s response
Attempts to decode an A from an XMLHttpRequest’s response
Definition Classes
EndpointsWithCustomErrors → Responses
type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
An HTTP response entity carrying an information of type A
An HTTP response entity carrying an information of type A
Definition Classes
EndpointsWithCustomErrors → Responses
Note
This type has implicit methods provided by the InvariantFunctorSyntax class
type ResponseHeaders[A] = (XMLHttpRequest) => Validated[A]
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
EndpointsWithCustomErrors → Responses
Note
This type has implicit methods provided by the SemigroupalSyntax and 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

Operations

Operations creating and transforming values

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

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 digests: Map[String, String]
The digests of the assets
The digests of the assets
Definition Classes
Assets
abstract 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
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
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 Delete: String
Definition Classes
Methods → Methods
def Forbidden: Int
Definition Classes
StatusCodes → StatusCodes
def Get: String
Definition Classes
Methods → Methods
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 Options: String
Definition Classes
Methods → Methods
def Patch: String
Definition Classes
Methods → Methods
def Post: String
Definition Classes
Methods → Methods
def Put: String
Definition Classes
Methods → Methods
def Unauthorized: Int
Definition Classes
StatusCodes → StatusCodes
def assetSegments(name: String, docs: Documentation): Path[AssetPath]
Encodes an AssetPath as a request path.
Encodes an AssetPath as a request path. Throws an exception if the asset digest is not found.
Definition Classes
Assets → Assets
def assetsEndpoint(url: Url[AssetPath], docs: Documentation, notFoundDocs: Documentation): Endpoint[AssetRequest, AssetResponse]
An endpoint for requesting assets.
An endpoint for requesting assets.
If the server fails to find the requested asset, this endpoint returns a failed response.
url
URL description
docs
description of a response when asset is found. Required by openapi
notFoundDocs
description of a not found asset response. Required by openapi
returns
An HTTP endpoint for requesting assets
Definition Classes
Assets → Assets
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
implicit def booleanQueryString: QueryStringParam[Boolean]
Query string parameter containing a Boolean value
Query string parameter containing a Boolean value
Definition Classes
Urls
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
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
implicit def doubleQueryString: QueryStringParam[Double]
Codec for query string parameters of type Double
Codec for query string parameters of type Double
Definition Classes
Urls
implicit def doubleSegment: Segment[Double]
Segment codec for type Double
Segment codec for type Double
Definition Classes
Urls
lazy val emptyRequest: RequestEntity[Unit]
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
EndpointsWithCustomErrors → Requests
lazy val emptyRequestHeaders: RequestHeaders[Unit]
Sets up no headers on the given XMLHttpRequest
Sets up no headers on the given XMLHttpRequest
Definition Classes
EndpointsWithCustomErrors → Requests
def emptyResponse: ResponseEntity[Unit]
Discards response entity
Discards response entity
Definition Classes
EndpointsWithCustomErrors → Responses
def emptyResponseHeaders: ResponseHeaders[Unit]
No particular response header.
No particular response header. Client interpreters should ignore information carried by response headers.
Definition Classes
EndpointsWithCustomErrors → Responses
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
implicit def intQueryString: QueryStringParam[Int]
Ability to define Int query string parameters
Ability to define Int query string parameters
Definition Classes
Urls
implicit def intSegment: Segment[Int]
Ability to define Int path segments
Ability to define Int path segments
Definition Classes
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
implicit def longQueryString: QueryStringParam[Long]
Query string parameter containing a Long value
Query string parameter containing a Long value
Definition Classes
Urls
implicit def longSegment: Segment[Long]
Segment containing a Long value
Segment containing a Long value
Definition Classes
Urls
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 optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
An optional request header
An optional request header
name
Header name (e.g., “Authorization”)
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → 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
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 param: 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
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], docs: Documentation, headers: RequestHeaders[C])(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
EndpointsWithCustomErrors → Requests
def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
A required request header
A required request header
name
Header name (e.g., “Authorization”)
Definition Classes
EndpointsWithCustomErrors → Requests
def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(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
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
A path segment carrying an A information
A path segment carrying an A information
Definition Classes
Urls → Urls
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
implicit lazy val stringQueryString: QueryStringParam[String]
Ability to define String query string parameters
Ability to define String query string parameters
Definition Classes
Urls → Urls
implicit lazy val 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
lazy val textRequest: RequestEntity[String]
Request with a String body.
Request with a String body.
Definition Classes
EndpointsWithCustomErrors → Requests
def textResponse: ResponseEntity[String]
Decodes a text entity
Decodes a text entity
Definition Classes
EndpointsWithCustomErrors → Responses
implicit def uuidQueryString: QueryStringParam[UUID]
Ability to define UUID query string parameters
Ability to define UUID query string parameters
Definition Classes
Urls
implicit def uuidSegment: Segment[UUID]
Ability to define UUID path segments
Ability to define UUID path segments
Definition Classes
Urls
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

Ungrouped

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
case class AssetPath(path: String, name: String) extends Product with Serializable
```
// foo/bar/baz-123abc
AssetPath("foo/bar", "baz")
```
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/
abstract type Result[A]
A value that eventually yields an A.
A value that eventually yields an A.
Typically, concrete representation of Result will have an instance of MonadError, so that we can perform requests (sequentially and in parallel) and recover errors.
Definition Classes
EndpointsWithCustomErrors
abstract class Endpoint[A, B] extends AnyRef
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
A function that takes the information needed to build a request and returns a task yielding the information carried by the response.
Definition Classes
EndpointsWithCustomErrors
trait Request[A] extends AnyRef
A function that takes the information A and returns an XMLHttpRequest with an optional request entity.
A function that takes the information A and returns an XMLHttpRequest with an optional request entity. If provided, the request entity must be compatible with the send method of XMLHttpRequest.
Definition Classes
EndpointsWithCustomErrors
trait Path[A] extends Url[A]
Builds an URL path from an A
Builds an URL path from an A
Definition Classes
Urls
trait QueryString[A] extends AnyRef
Defines how to build a query string from an A
Defines how to build a query string from an A
Definition Classes
Urls
trait QueryStringParam[A] extends AnyRef
Defines how to build a query string parameter value from an A
Defines how to build a query string parameter value from an A
Definition Classes
Urls
trait Segment[A] extends AnyRef
Defines how to build a path segment from an A
Defines how to build a path segment from an A
Definition Classes
Urls
trait Url[A] extends AnyRef
Builds an URL from an A
Builds an URL from an A
Definition Classes
Urls

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
def ->[B](y: B): (Assets, B)
Implicit
This member is added by an implicit conversion from Assets toArrowAssoc[Assets] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def asset(path: String, name: String): AssetRequest
Convenient constructor for building an AssetRequest from its path and name.
Convenient constructor for building an AssetRequest from its path and name.
```
myAssetsEndpoint(asset("foo/bar", "baz"))
```
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
EndpointsWithCustomErrors → Responses
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
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
def ensuring(cond: (Assets) => Boolean, msg: => Any): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (Assets) => Boolean): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): Assets
Implicit
This member is added by an implicit conversion from Assets toEnsuring[Assets] 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 Assets toStringFormat[Assets] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
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()
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 performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) => Unit, onerror: (XMLHttpRequest) => Unit): Unit
Attributes
protected
Definition Classes
EndpointsWithCustomErrors
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
implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
SemigroupalSyntax
implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
Provides the operations xmap and xmapPartial.
Provides the operations xmap and xmapPartial.
Definition Classes
EndpointsWithCustomErrors → Requests
See also
PartialInvariantFunctorSyntax
implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
Definition Classes
EndpointsWithCustomErrors → Responses
implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
Provides xmap operation.
Provides xmap operation.
Definition Classes
EndpointsWithCustomErrors → Responses
See also
InvariantFunctorSyntax
implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
Provides ++ operation.
Provides ++ operation.
Definition Classes
EndpointsWithCustomErrors → 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
EndpointsWithCustomErrors → Responses
See also
InvariantFunctorSyntax
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
def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
Definition Classes
EndpointsWithCustomErrors
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
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
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()
def →[B](y: B): (Assets, B)
Implicit
This member is added by an implicit conversion from Assets toArrowAssoc[Assets] 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

Assets

trait Assets extends algebra.Assets with EndpointsWithCustomErrors

Type Members

Abstract Value Members

Concrete Value Members

Deprecated Value Members

Inherited from EndpointsWithCustomErrors

Value Members

Inherited from StatusCodes

Value Members

Inherited from Methods

Value Members

Inherited from Urls

Value Members

Inherited from algebra.Assets

Value Members

Inherited from algebra.EndpointsWithCustomErrors

Value Members

Inherited from Errors

Value Members

Inherited from Responses

Value Members

Inherited from Requests

Value Members

Inherited from algebra.Urls

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion StringFormat fromAssets to StringFormat[Assets]

Value Members

Inherited by implicit conversion Ensuring fromAssets to Ensuring[Assets]

Value Members

Inherited by implicit conversion ArrowAssoc fromAssets to ArrowAssoc[Assets]

Value Members

Types

Operations

Ungrouped

Assets