sttp-client
API
Generated with
sttp-client/endpoints4s.sttp/endpoints4s.sttp.client/BasicAuthentication

BasicAuthentication

endpoints4s.sttp.client.BasicAuthentication
trait BasicAuthentication[R[_]] extends BasicAuthentication

Attributes

Graph
Supertypes
trait Errors
trait Responses
trait StatusCodes
trait Requests
trait Methods
trait Urls
class Object
trait Matchable
class Any
Show all
Self type

Members list

Type members

Inherited classlikes

final class CallbackDocs extends Serializable

Value parameters

entity

Contents of the callback message

method

HTTP method used for the callback

response

Expected response

Attributes

Inherited from:
EndpointsWithCustomErrors
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object CallbackDocs

Attributes

Inherited from:
EndpointsWithCustomErrors
Supertypes
class Object
trait Matchable
class Any
final class EndpointDocs extends Serializable

Value parameters

callbacks

Callbacks indexed by event name

deprecated

Indicates whether this endpoint is deprecated or not

description

Detailed description

operationId

A unique identifier which identifies this operation

summary

Short description

tags

OpenAPI tags

Attributes

Inherited from:
EndpointsWithCustomErrors
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object EndpointDocs

Attributes

Inherited from:
EndpointsWithCustomErrors
Supertypes
class Object
trait Matchable
class Any
final implicit class EndpointSyntax[A, B](endpoint: Endpoint[A, B])

Extension methods for Endpoint.

Extension methods for Endpoint.

Attributes

Inherited from:
EndpointsWithCustomErrors
Supertypes
class Object
trait Matchable
class Any
implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

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.

Attributes

Inherited from:
InvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])

Attributes

Inherited from:
PartialInvariantFunctorSyntax
Supertypes
class Object
trait Matchable
class Any
implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Attributes

Inherited from:
Urls
Supertypes
class Object
trait Matchable
class Any
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Attributes

Inherited from:
Urls
Supertypes
class Object
trait Matchable
class Any
implicit class RequestEntitySyntax[A](requestEntity: RequestEntity[A])

Attributes

Inherited from:
Requests
Supertypes
class Object
trait Matchable
class Any
final implicit class RequestSyntax[A](request: Request[A])

Extension methods for Request.

Extension methods for Request.

Attributes

Inherited from:
Requests
Supertypes
class Object
trait Matchable
class Any
implicit class ResponseSyntax[A](response: Response[A])

Extension methods for Response.

Extension methods for Response.

Attributes

Inherited from:
Responses
Supertypes
class Object
trait Matchable
class Any
implicit class SemigroupalSyntax[A, F[_]](val f: F[A])(implicit ev: Semigroupal[F])

Attributes

Inherited from:
SemigroupalSyntax
Supertypes
class Object
trait Matchable
class Any

Inherited types

type CallbacksDocs = Map[String, CallbackDocs]

Callbacks indexed by URL pattern

Callbacks indexed by URL pattern

Attributes

See also
Inherited from:
EndpointsWithCustomErrors
type ClientErrors

Errors in a request built by a client

Errors in a request built by a client

Attributes

Inherited from:
Errors
type Endpoint[A, B]

Information carried by an HTTP endpoint

Information carried by an HTTP endpoint

Values of type Endpoint can be constructed by using the operation endpoint.

Type parameters

A

Information carried by the request

B

Information carried by the response

Attributes

Note

This type has implicit methods provided by the EndpointSyntax class

Inherited from:
EndpointsWithCustomErrors
type Method

HTTP Method

HTTP Method

Attributes

Inherited from:
Methods
type Path[A] <: Url[A]

An URL path carrying an A information

An URL path carrying an A information

Values of type Path[A] can be constructed by the operations path, segment, and remainingSegments.

 path / "user" / segment[UUID]("id")
  • Server interpreters raise an error if they can’t parse the incoming request path as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

Attributes

Note

This type has implicit methods provided by the PathOps, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

Inherited from:
Urls
type QueryString[A]

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")
  • Server interpreters raise an error if they can’t parse the incoming request query string parameters as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

Attributes

Note

This type has implicit methods provided by the QueryStringSyntax, InvariantFunctorSyntax, and the PartialInvariantFunctorSyntax classes.

Inherited from:
Urls
type QueryStringParam[A]

A query string parameter codec for type A.

A query string parameter codec for type A.

The trait Urls provides implicit instances of type QueryStringParam[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

Inherited from:
Urls
type Request[A]

Information carried by a whole request (headers and entity)

Information carried by a whole request (headers and entity)

Values of type Request[A] can be constructed by using the operations request, get, post, put, or delete.

  • Server interpreters raise an error if they can’t parse the incoming request as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestSyntax classes.

Inherited from:
Requests
type RequestEntity[A]

Information carried by request entity

Information carried by request entity

Values of type RequestEntity[A] can be constructed by using the operations emptyRequest or textRequest. Additional types of request entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

  • Server interpreters raise an error if they can’t parse the incoming request entity as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and RequestEntitySyntax classes.

Inherited from:
Requests
type RequestHeaders[A]

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.

  • Server interpreters raise an error if they can’t parse the incoming request headers as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

Attributes

Note

This type has implicit methods provided by the SemigroupalSyntax and PartialInvariantFunctorSyntax classes.

Inherited from:
Requests
type Response[A]

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

Values of type Response[A] can be constructed by using the operations ok, badRequest, internalServerError, or the more general operation response.

Attributes

Note

This type has implicit methods provided by the InvariantFunctorSyntax and ResponseSyntax classes

Inherited from:
Responses
type ResponseEntity[A]

An HTTP response entity carrying an information of type A

An HTTP response entity carrying an information of type A

Values of type ResponseEntity can be constructed by using the operations emptyResponse or textResponse. Additional types of response entities are provided by other algebra modules, such as JsonEntities or ChunkedEntities.

Attributes

Note

This type has implicit methods provided by the InvariantFunctorSyntax class

Inherited from:
Responses
type ResponseHeaders[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.

Attributes

Note

This type has implicit methods provided by the SemigroupalSyntax and InvariantFunctorSyntax classes.

Inherited from:
Responses
type Segment[A]

An URL path segment codec for type A.

An URL path segment codec for type A.

The trait Urls provides implicit instances of Segment[A] for basic types (e.g., Int, String, etc.). You can create additional instances by transforming or refining the existing instances with xmap and xmapPartial.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and the InvariantFunctorSyntax classes.

Inherited from:
Urls
type ServerError

Error raised by the business logic of a server

Error raised by the business logic of a server

Attributes

Inherited from:
Errors
type StatusCode

HTTP Status Code

HTTP Status Code

Attributes

Inherited from:
StatusCodes
type Url[A]

An URL carrying an A information

An URL carrying an A information

Values of type URL[A] are typically constructed by first using the path constructor and then chaining it with segments and query parameters.

 path / "users" / segment[UUID]("id") /? qs[String]("apiKey")
  • Server interpreters raise an error if they can’t parse the incoming request URL as a value of type A. By default, they produce a Bad Request (400) response with a list of error messages in a JSON array. Refer to the documentation of your server interpreter to customize this behavior.

Attributes

Note

This type has implicit methods provided by the PartialInvariantFunctorSyntax and InvariantFunctorSyntax classes.

Inherited from:
Urls
type WithDefault[A]

This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

This type is necessary to express different perspectives of servers and clients on optional query string parameters with default value:

  • Client interpreters should define it as Option[A] and omit query string parameters with default value that are empty
  • Server interpreters should define it as A and accept incoming requests whose query string parameters with default value are missing, while providing the defined default value
  • Documentation interpreters should mark the parameter as optional and document the provided default value

Attributes

Inherited from:
Urls

Value members

Inherited methods

def Accepted: StatusCode

Attributes

Inherited from:
StatusCodes
def AlreadyReported: StatusCode

Attributes

Inherited from:
StatusCodes
def BadRequest: StatusCode

Attributes

Note

You should use the badRequest constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

Inherited from:
StatusCodes
def Conflict: StatusCode

Attributes

Inherited from:
StatusCodes
def Created: StatusCode

Attributes

Inherited from:
StatusCodes
def Delete: Method

Attributes

Inherited from:
Methods
def ExpectationFailed: StatusCode

Attributes

Inherited from:
StatusCodes
def FailedDependency: StatusCode

Attributes

Inherited from:
StatusCodes
def Forbidden: StatusCode

Attributes

Inherited from:
StatusCodes
def Get: Method

Attributes

Inherited from:
Methods
def Gone: StatusCode

Attributes

Inherited from:
StatusCodes
def IMUsed: StatusCode

Attributes

Inherited from:
StatusCodes
def InternalServerError: StatusCode

Attributes

Note

You should use the internalServerError constructor provided by the endpoints4s.algebra.Responses trait to ensure that errors produced by endpoints4s are consistently handled by interpreters.

Inherited from:
StatusCodes
def LengthRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def Locked: StatusCode

Attributes

Inherited from:
StatusCodes
def MethodNotAllowed: StatusCode

Attributes

Inherited from:
StatusCodes
def MisdirectedRequest: StatusCode

Attributes

Inherited from:
StatusCodes
def MultiStatus: StatusCode

Attributes

Inherited from:
StatusCodes
def NoContent: StatusCode

Attributes

Inherited from:
StatusCodes
def NonAuthoritativeInformation: StatusCode

Attributes

Inherited from:
StatusCodes
def NotAcceptable: StatusCode

Attributes

Inherited from:
StatusCodes
def NotFound: StatusCode

Attributes

Inherited from:
StatusCodes
def NotImplemented: StatusCode

Attributes

Inherited from:
StatusCodes
def NotModified: StatusCode

Attributes

Inherited from:
StatusCodes
def OK: StatusCode

Attributes

Inherited from:
StatusCodes
def Options: Method

Attributes

Inherited from:
Methods
def PartialContent: StatusCode

Attributes

Inherited from:
StatusCodes
def Patch: Method

Attributes

Inherited from:
Methods
def PayloadTooLarge: StatusCode

Attributes

Inherited from:
StatusCodes
def PaymentRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def PermanentRedirect: StatusCode

Attributes

Inherited from:
StatusCodes
def Post: Method

Attributes

Inherited from:
Methods
def PreconditionFailed: StatusCode

Attributes

Inherited from:
StatusCodes
def PreconditionRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def ProxyAuthenticationRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def Put: Method

Attributes

Inherited from:
Methods
def RangeNotSatisfiable: StatusCode

Attributes

Inherited from:
StatusCodes
def RequestHeaderFieldsTooLarge: StatusCode

Attributes

Inherited from:
StatusCodes
def RequestTimeout: StatusCode

Attributes

Inherited from:
StatusCodes
def ResetContent: StatusCode

Attributes

Inherited from:
StatusCodes
def TemporaryRedirect: StatusCode

Attributes

Inherited from:
StatusCodes
def TooEarly: StatusCode

Attributes

Inherited from:
StatusCodes
def TooManyRequests: StatusCode

Attributes

Inherited from:
StatusCodes
def Unauthorized: StatusCode

Attributes

Inherited from:
StatusCodes
def UnavailableForLegalReasons: StatusCode

Attributes

Inherited from:
StatusCodes
def UnprocessableEntity: StatusCode

Attributes

Inherited from:
StatusCodes
def UnsupportedMediaType: StatusCode

Attributes

Inherited from:
StatusCodes
def UpgradeRequired: StatusCode

Attributes

Inherited from:
StatusCodes
def UriTooLong: StatusCode

Attributes

Inherited from:
StatusCodes
def addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]

Add the provided headers to the request.

Add the provided headers to the request.

Attributes

Inherited from:
Requests
def addRequestQueryString[A, Q](request: Request[A], queryString: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]

Add the provided queryString to the request.

Add the provided queryString to the request.

Attributes

Inherited from:
Requests
def addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]

Add the provided headers to the response.

Add the provided headers to the response.

Note that if the response describes a choice of several possible responses (resulting from the orElse operation), the headers will be added to all the possible responses.

Attributes

Inherited from:
Responses
def authenticatedEndpoint[U, E, R, H, UE, HCred, Out](method: Method, url: Url[U], response: Response[R], requestEntity: RequestEntity[E], requestHeaders: RequestHeaders[H], unauthenticatedDocs: Documentation, requestDocs: Documentation, endpointDocs: EndpointDocs)(implicit tuplerUE: Aux[U, E, UE], tuplerHCred: Aux[H, Credentials, HCred], tuplerUEHCred: Aux[UE, HCred, Out]): Endpoint[Out, Option[R]]

Describes an endpoint protected by Basic HTTP authentication

Describes an endpoint protected by Basic HTTP authentication

Attributes

Inherited from:
BasicAuthentication
final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit 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.

Attributes

See also
Inherited from:
Responses
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

Attributes

Inherited from:
Urls
def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]

Alternative between two possible request entities, differentiated by the Content-Type header

Alternative between two possible request entities, differentiated by the Content-Type header

Attributes

Note

If A and B are both JSON-encoded and use disjoint schemas, use endpoints4s.algebra.JsonSchemas.TaggedOps#orElse at the schema level instead

  • Server interpreters accept either of the request entities
  • Client interpreters provide one of the two request entities
  • Documentation interpreters list all possible content types and their entities
Inherited from:
Requests
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.

Attributes

Inherited from:
Responses
def clientErrorsResponseEntity: ResponseEntity[ClientErrors]

Format of the response entity carrying the client errors.

Format of the response entity carrying the client errors.

Attributes

Inherited from:
Errors
def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid

Convert the ClientErrors type into the endpoints4s internal client error type

Convert the ClientErrors type into the endpoints4s internal client error type

Attributes

Inherited from:
Errors
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Concatenates two QueryStrings

Concatenates two QueryStrings

Attributes

Inherited from:
Urls
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Aux[UrlP, HeadersP, Out]): Request[Out]

Helper method to perform DELETE request

Helper method to perform DELETE request

Type parameters

HeadersP

Payload carried by headers

UrlP

Payload carried by url

Attributes

Inherited from:
Requests
def emptyRequest: RequestEntity[Unit]

Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

Empty request -- request without a body. Use description of endpoints4s.algebra.Endpoints#endpoint to document an empty body.

Attributes

Inherited from:
Requests
def emptyRequestHeaders: RequestHeaders[Unit]

Ignore headers

Ignore headers

  • Server interpreters don’t try to parse any information from the request headers,
  • Client interpreters supply no specific headers

Use description of endpoints4s.algebra.Endpoints#endpoint to document empty headers.

Attributes

Inherited from:
Requests
def emptyResponse: ResponseEntity[Unit]

Empty response entity

Empty response entity

  • Server interpreters produce no response entity,
  • Client interpreters ignore the response entity.

Attributes

Inherited from:
Responses
def emptyResponseHeaders: ResponseHeaders[Unit]

No particular response header.

No particular response header.

  • Client interpreters should ignore information carried by response headers.

Attributes

Inherited from:
Responses
def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]

Define an HTTP endpoint

Define an HTTP endpoint

Value parameters

docs

Documentation (used by documentation interpreters)

request

Request

response

Response

Attributes

Inherited from:
EndpointsWithCustomErrors
final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Aux[UrlP, HeadersP, Out]): Request[Out]

Helper method to perform GET request

Helper method to perform GET request

Type parameters

HeadersP

Payload carried by headers

UrlP

Payload carried by url

Attributes

Inherited from:
Requests
final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit 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.

Attributes

See also
Inherited from:
Responses
def invalidToClientErrors(invalid: Invalid): ClientErrors

Convert the endpoints4s internal client error type into the ClientErrors type

Convert the endpoints4s internal client error type into the ClientErrors type

Attributes

Inherited from:
Errors
def mapEndpointDocs[A, B](endpoint: Endpoint[A, B], func: EndpointDocs => EndpointDocs): Endpoint[A, B]

Map the inner documentation of the endpoint to new documentation.

Map the inner documentation of the endpoint to new documentation.

Value parameters

endpoint

The current endpoint that is being mapped.

func

The function that maps the documentation to some new documentation.

Attributes

Returns

The endpoint with the mapped documentation.

Inherited from:
EndpointsWithCustomErrors
def mapEndpointRequest[A, B, C](endpoint: Endpoint[A, B], func: Request[A] => Request[C]): Endpoint[C, B]

Map the inner request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.

Map the inner request of the endpoint to a new request. This is for example useful to add Auth headers to an existing endpoint.

Value parameters

endpoint

The current endpoint that is being mapped.

func

The function that maps the request to some new request.

Attributes

Returns

The endpoint with the mapped request.

Example 
 val myEndpoint: Endpoint[Input, Output] = ???
 val basicAuthHeaders: RequestHeaders[Credentials] = ???
 val endpointWithAuth: Endpoint[(Input, Credentials), Output] =
   myEndpoint.mapRequest(_.addHeaders(basicAuthHeader))
Inherited from:
EndpointsWithCustomErrors
def mapEndpointResponse[A, B, C](endpoint: Endpoint[A, B], func: Response[B] => Response[C]): Endpoint[A, C]

Map the inner response of the endpoint to a new response. This is for example useful so you can add error handling to an existing endpoint.

Map the inner response of the endpoint to a new response. This is for example useful so you can add error handling to an existing endpoint.

Value parameters

endpoint

The current endpoint that is being mapped.

func

The function that maps the response to some new response.

Attributes

Returns

The endpoint with the mapped response.

Example 
 val myEndpoint: Endpoint[Input, Output] = ???
 val errorResponse: Response[Error] = ???
 val endpointWithErrorHandling: Endpoint[Input, Either[Error, Output]] =
   myEndpoint.mapResponse(resp => resp orElse errorResponse)
Inherited from:
EndpointsWithCustomErrors
final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Aux[A, B, R]): Response[R]

OK (200) Response with the given entity

OK (200) Response with the given entity

Attributes

Inherited from:
Responses
def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]

Builds a QueryString with one optional parameter, which has a default value.

Builds a QueryString with one optional parameter, which has a default value.

Examples:

 optQsWithDefault[Int]("page", 1) // optional `page` parameter, with default value 1

Type parameters

A

Type of the value carried by the parameter

Value parameters

name

Parameter’s name

Attributes

Inherited from:
Urls
def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

An optional request header

An optional request header

Value parameters

name

Header name (e.g., “Authorization”)

Attributes

Inherited from:
Requests
def optResponseHeader(name: String, docs: Documentation): 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.

Attributes

Inherited from:
Responses
final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform PATCH request

Helper method to perform PATCH request

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Value parameters

docs

Request documentation

Attributes

Inherited from:
Requests
final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform POST request

Helper method to perform POST request

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Value parameters

docs

Request documentation

Attributes

Inherited from:
Requests
final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Helper method to perform PUT request

Helper method to perform PUT request

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Attributes

Inherited from:
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

Type parameters

A

Type of the value carried by the parameter

Value parameters

name

Parameter’s name

Attributes

Inherited from:
Urls
def remainingSegments(name: String, docs: Documentation): Path[String]

The remaining segments of the path. The String value carried by this Path is still URL-encoded.

The remaining segments of the path. The String value carried by this Path is still URL-encoded.

Attributes

Inherited from:
Urls
def request[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](method: Method, url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Request for given parameters

Request for given parameters

Type parameters

BodyP

Payload carried by body

HeadersP

Payload carried by headers

UrlAndBodyPTupled

Payloads of Url and Body tupled together by Tupler

UrlP

Payload carried by url

Value parameters

docs

Request documentation

entity

Request entity

headers

Request headers

method

Request method

url

Request URL

Attributes

Inherited from:
Requests
def requestHeader(name: String, docs: Documentation): RequestHeaders[String]

A required request header

A required request header

Value parameters

name

Header name (e.g., “Authorization”)

Attributes

Inherited from:
Requests
def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Aux[A, B, R]): Response[R]

Define an HTTP response

Define an HTTP response

  • Server interpreters construct a response with the given status and entity.
  • Client interpreters accept a response only if it has a corresponding status code.

Value parameters

docs

Response documentation

entity

Response entity

headers

Response headers

statusCode

Response status code

Attributes

Inherited from:
Responses
def responseHeader(name: String, docs: Documentation): 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")
     )
   )

Attributes

Inherited from:
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

Attributes

Inherited from:
Urls
def serverErrorResponseEntity: ResponseEntity[ServerError]

Format of the response entity carrying the server error.

Format of the response entity carrying the server error.

Attributes

Inherited from:
Errors
def serverErrorToThrowable(serverError: ServerError): Throwable

Convert the ServerError type into the endpoints4s internal server error type

Convert the ServerError type into the endpoints4s internal server error type

Attributes

Inherited from:
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

Attributes

Inherited from:
Urls
def textRequest: RequestEntity[String]

Request with a String body.

Request with a String body.

  • Server interpreters accept requests with content-type text/plain and reject requests with an incorrect content-type.
  • Server interpreters will use the character encoding set in the content-type header to determine how the text is decoded.
  • Client interpreters supply content-type text/plain with an explicit character encoding

Attributes

Inherited from:
Requests
def textResponse: ResponseEntity[String]

Text response entity

Text response entity

  • Server interpreters produce an HTTP response with a text/plain content type.

Attributes

Inherited from:
Responses
def throwableToServerError(throwable: Throwable): ServerError

Convert the endpoints4s internal server error type into the ServerError type

Convert the endpoints4s internal server error type into the ServerError type

Attributes

Inherited from:
Errors
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

Attributes

Inherited from:
Urls
final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): 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).

Attributes

Inherited from:
Responses

Inherited fields

lazy val clientErrorsResponse: Response[ClientErrors]

Response used by endpoints4s when decoding a request fails.

Response used by endpoints4s when decoding a request fails.

The provided implementation forwards to badRequest.

Attributes

Inherited from:
Errors
val path: Path[Unit]

An empty path.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")

Attributes

Inherited from:
Urls
lazy val serverErrorResponse: Response[ServerError]

Response used by endpoints4s when the business logic of an endpoint fails.

Response used by endpoints4s when the business logic of an endpoint fails.

The provided implementation forwards to internalServerError

Attributes

Inherited from:
Errors

Implicits

Inherited implicits

final implicit def EndpointSyntax[A, B](endpoint: Endpoint[A, B]): EndpointSyntax[A, B]

Extension methods for Endpoint.

Extension methods for Endpoint.

Attributes

Inherited from:
EndpointsWithCustomErrors
final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

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.

Attributes

Inherited from:
InvariantFunctorSyntax
final implicit def PartialInvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: PartialInvariantFunctor[F]): PartialInvariantFunctorSyntax[A, F]

Attributes

Inherited from:
PartialInvariantFunctorSyntax
final implicit def PathOps[A](first: Path[A]): PathOps[A]

Convenient methods for Paths.

Convenient methods for Paths.

Attributes

Inherited from:
Urls
final implicit def QueryStringSyntax[A](first: QueryString[A]): QueryStringSyntax[A]

Extension methods on QueryString.

Extension methods on QueryString.

Attributes

Inherited from:
Urls
final implicit def RequestEntitySyntax[A](requestEntity: RequestEntity[A]): RequestEntitySyntax[A]

Attributes

Inherited from:
Requests
final implicit def RequestSyntax[A](request: Request[A]): RequestSyntax[A]

Extension methods for Request.

Extension methods for Request.

Attributes

Inherited from:
Requests
final implicit def ResponseSyntax[A](response: Response[A]): ResponseSyntax[A]

Extension methods for Response.

Extension methods for Response.

Attributes

Inherited from:
Responses
final implicit def SemigroupalSyntax[A, F[_]](f: F[A])(implicit ev: Semigroupal[F]): SemigroupalSyntax[A, F]

Attributes

Inherited from:
SemigroupalSyntax
implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value

Query string parameter containing a Boolean value

Attributes

Inherited from:
Urls
implicit def doubleQueryString: QueryStringParam[Double]

Codec for query string parameters of type Double

Codec for query string parameters of type Double

Attributes

Inherited from:
Urls
implicit def doubleSegment: Segment[Double]

Path segment codec for type Double

Path segment codec for type Double

Attributes

Inherited from:
Urls
implicit def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters

Ability to define Int query string parameters

Attributes

Inherited from:
Urls
implicit def intSegment: Segment[Int]

Path segment codec for type Int

Path segment codec for type Int

Attributes

Inherited from:
Urls
implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value

Query string parameter containing a Long value

Attributes

Inherited from:
Urls
implicit def longSegment: Segment[Long]

Path segment codec for type Long

Path segment codec for type Long

Attributes

Inherited from:
Urls
implicit def optionalQueryStringParam[A : QueryStringParam]: 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, and they must report a failure for incoming requests whose optional query string parameters are present, but malformed,
  • Documentation interpreters should mark the parameter as optional.

Attributes

Inherited from:
Urls
implicit def pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def repeatedQueryStringParam[A : QueryStringParam, CC <: (Iterable)](implicit evidence$2: 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.

Attributes

Inherited from:
Urls
implicit def requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Attributes

See also

PartialInvariantFunctorSyntax

Inherited from:
Requests
implicit def requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Attributes

See also

PartialInvariantFunctorSyntax

Inherited from:
Requests
implicit def requestHeadersSemigroupal: Semigroupal[RequestHeaders]

Provides ++ operation.

Provides ++ operation.

Attributes

See also

SemigroupalSyntax

Inherited from:
Requests
implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]

Provides the operations xmap and xmapPartial.

Provides the operations xmap and xmapPartial.

Attributes

See also

PartialInvariantFunctorSyntax

Inherited from:
Requests
implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]

Attributes

Inherited from:
Responses
implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]

Provides xmap operation.

Provides xmap operation.

Attributes

See also

InvariantFunctorSyntax

Inherited from:
Responses
implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]

Provides ++ operation.

Provides ++ operation.

Attributes

See also
Inherited from:
Responses
implicit def responseInvariantFunctor: InvariantFunctor[Response]

Provides the operation xmap to the type Response

Provides the operation xmap to the type Response

Attributes

See also

InvariantFunctorSyntax

Inherited from:
Responses
implicit def segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]

Provides xmap and xmapPartial operations.

Provides xmap and xmapPartial operations.

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def stringQueryString: QueryStringParam[String]

Ability to define String query string parameters

Ability to define String query string parameters

Attributes

Inherited from:
Urls
implicit def stringSegment: Segment[String]

Path segment codec for type String

Path segment codec for type String

  • Server interpreters should return an URL-decoded string value,
  • Client interpreters should take an URL-decoded string value.

Attributes

Inherited from:
Urls
implicit def urlPartialInvariantFunctor: PartialInvariantFunctor[Url]

Provides xmap and xmapPartial operations

Provides xmap and xmapPartial operations

Attributes

See also

PartialInvariantFunctorSyntax and InvariantFunctorSyntax

Inherited from:
Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters

Ability to define UUID query string parameters

Attributes

Inherited from:
Urls
implicit def uuidSegment: Segment[UUID]

Path segment codec for type UUID

Path segment codec for type UUID

Attributes

Inherited from:
Urls
Generated with