github4s

package github4s

Type members

Classlikes

object Decoders

Implicit circe decoders of domains objects

Implicit circe decoders of domains objects

object Encoders
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

Companion:
object
object GHError
Companion:
class
final case class GHResponse[A](result: Either[GHError, A], statusCode: Int, headers: Map[String, String])
class Github[F[_]](client: Client[F], accessToken: AccessToken[F])(implicit evidence$1: Concurrent[F], config: GithubConfig) extends GithubAPIs[F]
Companion:
object
object Github
Companion:
class
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.

Companion:
object
Companion:
class