ApiFailure

com.softinio.verdict4s.algebra.ApiFailure
See theApiFailure companion object
enum ApiFailure

A named classification of an unsuccessful HTTP status.

Matching on this is steadier than matching on raw status codes: the two statuses that callers most often want to treat alike — 429 and 529 — are numerically unrelated, and 5xx is a range rather than a value.

Attributes

Companion
object
Graph
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Type members

Enum entries

case BadRequest extends ApiFailure

400 — the request was malformed.

400 — the request was malformed.

Attributes

case Forbidden extends ApiFailure

403 — the key is valid but not permitted to do this.

403 — the key is valid but not permitted to do this.

Attributes

case NotFound extends ApiFailure

404 — no such resource.

404 — no such resource.

Attributes

case Other extends ApiFailure

A status this library does not classify.

A status this library does not classify.

Attributes

case Overloaded extends ApiFailure

529 — TypeSafe is temporarily overloaded. Retryable after a delay.

529 — TypeSafe is temporarily overloaded. Retryable after a delay.

Attributes

case RateLimited extends ApiFailure

429 — rate limited. Retryable after a delay.

429 — rate limited. Retryable after a delay.

Attributes

case Server extends ApiFailure

Any other 5xx.

Any other 5xx.

Attributes

case Unauthorized extends ApiFailure

401 — missing or invalid API key.

401 — missing or invalid API key.

Attributes

case Unprocessable extends ApiFailure

422 — the body failed server-side validation.

422 — the body failed server-side validation.

Attributes