github4s

package github4s

Members list

Concise view

Type members

Classlikes

object Decoders

Implicit circe decoders of domains objects

Implicit circe decoders of domains objects

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
object Encoders

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self 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.

Attributes

message

that is common to all exceptions

Companion:
object
Graph
Supertypes
class Exception
class Throwable
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
object GHError

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
GHError.type
final case class GHResponse[A](result: Either[GHError, A], statusCode: Int, headers: Map[String, String])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
class Github[F[_]](client: Client[F], accessToken: AccessToken[F])(implicit evidence$1: Concurrent[F], config: GithubConfig) extends GithubAPIs[F]

Attributes

Companion:
object
Graph
Supertypes
trait GithubAPIs[F]
class Object
trait Matchable
class Any
object Github

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Github.type
final case class GithubConfig(baseUrl: String, authorizeUrl: String, accessTokenUrl: String, headers: Map[String, String])

Configuration for github4s

Configuration for github4s

Attributes

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

Attributes

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