GitHub.Data.Request

Documentation

data Request 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: 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)

Show (Request k a)

Hashable (Request k a)

data CommandMethod a where

Http method of requests with body.

Constructors

Post :: CommandMethod a

Patch :: CommandMethod a

Put :: CommandMethod a

Delete :: CommandMethod ()

Instances

Eq (CommandMethod a)

Show (CommandMethod a)

Hashable (CommandMethod a)

toMethod :: CommandMethod a -> Method

data StatusMap a where

Status code transform

Constructors

StatusOnlyOk :: StatusMap Bool

StatusMerge :: StatusMap MergeResult

Instances

Eq (StatusMap a)

Show (StatusMap a)

Hashable (StatusMap a)

data MergeResult

Result of merge operation

Constructors

MergeSuccessful

MergeCannotPerform

MergeConflict

Instances

Bounded MergeResult

Enum MergeResult

Eq MergeResult

Ord MergeResult

Read MergeResult

Show MergeResult

Generic MergeResult

Hashable MergeResult

type Rep MergeResult

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