From 8f53094f0f22fe208f6f6e0d39037188bf14a937 Mon Sep 17 00:00:00 2001
From: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
Date: Thu, 12 Nov 2015 23:52:02 +0100
Subject: Add API docs and correctly expose release api

Signed-off-by: Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
---
 doc/api/tags.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)

(limited to 'doc/api')

diff --git a/doc/api/tags.md b/doc/api/tags.md
index dc69a0c6fbc..0113d4ba049 100644
--- a/doc/api/tags.md
+++ b/doc/api/tags.md
@@ -28,6 +28,10 @@ Parameters:
         "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
       ]
     },
+    "release": {
+      "tag": "1.0.0",
+      "description": "Amazing release. Wow"
+    },
     "name": "v1.0.0",
     "message": null
   }
@@ -48,6 +52,7 @@ Parameters:
 - `tag_name` (required) - The name of a tag
 - `ref` (required) - Create tag using commit SHA, another tag name, or branch name.
 - `message` (optional) - Creates annotated tag.
+- `release_description` (optional) - Add release notes to the git tag and store it in the GitLab database.
 
 ```json
 {
@@ -64,6 +69,10 @@ Parameters:
       "2a4b78934375d7f53875269ffd4f45fd83a84ebe"
     ]
   },
+  "release": {
+    "tag": "1.0.0",
+    "description": "Amazing release. Wow"
+  },
   "name": "v1.0.0",
   "message": null
 }
@@ -73,3 +82,25 @@ it will contain the annotation.
 
 It returns 200 if the operation succeed. In case of an error,
 405 with an explaining error message is returned.
+
+
+## New release
+
+Add release notes to the existing git tag
+
+```
+PUT /projects/:id/repository/:tag/release
+```
+
+Parameters:
+
+- `id` (required) - The ID of a project
+- `tag` (required) - The name of a tag
+- `description` (required) - Release notes with markdown support
+
+```json
+{
+  "tag": "1.0.0",
+  "description": "Amazing release. Wow"
+}
+```
-- 
cgit v1.2.1