github-0.14.1: Access to the GitHub API, v3.

LicenseBSD-3-Clause
MaintainerOleg Grenrus <oleg.grenrus@iki.fi>
Safe HaskellNone
LanguageHaskell2010

GitHub.Data.Request

Description

 

Synopsis

Documentation

data Request k a where Source #

Github request data type.

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

Note: Request is not Functor on purpose.

Constructors

Query :: FromJSON a => Paths -> QueryString -> Request k a 
PagedQuery :: FromJSON (Vector a) => Paths -> QueryString -> Maybe Count -> Request k (Vector a) 
Command :: FromJSON a => CommandMethod a -> Paths -> ByteString -> Request True a 
StatusQuery :: StatusMap a -> Request k () -> Request k a 

Instances

Eq (Request k a) Source # 

Methods

(==) :: Request k a -> Request k a -> Bool #

(/=) :: Request k a -> Request k a -> Bool #

Show (Request k a) Source # 

Methods

showsPrec :: Int -> Request k a -> ShowS #

show :: Request k a -> String #

showList :: [Request k a] -> ShowS #

Hashable (Request k a) Source # 

Methods

hashWithSalt :: Int -> Request k a -> Int #

hash :: Request k a -> Int #

data CommandMethod a where Source #

Http method of requests with body.

data StatusMap a where Source #

Status code transform

Instances

data MergeResult Source #

Result of merge operation

Instances

Bounded MergeResult Source # 
Enum MergeResult Source # 
Eq MergeResult Source # 
Ord MergeResult Source # 
Read MergeResult Source # 
Show MergeResult Source # 
Generic MergeResult Source # 

Associated Types

type Rep MergeResult :: * -> * #

Hashable MergeResult Source # 
type Rep MergeResult Source # 
type Rep MergeResult = D1 (MetaData "MergeResult" "GitHub.Data.Request" "github-0.14.1-46mCeH4MwkpLJV9KUNEedT" False) ((:+:) (C1 (MetaCons "MergeSuccessful" PrefixI False) U1) ((:+:) (C1 (MetaCons "MergeCannotPerform" PrefixI False) U1) (C1 (MetaCons "MergeConflict" PrefixI False) U1)))

type Paths = [String] Source #

class IsPathPart a where Source #

Minimal complete definition

toPathPart

Methods

toPathPart :: a -> String Source #

Instances

type Count = Int Source #