From 04a3d27eaba0312d99e8d88a3a9ee4b5c83ecce1 Mon Sep 17 00:00:00 2001
From: Robert Schilling <rschilling@student.tugraz.at>
Date: Sat, 21 Nov 2015 22:34:53 +0100
Subject: Allow editing a release in API via PUT method

---
 doc/api/tags.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'doc/api')

diff --git a/doc/api/tags.md b/doc/api/tags.md
index bc61aa1118f..085d387e824 100644
--- a/doc/api/tags.md
+++ b/doc/api/tags.md
@@ -106,3 +106,26 @@ Parameters:
   "description": "Amazing release. Wow"
 }
 ```
+
+## Update a release
+
+Updates the release notes of a given release. It returns 200 if the release is
+successfully updated. If the tag or the release does not exist, it returns 404
+with a proper error message.
+
+```
+PUT /projects/:id/repository/tags/:tag_name/release
+```
+
+Parameters:
+
+- `id` (required) - The ID of a project
+- `tag_name` (required) - The name of a tag
+- `description` (required) - Release notes with markdown support
+
+```json
+{
+  "tag_name": "1.0.0",
+  "description": "Amazing release. Wow"
+}
+```
\ No newline at end of file
-- 
cgit v1.2.1