summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFodor Zoltan <fodor18zoltan@gmail.com>2018-05-03 08:53:20 +0000
committerRémy Coutable <remy@rymai.me>2018-08-21 19:49:58 +0200
commit5b1a00b669b7e3ae9437a4825ecd00a4bcb4abbd (patch)
tree67cc82a35e3d4a9da3db5f6099423eb850aa2c95
parent8ec222a5fa4d74ed27e991360d5cef0253779431 (diff)
downloadgitlab-ce-5b1a00b669b7e3ae9437a4825ecd00a4bcb4abbd.tar.gz
Update tags release POST and PUT to be more specific.md
Originally submitted at https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5557. Signed-off-by: Rémy Coutable <remy@rymai.me>
-rw-r--r--doc/api/tags.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/api/tags.md b/doc/api/tags.md
index 4af096c3c0c..f2a3f9f28d2 100644
--- a/doc/api/tags.md
+++ b/doc/api/tags.md
@@ -174,10 +174,21 @@ Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `tag_name` (required) - The name of a tag
+
+Request body:
+
- `description` (required) - Release notes with markdown support
```json
{
+ "description": "Amazing release. Wow"
+}
+```
+
+Response:
+
+```json
+{
"tag_name": "1.0.0",
"description": "Amazing release. Wow"
}
@@ -195,10 +206,21 @@ Parameters:
- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user
- `tag_name` (required) - The name of a tag
+
+Request body:
+
- `description` (required) - Release notes with markdown support
```json
{
+ "description": "Amazing release. Wow"
+}
+```
+
+Response:
+
+```json
+{
"tag_name": "1.0.0",
"description": "Amazing release. Wow"
}