GHError

object GHError
Companion:
class
trait Sum
trait Mirror
class Object
trait Matchable
class Any
GHError.type

Type members

Classlikes

final case class BadRequestError(message: String) extends GHError

Corresponds to a 400 status code.

Corresponds to a 400 status code.

Value parameters:
message

that was given in the response body

Companion:
object
Companion:
class
final case class BasicError(message: String) extends GHError

Exotic error sometimes used by GitHub.

Exotic error sometimes used by GitHub.

Value parameters:
message

indicating what happened

Companion:
object
object BasicError
Companion:
class
object ErrorCode
Companion:
class
sealed trait ErrorCode
Companion:
object
final case class ForbiddenError(message: String, documentation_url: String) extends GHError

Corresponds to a 403 status code

Corresponds to a 403 status code

Value parameters:
documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Companion:
class
final case class JsonParsingError(message: String, cause: Option[Throwable]) extends GHError

Corresponds to the case when an issue occurred during JSON parsing.

Corresponds to the case when an issue occurred during JSON parsing.

Value parameters:
cause

root cause

message

indicating what happened

Companion:
object
Companion:
class
final case class NotFoundError(message: String, documentation_url: String) extends GHError

Corresponds to a 404 status code

Corresponds to a 404 status code

Value parameters:
documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Companion:
class
final case class RateLimitExceededError(message: String, documentation_url: String) extends GHError

Corresponds to a 423 status code

Corresponds to a 423 status code

Value parameters:
documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
final case class UnauthorizedError(message: String, documentation_url: String) extends GHError

Corresponds to a 401 status code

Corresponds to a 401 status code

Value parameters:
documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Companion:
class
final case class UnhandledResponseError(message: String, body: String) extends GHError

Corresponds to a response for which the status code couldn't be handled.

Corresponds to a response for which the status code couldn't be handled.

Value parameters:
body

of the response

message

indicating what happened

final case class UnprocessableEntity(resource: String, field: String, code: ErrorCode)

Error given when a 422 status code is returned

Error given when a 422 status code is returned

Value parameters:
code

error code to debug the problem

field

for which the error occurred

resource

github resource on which the error occurred (issue, pull request, etc)

Companion:
object
Companion:
class
final case class UnprocessableEntityError(message: String, errors: List[UnprocessableEntity]) extends GHError

Corresponds to a 422 status code

Corresponds to a 422 status code

Value parameters:
errors

list of validation errors

message

that was given in the response body

Companion:
object

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Inherited from:
Mirror