Checks if a pull request has been merged into the base branch. The HTTP status of the response indicates whether or not the pull request has been merged; the response body is empty.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Creates a reply to a review comment for a pull request. For the comment_id, provide the ID of the review comment you are replying to. This must be the ID of a top-level review comment, not a reply to that comment. Replies to replies are not supported. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Creates a review on a specified pull request. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." Pull request reviews created in the PENDING state are not submitted and therefore do not include the submitted_at property in the response. To create a pending review for a pull request, leave the event parameter blank. For more information about submitting a PENDING review, see "Submit a review for a pull request." Note: To comment on a specific line in a file, you need to first determine the position of that line in the diff. To see a pull request diff, add the application/vnd.github.v3.diff media type to the Accept header of a call to the Get a pull request endpoint. The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Creates a review comment on the diff of a specified pull request. To add a regular comment to a pull request timeline, see "Create an issue comment." If your comment applies to more than one line in the pull request diff, you should use the parameters line, side, and optionally start_line and start_side in your request. The position parameter is deprecated. If you use position, the line, side, start_line, and start_side parameters are not required. This endpoint triggers notifications. Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "Rate limits for the API" and "Best practices for using the REST API." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Deletes a pull request review that has not been submitted. Submitted reviews cannot be deleted. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Dismisses a specified review on a pull request. Note: To dismiss a pull request review on a protected branch, you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation. Lists details of a pull request by providing its number. When you get, create, or edit a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the mergeable key. For more information, see "Checking mergeability of pull requests". The value of the mergeable attribute can be true, false, or null. If the value is null, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-null value for the mergeable attribute in the response. If mergeable is true, then merge_commit_sha will be the SHA of the test merge commit. The value of the merge_commit_sha attribute changes depending on the state of the pull request. Before merging a pull request, the merge_commit_sha attribute holds the SHA of the test merge commit. After merging a pull request, the merge_commit_sha attribute changes depending on how you merged the pull request: * If merged as a merge commit, merge_commit_sha represents the SHA of the merge commit. * If merged via a squash, merge_commit_sha represents the SHA of the squashed commit on the base branch. * If rebased, merge_commit_sha represents the commit that the base branch was updated to. Pass the appropriate media type to fetch diff and patch formats. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html. - application/vnd.github.diff: For more information, see "git-diff" in the Git documentation. If a diff is corrupt, contact us through the GitHub Support portal. Include the repository name and pull request ID in your message.
Retrieves a pull request review by its ID. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Provides details for a specified review comment. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Lists pull requests in a specified repository. Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Lists comments for a specific pull request review. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the List commits endpoint. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Lists the files in a specified pull request. Note: Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Gets the users or teams whose review is requested for a pull request. Once a requested reviewer submits a review, they are no longer considered a requested reviewer. Their review will instead be returned by the List reviews for a pull request operation.
Lists all review comments for a specified pull request. By default, review comments are in ascending order by ID. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Lists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Lists all reviews for a specified pull request. The list of reviews returns in chronological order. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Submits a pending review for a pull request. For more information about creating a pending review for a pull request, see "Create a review for a pull request." This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see GitHub’s products in the GitHub Help documentation. To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Updates the contents of a specified review summary comment. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.
Edits the content of a specified review comment. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github-commitcomment.raw+json: Returns the raw markdown body. Response will include body. This is the default if you do not pass any specific media type. - application/vnd.github-commitcomment.text+json: Returns a text only representation of the markdown body. Response will include body_text. - application/vnd.github-commitcomment.html+json: Returns HTML rendered from the body’s markdown. Response will include body_html. - application/vnd.github-commitcomment.full+json: Returns raw, text, and HTML representations. Response will include body, body_text, and body_html.