diff options
| author | Rémy Coutable <remy@rymai.me> | 2016-11-25 15:43:05 +0000 |
|---|---|---|
| committer | Rémy Coutable <remy@rymai.me> | 2016-11-25 15:43:05 +0000 |
| commit | d03ca3d02e39d32e41e26f1100dcb793a7d758ad (patch) | |
| tree | 59fb7106ffe39767de8c9692ac5f5b647d303af8 /doc/api/projects.md | |
| parent | fc0350118385df28e435488cbf4be35e5cfbe70b (diff) | |
| parent | ed61d44e1edfd41c36ec9085aa95f470bb5699fa (diff) | |
| download | gitlab-ce-d03ca3d02e39d32e41e26f1100dcb793a7d758ad.tar.gz | |
Merge branch 'issue-24534' into 'master'
Remove unnecessary sentences for return codes in the API documentation
Closes #24534
See merge request !7511
Diffstat (limited to 'doc/api/projects.md')
| -rw-r--r-- | doc/api/projects.md | 19 |
1 files changed, 3 insertions, 16 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index bd27a0a6fae..de57f91bb8e 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -645,7 +645,7 @@ Parameters: ### Edit project -Updates an existing project +Updates an existing project. ``` PUT /projects/:id @@ -676,9 +676,6 @@ Parameters: | `lfs_enabled` | boolean | no | Enable LFS | | `request_access_enabled` | boolean | no | Allow users to request member access | -On success, method returns 200 with the updated project. If parameters are -invalid, 400 is returned. - ### Fork project Forks a project into the user namespace of the authenticated user or the one provided. @@ -696,8 +693,7 @@ Parameters: ### Star a project -Stars a given project. Returns status code `201` and the project on success and -`304` if the project is already starred. +Stars a given project. Returns status code `304` if the project is already starred. ``` POST /projects/:id/star @@ -767,8 +763,7 @@ Example response: ### Unstar a project -Unstars a given project. Returns status code `200` and the project on success -and `304` if the project is not starred. +Unstars a given project. Returns status code `304` if the project is not starred. ``` DELETE /projects/:id/star @@ -839,10 +834,6 @@ Example response: Archives the project if the user is either admin or the project owner of this project. This action is idempotent, thus archiving an already archived project will not change the project. -Status code 201 with the project as body is given when successful, in case the user doesn't -have the proper access rights, code 403 is returned. Status 404 is returned if the project -doesn't exist, or is hidden to the user. - ``` POST /projects/:id/archive ``` @@ -928,10 +919,6 @@ Example response: Unarchives the project if the user is either admin or the project owner of this project. This action is idempotent, thus unarchiving an non-archived project will not change the project. -Status code 201 with the project as body is given when successful, in case the user doesn't -have the proper access rights, code 403 is returned. Status 404 is returned if the project -doesn't exist, or is hidden to the user. - ``` POST /projects/:id/unarchive ``` |