diff options
author | Drew DeVault <sir@cmpwn.com> | 2020-08-25 15:58:51 -0400 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2020-08-25 15:58:51 -0400 |
commit | 629afc3d112f39ad1c4ece23f2ab6a5d0a014164 (patch) | |
tree | 9768c0e2542aa06eff5fd60e4910e10f2262bda4 /todo.sr.ht/api.md | |
parent | 6d1e92ad04507b6d257f868e4000bd0b6a373cf2 (diff) | |
download | sr.ht-docs-629afc3d112f39ad1c4ece23f2ab6a5d0a014164.tar.gz |
todo.sr.ht: document new comment editing API
Diffstat (limited to 'todo.sr.ht/api.md')
-rw-r--r-- | todo.sr.ht/api.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/todo.sr.ht/api.md b/todo.sr.ht/api.md index 60f83ef..2aff6ce 100644 --- a/todo.sr.ht/api.md +++ b/todo.sr.ht/api.md @@ -415,6 +415,30 @@ implies the authenticated user. **OAuth scope**: `tickets:read` +### PUT /api/user/:username/trackers/:tracker-name/tickets/:ticket-id/comments/:comment-id + +Edits a comment. Note that the *comment* ID is required, not the event ID. + +**Request body** + +```json +{ + "text": "new comment text (markdown)" +} +``` + +List of [event resources](#event-resource) associated with this ticket. + +**OAuth scope**: `tickets:write` + +### PUT /api/trackers/:tracker-name/tickets/:ticket-id/comments/:comment-id + +Equivalent to +[/api/user/:username/trackers/:tracker-name/tickets/:ticket-id/comments/:comment-id](#get-apiuserusernametrackerstrackernameticketsticketidcommentscommentid), +implies the authenticated user. + +**OAuth scope**: `tickets:write` + ## Webhooks ### /api/user/... |