APIs.io Engineering Platform Pulls API
Interact with GitHub Pull Requests.
This API exposes 27 operations across 16 paths, and defines 27 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.
Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.
27 operations
16 paths
27 schemas
3 DELETE12 GET2 PATCH6 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
APIs.io Engineering Platform Pulls API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac— Amazon Signature authorization v4
Paths & Operations 27
Across 16 paths, the API surfaces 27 operations — 3 DELETE, 12 GET, 2 PATCH, 6 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
Pulls 27
Interact with GitHub Pull Requests.
GET
/repos/{owner}/{repo}/pulls
APIs.io Engineering Platform List pull requests
POST
/repos/{owner}/{repo}/pulls
APIs.io Engineering Platform Create a pull request
GET
/repos/{owner}/{repo}/pulls/comments
APIs.io Engineering Platform List review comments in a repository
GET
/repos/{owner}/{repo}/pulls/comments/{comment_id}
APIs.io Engineering Platform Get a review comment for a pull request
PATCH
/repos/{owner}/{repo}/pulls/comments/{comment_id}
APIs.io Engineering Platform Update a review comment for a pull request
DELETE
/repos/{owner}/{repo}/pulls/comments/{comment_id}
APIs.io Engineering Platform Delete a review comment for a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}
APIs.io Engineering Platform Get a pull request
PATCH
/repos/{owner}/{repo}/pulls/{pull_number}
APIs.io Engineering Platform Update a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/comments
APIs.io Engineering Platform List review comments on a pull request
POST
/repos/{owner}/{repo}/pulls/{pull_number}/comments
APIs.io Engineering Platform Create a review comment for a pull request
POST
/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies
APIs.io Engineering Platform Create a reply for a review comment
GET
/repos/{owner}/{repo}/pulls/{pull_number}/commits
APIs.io Engineering Platform List commits on a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/files
APIs.io Engineering Platform List pull requests files
GET
/repos/{owner}/{repo}/pulls/{pull_number}/merge
APIs.io Engineering Platform Check if a pull request has been merged
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/merge
APIs.io Engineering Platform Merge a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
APIs.io Engineering Platform Get all requested reviewers for a pull request
POST
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
APIs.io Engineering Platform Request reviewers for a pull request
DELETE
/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers
APIs.io Engineering Platform Remove requested reviewers from a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews
APIs.io Engineering Platform List reviews for a pull request
POST
/repos/{owner}/{repo}/pulls/{pull_number}/reviews
APIs.io Engineering Platform Create a review for a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
APIs.io Engineering Platform Get a review for a pull request
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
APIs.io Engineering Platform Update a review for a pull request
DELETE
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}
APIs.io Engineering Platform Delete a pending review for a pull request
GET
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments
APIs.io Engineering Platform List comments for a pull request review
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals
APIs.io Engineering Platform Dismiss a review for a pull request
POST
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events
APIs.io Engineering Platform Submit a review for a pull request
PUT
/repos/{owner}/{repo}/pulls/{pull_number}/update-branch
APIs.io Engineering Platform Update a pull request branch
Schemas 27
The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are repository (95 properties), pull-request (48 properties), pull-request-simple (36 properties), pull-request-review-comment (29 properties). Each schema is shown below with its type and property counts.
nullable-simple-user
object
A GitHub user.
21 properties
18 required
auto-merge
object
The status of auto merging a pull request.
4 properties
4 required
repository
object
A repository on GitHub.
95 properties
73 required
pull-request-simple
object
Pull Request Simple
36 properties
31 required
nullable-milestone
object
A collection of related issues and pull requests.
16 properties
16 required
diff-entry
object
Diff Entry
11 properties
9 required
basic-error
object
Basic Error
4 properties
reaction-rollup
object
10 properties
10 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
validation-error
object
Validation Error
3 properties
2 required
pull-request-review-request
object
Pull Request Review Request
2 properties
2 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
validation-error-simple
object
Validation Error Simple
3 properties
2 required
simple-user
object
A GitHub user.
21 properties
18 required
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties
10 required
verification
object
4 properties
4 required
empty-object
object
An object without any properties.
nullable-team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
link
object
Hypermedia Link
1 property
1 required
commit
object
Commit
11 properties
9 required
nullable-license-simple
object
License Simple
6 properties
5 required
author-association
string
How the author is associated with the repository.
pull-request-merge-result
object
Pull Request Merge Result
3 properties
3 required
pull-request
object
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of…
48 properties
42 required
nullable-git-user
object
Metaproperties for Git author/committer information.
3 properties
review-comment
object
Legacy Review Comment
28 properties
18 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
#Pulls