github4s
package github4s
Members list
Packages
package github4s.algebras
package github4s.domain
package github4s.http
package github4s.interpreters
package github4s.modules
Type members
Classlikes
object Decoders
Implicit circe decoders of domains objects
Implicit circe decoders of domains objects
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Decoders.type
object Encoders
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
Encoders.type
sealed abstract class GHError(message: String) extends Exception
Top-level exception returned by github4s when an error occurred.
Top-level exception returned by github4s when an error occurred.
Value parameters
- message
-
that is common to all exceptions
Attributes
- Companion
- object
- Supertypes
-
class Exceptionclass Throwabletrait Serializableclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
class BadRequestErrorclass BasicErrorclass ForbiddenErrorclass JsonParsingErrorclass NotFoundErrorclass RateLimitExceededErrorclass UnauthorizedErrorclass UnhandledResponseErrorclass UnprocessableEntityErrorShow all
object GHError
final case class GHResponse[A](result: Either[GHError, A], statusCode: Int, headers: Map[String, String])
Attributes
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object Github
object GithubClient
Attributes
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
GithubClient.type
final case class GithubConfig(baseUrl: String, authorizeUrl: String, accessTokenUrl: String, headers: Map[String, String])
Configuration for github4s
Configuration for github4s
Value parameters
- accessTokenUrl
-
for the second step of the oAuth process. If you use GitHub enterprise, you'll need to modify this.
- authorizeUrl
-
for the first step of the oAuth process. If you use GitHub enterprise, you'll need to modify this.
- baseUrl
-
of the GitHub API. If you use GitHub enterprise, you'll need to modify this.
- headers
-
to add to all requests sent to the GitHub API. Defaults to "github4s" as user agent.
Attributes
- Companion
- object
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass AnyShow all
object GithubConfig
Attributes
- Companion
- class
- Supertypes
-
trait Producttrait Mirrorclass Objecttrait Matchableclass Any
- Self type
-
GithubConfig.type
Deprecated classlikes
class Github[F[_]](client: Client[F], accessToken: AccessToken[F])(implicit evidence$1: Concurrent[F], config: GithubConfig)
Attributes
- Companion
- object
- Deprecated
- true
- Supertypes
In this article