View Source GitHub.Pulls (GitHub REST API Client v0.0.11)
Provides API endpoints related to pulls
Link to this section Summary
Functions
Check if a pull request has been merged
Create a pull request
Create a reply for a review comment
Create a review for a pull request
Create a review comment for a pull request
Delete a pending review for a pull request
Delete a review comment for a pull request
Dismiss a review for a pull request
Get a pull request
Get a review for a pull request
Get a review comment for a pull request
List pull requests
List comments for a pull request review
List commits on a pull request
List pull requests files
Get all requested reviewers for a pull request
List review comments on a pull request
List review comments in a repository
List reviews for a pull request
Merge a pull request
Remove requested reviewers from a pull request
Request reviewers for a pull request
Submit a review for a pull request
Update a pull request
Update a pull request branch
Update a review for a pull request
Update a review comment for a pull request
Link to this section Functions
@spec check_if_merged(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Check if a pull request has been merged
resources
Resources
@spec create(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.PullRequest.t()} | {:error, GitHub.Error.t()}
Create a pull request
resources
Resources
create_reply_for_review_comment(owner, repo, pull_number, comment_id, body, opts \\ [])
View Source@spec create_reply_for_review_comment( String.t(), String.t(), integer(), integer(), map(), keyword() ) :: {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}
Create a reply for a review comment
resources
Resources
@spec create_review(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}
Create a review for a pull request
resources
Resources
@spec create_review_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}
Create a review comment for a pull request
resources
Resources
delete_pending_review(owner, repo, pull_number, review_id, opts \\ [])
View Source@spec delete_pending_review(String.t(), String.t(), integer(), integer(), keyword()) :: {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}
Delete a pending review for a pull request
resources
Resources
@spec delete_review_comment(String.t(), String.t(), integer(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a review comment for a pull request
resources
Resources
dismiss_review(owner, repo, pull_number, review_id, body, opts \\ [])
View Source@spec dismiss_review(String.t(), String.t(), integer(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}
Dismiss a review for a pull request
resources
Resources
@spec get(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.PullRequest.t()} | {:error, GitHub.Error.t()}
Get a pull request
resources
Resources
@spec get_review(String.t(), String.t(), integer(), integer(), keyword()) :: {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}
Get a review for a pull request
resources
Resources
@spec get_review_comment(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}
Get a review comment for a pull request
resources
Resources
@spec list(String.t(), String.t(), keyword()) :: {:ok, [GitHub.PullRequest.simple()]} | {:error, GitHub.Error.t()}
List pull requests
options
Options
state
(String.t()): Eitheropen
,closed
, orall
to filter by state.head
(String.t()): Filter pulls by head user or head organization and branch name in the format ofuser:ref-name
ororganization:ref-name
. For example:github:new-script-format
oroctocat:test-branch
.base
(String.t()): Filter pulls by base branch name. Example:gh-pages
.sort
(String.t()): What to sort results by.popularity
will sort by the number of comments.long-running
will sort by date created and will limit the results to pull requests that have been open for more than a month and have had activity within the past month.direction
(String.t()): The direction of the sort. Default:desc
when sort iscreated
or sort is not specified, otherwiseasc
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
list_comments_for_review(owner, repo, pull_number, review_id, opts \\ [])
View Source@spec list_comments_for_review( String.t(), String.t(), integer(), integer(), keyword() ) :: {:ok, [GitHub.ReviewComment.t()]} | {:error, GitHub.Error.t()}
List comments for a pull request review
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_commits(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.Commit.t()]} | {:error, GitHub.Error.t()}
List commits on a pull request
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_files(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.DiffEntry.t()]} | {:error, GitHub.Error.t()}
List pull requests files
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_requested_reviewers(String.t(), String.t(), integer(), keyword()) :: {:ok, GitHub.PullRequest.ReviewRequest.t()} | {:error, GitHub.Error.t()}
Get all requested reviewers for a pull request
resources
Resources
@spec list_review_comments(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.PullRequest.ReviewComment.t()]} | {:error, GitHub.Error.t()}
List review comments on a pull request
options
Options
sort
(String.t()): The property to sort the results by.direction
(String.t()): The direction to sort results. Ignored withoutsort
parameter.since
(String.t()): Only show notifications updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_review_comments_for_repo(String.t(), String.t(), keyword()) :: {:ok, [GitHub.PullRequest.ReviewComment.t()]} | {:error, GitHub.Error.t()}
List review comments in a repository
options
Options
sort
(String.t()):direction
(String.t()): The direction to sort results. Ignored withoutsort
parameter.since
(String.t()): Only show notifications updated after the given time. This is a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZ
.per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec list_reviews(String.t(), String.t(), integer(), keyword()) :: {:ok, [GitHub.PullRequest.Review.t()]} | {:error, GitHub.Error.t()}
List reviews for a pull request
options
Options
per_page
(integer): The number of results per page (max 100).page
(integer): Page number of the results to fetch.
resources
Resources
@spec merge(String.t(), String.t(), integer(), map() | nil, keyword()) :: {:ok, GitHub.PullRequest.MergeResult.t()} | {:error, GitHub.Error.t()}
Merge a pull request
resources
Resources
remove_requested_reviewers(owner, repo, pull_number, body, opts \\ [])
View Source@spec remove_requested_reviewers(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.simple()} | {:error, GitHub.Error.t()}
Remove requested reviewers from a pull request
resources
Resources
@spec request_reviewers(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.simple()} | {:error, GitHub.Error.t()}
Request reviewers for a pull request
resources
Resources
submit_review(owner, repo, pull_number, review_id, body, opts \\ [])
View Source@spec submit_review(String.t(), String.t(), integer(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}
Submit a review for a pull request
resources
Resources
@spec update(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.t()} | {:error, GitHub.Error.t()}
Update a pull request
resources
Resources
@spec update_branch(String.t(), String.t(), integer(), map() | nil, keyword()) :: {:ok, map()} | {:error, GitHub.Error.t()}
Update a pull request branch
resources
Resources
update_review(owner, repo, pull_number, review_id, body, opts \\ [])
View Source@spec update_review(String.t(), String.t(), integer(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.Review.t()} | {:error, GitHub.Error.t()}
Update a review for a pull request
resources
Resources
@spec update_review_comment(String.t(), String.t(), integer(), map(), keyword()) :: {:ok, GitHub.PullRequest.ReviewComment.t()} | {:error, GitHub.Error.t()}
Update a review comment for a pull request