Preview the new Draft Pull Requests API
- February 14, 2019
-
skalnik
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.
We're releasing new GraphQL mutations and fields that allow you to handle draft pull requests. We're also showing the draft boolean in REST API responses. When this boolean is true, the pull request is in a draft state, and cannot be merged. For more information about draft pull requests, see "About pull requests" in the GitHub Help documentation.
[Updated 03-22-19] You can also create draft pull requests using a new draft field in the Create a pull request endpoint.
Changes
- REST API pull request responses include
draftboolean CreatePullRequestInputincludesdraftbooleanmarkPullRequestReadyForReviewmutationPullRequestobject includesdraftfield
To access these new API endpoints during the preview period, you must provide a custom media type in the Accept header:
application/vnd.github.shadow-cat-preview+json
During the preview period, we may change aspects of these API endpoints based on developer feedback. If we do, we will announce the changes here on the developer blog, but we will not provide any advance notice.
If you have any questions or feedback, please let us know!