License	BSD-3-Clause
Maintainer	Oleg Grenrus <oleg.grenrus@iki.fi>
Safe Haskell	None
Language	Haskell2010

GitHub.Endpoints.PullRequests

Description

The pull requests API as documented at http://developer.github.com/v3/pulls/.

Synopsis

pullRequestsFor :: Name Owner -> Name Repo -> IO (Either Error (Vector SimplePullRequest))
pullRequestsFor' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error (Vector SimplePullRequest))
pullRequestsForR :: Name Owner -> Name Repo -> PullRequestMod -> FetchCount -> Request k (Vector SimplePullRequest)
pullRequest' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error PullRequest)
pullRequest :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error PullRequest)
pullRequestR :: Name Owner -> Name Repo -> IssueNumber -> Request k PullRequest
pullRequestDiff' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString)
pullRequestDiff :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString)
pullRequestDiffR :: Name Owner -> Name Repo -> IssueNumber -> GenRequest MtDiff rw ByteString
pullRequestPatch' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString)
pullRequestPatch :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString)
pullRequestPatchR :: Name Owner -> Name Repo -> IssueNumber -> GenRequest MtPatch rw ByteString
createPullRequest :: Auth -> Name Owner -> Name Repo -> CreatePullRequest -> IO (Either Error PullRequest)
createPullRequestR :: Name Owner -> Name Repo -> CreatePullRequest -> Request RW PullRequest
updatePullRequest :: Auth -> Name Owner -> Name Repo -> IssueNumber -> EditPullRequest -> IO (Either Error PullRequest)
updatePullRequestR :: Name Owner -> Name Repo -> IssueNumber -> EditPullRequest -> Request RW PullRequest
pullRequestCommits' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector Commit))
pullRequestCommitsIO :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector Commit))
pullRequestCommitsR :: Name Owner -> Name Repo -> IssueNumber -> FetchCount -> Request k (Vector Commit)
pullRequestFiles' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector File))
pullRequestFiles :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector File))
pullRequestFilesR :: Name Owner -> Name Repo -> IssueNumber -> FetchCount -> Request k (Vector File)
isPullRequestMerged :: Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error Bool)
isPullRequestMergedR :: Name Owner -> Name Repo -> IssueNumber -> GenRequest MtStatus rw Bool
mergePullRequest :: Auth -> Name Owner -> Name Repo -> IssueNumber -> Maybe Text -> IO (Either Error MergeResult)
mergePullRequestR :: Name Owner -> Name Repo -> IssueNumber -> Maybe Text -> GenRequest MtStatus RW MergeResult
module GitHub.Data

Documentation

pullRequestsFor :: Name Owner -> Name Repo -> IO (Either Error (Vector SimplePullRequest)) Source #

All open pull requests for the repo, by owner and repo name.

pullRequestsFor "rails" "rails"

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

All open pull requests for the repo, by owner and repo name.

pullRequestsFor "rails" "rails"

pullRequestsForR :: Name Owner -> Name Repo -> PullRequestMod -> FetchCount -> Request k (Vector SimplePullRequest) Source #

List pull requests. See https://developer.github.com/v3/pulls/#list-pull-requests

pullRequest' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error PullRequest) Source #

A detailed pull request, which has much more information. This takes the repo owner and name along with the number assigned to the pull request. With authentification.

pullRequest' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" 562

pullRequest :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error PullRequest) Source #

A detailed pull request, which has much more information. This takes the repo owner and name along with the number assigned to the pull request.

pullRequest "thoughtbot" "paperclip" 562

pullRequestR :: Name Owner -> Name Repo -> IssueNumber -> Request k PullRequest Source #

Query a single pull request. See https://developer.github.com/v3/pulls/#get-a-single-pull-request

pullRequestDiff' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString) Source #

Obtain the diff of a pull request See https://developer.github.com/v3/pulls/#get-a-single-pull-request

pullRequestDiff :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString) Source #

Obtain the diff of a pull request See https://developer.github.com/v3/pulls/#get-a-single-pull-request

pullRequestDiffR :: Name Owner -> Name Repo -> IssueNumber -> GenRequest MtDiff rw ByteString Source #

Query a single pull request to obtain the diff See https://developer.github.com/v3/pulls/#get-a-single-pull-request

pullRequestPatch' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString) Source #

Obtain the patch of a pull request

See https://developer.github.com/v3/pulls/#get-a-single-pull-request

pullRequestPatch :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error ByteString) Source #

Obtain the patch of a pull request See https://developer.github.com/v3/pulls/#get-a-single-pull-request

pullRequestPatchR :: Name Owner -> Name Repo -> IssueNumber -> GenRequest MtPatch rw ByteString Source #

Query a single pull request to obtain the patch See https://developer.github.com/v3/pulls/#get-a-single-pull-request

createPullRequest :: Auth -> Name Owner -> Name Repo -> CreatePullRequest -> IO (Either Error PullRequest) Source #

createPullRequestR :: Name Owner -> Name Repo -> CreatePullRequest -> Request RW PullRequest Source #

Create a pull request. See https://developer.github.com/v3/pulls/#create-a-pull-request

updatePullRequest :: Auth -> Name Owner -> Name Repo -> IssueNumber -> EditPullRequest -> IO (Either Error PullRequest) Source #

Update a pull request

updatePullRequestR :: Name Owner -> Name Repo -> IssueNumber -> EditPullRequest -> Request RW PullRequest Source #

Update a pull request. See https://developer.github.com/v3/pulls/#update-a-pull-request

pullRequestCommits' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector Commit)) Source #

All the commits on a pull request, given the repo owner, repo name, and the number of the pull request. With authentification.

pullRequestCommits' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" 688

pullRequestCommitsIO :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector Commit)) Source #

All the commits on a pull request, given the repo owner, repo name, and the number of the pull request.

pullRequestCommits "thoughtbot" "paperclip" 688

pullRequestCommitsR :: Name Owner -> Name Repo -> IssueNumber -> FetchCount -> Request k (Vector Commit) Source #

List commits on a pull request. See https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request

pullRequestFiles' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector File)) Source #

The individual files that a pull request patches. Takes the repo owner and name, plus the number assigned to the pull request. With authentification.

pullRequestFiles' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" 688

pullRequestFiles :: Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector File)) Source #

The individual files that a pull request patches. Takes the repo owner and name, plus the number assigned to the pull request.

pullRequestFiles "thoughtbot" "paperclip" 688

pullRequestFilesR :: Name Owner -> Name Repo -> IssueNumber -> FetchCount -> Request k (Vector File) Source #

List pull requests files. See https://developer.github.com/v3/pulls/#list-pull-requests-files

isPullRequestMerged :: Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error Bool) Source #

Check if pull request has been merged.

isPullRequestMergedR :: Name Owner -> Name Repo -> IssueNumber -> GenRequest MtStatus rw Bool Source #

Query if a pull request has been merged. See https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged

mergePullRequest :: Auth -> Name Owner -> Name Repo -> IssueNumber -> Maybe Text -> IO (Either Error MergeResult) Source #

Merge a pull request.

mergePullRequestR :: Name Owner -> Name Repo -> IssueNumber -> Maybe Text -> GenRequest MtStatus RW MergeResult Source #

Merge a pull request (Merge Button). https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button

module GitHub.Data