diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2015-11-22 00:34:53 +0300 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2015-11-22 00:34:53 +0300 |
| commit | 04a3d27eaba0312d99e8d88a3a9ee4b5c83ecce1 (patch) | |
| tree | 76edf025912fa34c1942f98deefb406148953842 /doc/api/tags.md | |
| parent | 3ea05c5b5b253de33d8bf8d615c66e2935b940ef (diff) | |
Allow editing a release in API via PUT method
Diffstat (limited to 'doc/api/tags.md')
| -rw-r--r-- | doc/api/tags.md | 23 |
1 files changed, 23 insertions, 0 deletions
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 |