From ed61d44e1edfd41c36ec9085aa95f470bb5699fa Mon Sep 17 00:00:00 2001 From: Luis Alonso Chavez Armendariz Date: Thu, 24 Nov 2016 10:28:52 -0700 Subject: Remove unnecessary sentences for status codes in the API documentation --- doc/api/tags.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) (limited to 'doc/api/tags.md') diff --git a/doc/api/tags.md b/doc/api/tags.md index 398b080e3f6..14573d48fe4 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -40,9 +40,7 @@ Parameters: ## Get a single repository tag -Get a specific repository tag determined by its name. It returns `200` together -with the tag information if the tag exists. It returns `404` if the tag does not -exist. +Get a specific repository tag determined by its name. ``` GET /projects/:id/repository/tags/:tag_name @@ -124,14 +122,12 @@ Parameters: The message will be `nil` when creating a lightweight tag otherwise it will contain the annotation. -It returns 201 if the operation succeed. In case of an error, -405 with an explaining error message is returned. +In case of an error, +status code `405` with an explaining error message is returned. ## Delete a tag -Deletes a tag of a repository with given name. On success, this API method -returns 200 with the name of the deleted tag. If the tag does not exist, the -API returns 404. +Deletes a tag of a repository with given name. ``` DELETE /projects/:id/repository/tags/:tag_name @@ -150,9 +146,8 @@ Parameters: ## Create a new release -Add release notes to the existing git tag. It returns 201 if the release is -created successfully. If the tag does not exist, 404 is returned. If there -already exists a release for the given tag, 409 is returned. +Add release notes to the existing git tag. If there +already exists a release for the given tag, status code `409` is returned. ``` POST /projects/:id/repository/tags/:tag_name/release @@ -173,9 +168,7 @@ Parameters: ## 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. +Updates the release notes of a given release. ``` PUT /projects/:id/repository/tags/:tag_name/release -- cgit v1.2.3