diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-06 02:21:02 +0300 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-12 15:24:05 +0300 |
| commit | ba21c00f01bf4274d0e4cc3892293fc1e581b260 (patch) | |
| tree | 1d9133b41f4e30b8775002c72ef78ec28d213ace /doc/api/notes.md | |
| parent | 734df1bb504aedec6a5668567de808b549a84749 (diff) | |
Delete notes via API
Diffstat (limited to 'doc/api/notes.md')
| -rw-r--r-- | doc/api/notes.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/doc/api/notes.md b/doc/api/notes.md index 9168ab00d7e..82494bf83ff 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -105,6 +105,21 @@ Parameters: - `note_id` (required) - The ID of a note - `body` (required) - The content of a note +### Delete existing issue note + +Deletes an existing note of an issue. On success, this API method returns 200. +If the note does not exist, the API returns 404. + +``` +DELETE /projects/:id/issues/:issue_id/notes/:note_id +``` + +Parameters: + +- `id` (required) - The ID of a project +- `issue_id` (required) - The ID of an issue +- `note_id` (required) - The ID of a note + ## Snippets ### List all snippet notes @@ -182,6 +197,21 @@ Parameters: - `note_id` (required) - The ID of a note - `body` (required) - The content of a note +### Delete existing snippet note + +Deletes an existing note of a snippet. On success, this API method returns 200. +If the note does not exist, the API returns 404. + +``` +DELETE /projects/:id/snippets/:snippet_id/notes/:note_id +``` + +Parameters: + +- `id` (required) - The ID of a project +- `snippet_id` (required) - The ID of a snippet +- `note_id` (required) - The ID of a note + ## Merge Requests ### List all merge request notes @@ -262,3 +292,18 @@ Parameters: - `merge_request_id` (required) - The ID of a merge request - `note_id` (required) - The ID of a note - `body` (required) - The content of a note + +### Delete existing snippet note + +Deletes an existing note of a merge request. On success, this API method returns +200. If the note does not exist, the API returns 404. + +``` +DELETE /projects/:id/merge_requests/:merge_request_id/notes/:note_id +``` + +Parameters: + +- `id` (required) - The ID of a project +- `merge_request_id` (required) - The ID of a merge request +- `note_id` (required) - The ID of a note |