Issues
Planned. Issues over the API are not yet shipped. The web UI is the only authoring surface today.
Planned routes
| Method | Path | Scope |
|---|---|---|
| GET | /api/v1/repos/{owner}/{repo}/issues |
repo:read |
| GET | /api/v1/repos/{owner}/{repo}/issues/{number} |
repo:read |
| POST | /api/v1/repos/{owner}/{repo}/issues |
repo |
| PATCH | /api/v1/repos/{owner}/{repo}/issues/{number} |
repo |
| GET | /api/v1/repos/{owner}/{repo}/issues/{number}/comments |
repo:read |
| POST | /api/v1/repos/{owner}/{repo}/issues/{number}/comments |
repo |
| PATCH | /api/v1/repos/{owner}/{repo}/issues/comments/{id} |
repo |
| DELETE | /api/v1/repos/{owner}/{repo}/issues/comments/{id} |
repo |
Filters on the list endpoint will mirror the web filters
(state, author, assignee, label, milestone, since,
sort, direction).
Markdown rendering
Posted bodies are stored as raw markdown. Rendering happens at
read time, with the same internal/markdown pipeline the web UI
uses, so an API consumer sees the same HTML the browser would.
View source
| 1 | # Issues |
| 2 | |
| 3 | > **Planned.** Issues over the API are not yet shipped. The web |
| 4 | > UI is the only authoring surface today. |
| 5 | |
| 6 | ## Planned routes |
| 7 | |
| 8 | | Method | Path | Scope | |
| 9 | |--------|--------------------------------------------------------|--------------| |
| 10 | | GET | `/api/v1/repos/{owner}/{repo}/issues` | `repo:read` | |
| 11 | | GET | `/api/v1/repos/{owner}/{repo}/issues/{number}` | `repo:read` | |
| 12 | | POST | `/api/v1/repos/{owner}/{repo}/issues` | `repo` | |
| 13 | | PATCH | `/api/v1/repos/{owner}/{repo}/issues/{number}` | `repo` | |
| 14 | | GET | `/api/v1/repos/{owner}/{repo}/issues/{number}/comments`| `repo:read` | |
| 15 | | POST | `/api/v1/repos/{owner}/{repo}/issues/{number}/comments`| `repo` | |
| 16 | | PATCH | `/api/v1/repos/{owner}/{repo}/issues/comments/{id}` | `repo` | |
| 17 | | DELETE | `/api/v1/repos/{owner}/{repo}/issues/comments/{id}` | `repo` | |
| 18 | |
| 19 | Filters on the list endpoint will mirror the web filters |
| 20 | (`state`, `author`, `assignee`, `label`, `milestone`, `since`, |
| 21 | `sort`, `direction`). |
| 22 | |
| 23 | ## Markdown rendering |
| 24 | |
| 25 | Posted bodies are stored as raw markdown. Rendering happens at |
| 26 | read time, with the same `internal/markdown` pipeline the web UI |
| 27 | uses, so an API consumer sees the same HTML the browser would. |