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

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

GitHub.Endpoints.GitData.References

Description

The underlying git references on a Github repo, exposed for the world to see. The git internals documentation will also prove handy for understanding these. API documentation at http://developer.github.com/v3/git/refs/.

Synopsis

Documentation

reference :: Name Owner -> Name Repo -> Name GitReference -> IO (Either Error GitReference) Source #

A single reference by the ref name.

reference "mike-burns" "github" "heads/master"

reference' :: Maybe Auth -> Name Owner -> Name Repo -> Name GitReference -> IO (Either Error GitReference) Source #

A single reference by the ref name.

reference' (Just ("github-username", "github-password")) "mike-burns" "github" "heads/master"

references :: Name Owner -> Name Repo -> IO (Either Error (Vector GitReference)) Source #

The history of references for a repo.

references "mike-burns" "github"

references' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error (Vector GitReference)) Source #

The history of references for a repo.

references "mike-burns" "github"

namespacedReferences :: Name Owner -> Name Repo -> Text -> IO (Either Error [GitReference]) Source #

Limited references by a namespace.

namespacedReferences "thoughtbot" "paperclip" "tags"