Github.Data.Request

Documentation

data GithubRequest k a where

Github request data type.

• k describes whether authentication is required. It's required for non-GET requests.
• a is the result type

Note: GithubRequest is not Functor on purpose.

TODO: Add constructor for collection fetches.

Constructors

GithubGet :: FromJSON a => Paths -> QueryString -> GithubRequest k a

GithubPagedGet :: FromJSON (Vector a) => Paths -> QueryString -> Maybe Count -> GithubRequest k (Vector a)

GithubPost :: FromJSON a => PostMethod -> Paths -> ByteString -> GithubRequest True a

GithubDelete :: Paths -> GithubRequest True ()

GithubStatus :: GithubRequest k () -> GithubRequest k Status

Instances

Eq (GithubRequest k a)

Show (GithubRequest k a)

data PostMethod

Http method of requests with body.

Constructors

Post

Patch

Put

Instances

Bounded PostMethod

Enum PostMethod

Eq PostMethod

Ord PostMethod

Read PostMethod

Show PostMethod

Generic PostMethod

type Rep PostMethod

toMethod :: PostMethod -> Method

type Paths = [String]

class IsPathPart a where

Methods

toPathPart :: a -> String

Instances

IsPathPart (Name a)

IsPathPart (Id a)

type QueryString = [(ByteString, Maybe ByteString)]

type Count = Int