GitHub.Endpoints.Repos.Commits

The repo commits API as described on http://developer.github.com/v3/repos/commits/.

Documentation

data CommitQueryOption

The options for querying commits.

Constructors

CommitQuerySha !Text

CommitQueryPath !Text

CommitQueryAuthor !Text

CommitQuerySince !UTCTime

CommitQueryUntil !UTCTime

Instances

Eq CommitQueryOption

Data CommitQueryOption

Ord CommitQueryOption

Show CommitQueryOption

Generic CommitQueryOption

type Rep CommitQueryOption

commitsFor :: Name Owner -> Name Repo -> IO (Either Error (Vector Commit))

The commit history for a repo.

commitsFor "mike-burns" "github"

commitsFor' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error (Vector Commit))

The commit history for a repo. With authentication.

commitsFor' (Just (BasicAuth (user, password))) "mike-burns" "github"

commitsForR :: Name Owner -> Name Repo -> Maybe Count -> Request k (Vector Commit)

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commitsWithOptionsFor :: Name Owner -> Name Repo -> [CommitQueryOption] -> IO (Either Error (Vector Commit))

commitsWithOptionsFor' :: Maybe Auth -> Name Owner -> Name Repo -> [CommitQueryOption] -> IO (Either Error (Vector Commit))

The commit history for a repo, with commits filtered to satisfy a list of query options. With authentication.

commitsWithOptionsFor' (Just (BasicAuth (user, password))) "mike-burns" "github" [CommitQueryAuthor "djeik"]

commitsWithOptionsForR :: Name Owner -> Name Repo -> Maybe Count -> [CommitQueryOption] -> Request k (Vector Commit)

List commits on a repository. See https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

commit :: Name Owner -> Name Repo -> Name Commit -> IO (Either Error Commit)

Details on a specific SHA1 for a repo.

commit "mike-burns" "github" "9d1a9a361266c3c890b1108ad2fdf52f824b1b81"

commit' :: Maybe Auth -> Name Owner -> Name Repo -> Name Commit -> IO (Either Error Commit)

Details on a specific SHA1 for a repo. With authentication.

commit (Just $ BasicAuth (username, password)) "mike-burns" "github" "9d1a9a361266c3c890b1108ad2fdf52f824b1b81"

commitR :: Name Owner -> Name Repo -> Name Commit -> Request k Commit

Query a single commit. See https://developer.github.com/v3/repos/commits/#get-a-single-commit

diff :: Name Owner -> Name Repo -> Name Commit -> Name Commit -> IO (Either Error Diff)

The diff between two treeishes on a repo.

diff "thoughtbot" "paperclip" "41f685f6e01396936bb8cd98e7cca517e2c7d96b" "HEAD"

diff' :: Maybe Auth -> Name Owner -> Name Repo -> Name Commit -> Name Commit -> IO (Either Error Diff)

The diff between two treeishes on a repo.

diff "thoughtbot" "paperclip" "41f685f6e01396936bb8cd98e7cca517e2c7d96b" "HEAD"

diffR :: Name Owner -> Name Repo -> Name Commit -> Name Commit -> Request k Diff

Compare two commits. See https://developer.github.com/v3/repos/commits/#compare-two-commits

module GitHub.Data