diff options
| author | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-12 18:52:43 +0200 |
|---|---|---|
| committer | Robert Schilling <rschilling@student.tugraz.at> | 2016-04-13 14:26:41 +0200 |
| commit | 3ab9ea8dae1edc6ab8c8563843342890736eb24c (patch) | |
| tree | ca7d663b5f6761db6973101338bf8c5fb8a838e6 /doc | |
| parent | ea2193aaeb1127746dc78d2dda7037d998911662 (diff) | |
| download | gitlab-ce-3ab9ea8dae1edc6ab8c8563843342890736eb24c.tar.gz | |
Make staring API more restful
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/projects.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md index c5ffc5514c7..b25c9080080 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -493,8 +493,8 @@ 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 `201` and the project on success and +`304` if the project is already starred. ``` POST /projects/:id/star @@ -556,11 +556,11 @@ Example response: ### Unstar a project -Unstars a given project. Returns status code 201 and the project on success -and 304 if the project is already unstarred. +Unstars a given project. Returns status code `200` and the project on success +and `304` if the project is not starred. ``` -POST /projects/:id/unstar +DELETE /projects/:id/star ``` | Attribute | Type | Required | Description | @@ -568,7 +568,7 @@ POST /projects/:id/unstar | `id` | integer | yes | The ID of the project | ```bash -curl -X POST -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/unstar" +curl -X DELETE -H "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star" ``` Example response: |