diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2017-02-21 10:00:33 +0100 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2017-02-21 12:01:15 +0100 |
| commit | 1ef911f0e086badcb717c68cd1817c68ed8b4d8d (patch) | |
| tree | 4e8f7f9a7b386b4e97b0ae6c0a8826cbd7c03de2 /doc/api/todos.md | |
| parent | b596dd8fedd9dc8f9487e1e67a52a7b211bd956b (diff) | |
| download | gitlab-ce-1ef911f0e086badcb717c68cd1817c68ed8b4d8d.tar.gz | |
API: Use POST requests to mark todos as done
Diffstat (limited to 'doc/api/todos.md')
| -rw-r--r-- | doc/api/todos.md | 15 |
1 files changed, 5 insertions, 10 deletions
diff --git a/doc/api/todos.md b/doc/api/todos.md index a5e81801024..a2fbbc7e1f8 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -184,7 +184,7 @@ Marks a single pending todo given by its ID for the current user as done. The todo marked as done is returned in the response. ``` -DELETE /todos/:id +POST /todos/:id/mark_as_done ``` Parameters: @@ -194,7 +194,7 @@ Parameters: | `id` | integer | yes | The ID of a todo | ```bash -curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos/130 +curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos/130/mark_as_done ``` Example Response: @@ -277,20 +277,15 @@ Example Response: ## Mark all todos as done -Marks all pending todos for the current user as done. It returns the number of marked todos. +Marks all pending todos for the current user as done. It returns the HTTP status code `204` with an empty response. ``` -DELETE /todos +POST /todos/mark_as_done ``` ```bash -curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos +curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/todos/donmark_as_donee ``` -Example Response: - -```json -3 -``` [ce-3188]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3188 |