github4s
API
Generated with
github4s/github4s/GHError

GHError

github4s.GHError$
See theGHError companion class
object GHError

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
GHError.type

Members list

Concise view

Type members

Classlikes

final case class BadRequestError(message: String) extends GHError

Corresponds to a 400 status code.

Corresponds to a 400 status code.

Attributes

message

that was given in the response body

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object BadRequestError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class BasicError(message: String) extends GHError

Exotic error sometimes used by GitHub.

Exotic error sometimes used by GitHub.

Attributes

message

indicating what happened

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object BasicError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object ErrorCode

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait ErrorCode

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Custom.type
object InvalidFormatting.type
object MissingField.type
object MissingResource.type
final case class ForbiddenError(message: String, documentation_url: String) extends GHError

Corresponds to a 403 status code

Corresponds to a 403 status code

Attributes

documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object ForbiddenError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

Attributes

cause

root cause

message

indicating what happened

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object JsonParsingError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class NotFoundError(message: String, documentation_url: String) extends GHError

Corresponds to a 404 status code

Corresponds to a 404 status code

Attributes

documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object NotFoundError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class RateLimitExceededError(message: String, documentation_url: String) extends GHError

Corresponds to a 423 status code

Corresponds to a 423 status code

Attributes

documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object RateLimitExceededError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class UnauthorizedError(message: String, documentation_url: String) extends GHError

Corresponds to a 401 status code

Corresponds to a 401 status code

Attributes

documentation_url

associated documentation URL for this endpoint

message

that was given in the response body

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object UnauthorizedError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

Attributes

body

of the response

message

indicating what happened

Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
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

Attributes

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
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object UnprocessableEntity

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final case class UnprocessableEntityError(message: String, errors: List[UnprocessableEntity]) extends GHError

Corresponds to a 422 status code

Corresponds to a 422 status code

Attributes

errors

list of validation errors

message

that was given in the response body

Companion:
object
Graph
Supertypes
trait Product
trait Equals
class GHError
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
object UnprocessableEntityError

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror
Generated with