Pull requests
Planned. Pull request endpoints are not yet shipped.
Planned routes
| Method | Path | Scope |
|---|---|---|
| GET | /api/v1/repos/{owner}/{repo}/pulls |
repo:read |
| GET | /api/v1/repos/{owner}/{repo}/pulls/{number} |
repo:read |
| POST | /api/v1/repos/{owner}/{repo}/pulls |
repo |
| PATCH | /api/v1/repos/{owner}/{repo}/pulls/{number} |
repo |
| GET | /api/v1/repos/{owner}/{repo}/pulls/{number}/files |
repo:read |
| GET | /api/v1/repos/{owner}/{repo}/pulls/{number}/commits |
repo:read |
| GET | /api/v1/repos/{owner}/{repo}/pulls/{number}/reviews |
repo:read |
| POST | /api/v1/repos/{owner}/{repo}/pulls/{number}/reviews |
repo |
| PUT | /api/v1/repos/{owner}/{repo}/pulls/{number}/merge |
repo |
| GET | /api/v1/repos/{owner}/{repo}/pulls/{number}/comments |
repo:read |
| POST | /api/v1/repos/{owner}/{repo}/pulls/{number}/comments |
repo |
The merge endpoint is gated by branch protection: status checks, required reviewers, and conversation-resolution rules apply identically to API-driven and UI-driven merges.
View source
| 1 | # Pull requests |
| 2 | |
| 3 | > **Planned.** Pull request endpoints are not yet shipped. |
| 4 | |
| 5 | ## Planned routes |
| 6 | |
| 7 | | Method | Path | Scope | |
| 8 | |--------|----------------------------------------------------------|--------------| |
| 9 | | GET | `/api/v1/repos/{owner}/{repo}/pulls` | `repo:read` | |
| 10 | | GET | `/api/v1/repos/{owner}/{repo}/pulls/{number}` | `repo:read` | |
| 11 | | POST | `/api/v1/repos/{owner}/{repo}/pulls` | `repo` | |
| 12 | | PATCH | `/api/v1/repos/{owner}/{repo}/pulls/{number}` | `repo` | |
| 13 | | GET | `/api/v1/repos/{owner}/{repo}/pulls/{number}/files` | `repo:read` | |
| 14 | | GET | `/api/v1/repos/{owner}/{repo}/pulls/{number}/commits` | `repo:read` | |
| 15 | | GET | `/api/v1/repos/{owner}/{repo}/pulls/{number}/reviews` | `repo:read` | |
| 16 | | POST | `/api/v1/repos/{owner}/{repo}/pulls/{number}/reviews` | `repo` | |
| 17 | | PUT | `/api/v1/repos/{owner}/{repo}/pulls/{number}/merge` | `repo` | |
| 18 | | GET | `/api/v1/repos/{owner}/{repo}/pulls/{number}/comments` | `repo:read` | |
| 19 | | POST | `/api/v1/repos/{owner}/{repo}/pulls/{number}/comments` | `repo` | |
| 20 | |
| 21 | The merge endpoint is gated by branch protection: status checks, |
| 22 | required reviewers, and conversation-resolution rules apply |
| 23 | identically to API-driven and UI-driven merges. |