summaryrefslogtreecommitdiff
path: root/doc/api
diff options
context:
space:
mode:
authorRobert Schilling <rschilling@student.tugraz.at>2017-02-20 15:14:48 +0100
committerRobert Schilling <rschilling@student.tugraz.at>2017-02-20 15:14:48 +0100
commit039c6d60fa2cc455956fb0016fc39f3e89a1a88f (patch)
treec421d86147adf041aa8f5dee3e5c8ae7606bf571 /doc/api
parentc89449e6110c2bdf6e1410bae3e7b7d807c5e305 (diff)
downloadgitlab-ce-039c6d60fa2cc455956fb0016fc39f3e89a1a88f.tar.gz
API: Moved `DELETE /projects/:id/star` to `POST /projects/:id/unstar`api-star-restful
Diffstat (limited to 'doc/api')
-rw-r--r--doc/api/projects.md6
-rw-r--r--doc/api/v3_to_v4.md1
2 files changed, 4 insertions, 3 deletions
diff --git a/doc/api/projects.md b/doc/api/projects.md
index b3136be6731..e9ef03a0c0c 100644
--- a/doc/api/projects.md
+++ b/doc/api/projects.md
@@ -609,7 +609,7 @@ Example response:
Unstars a given project. Returns status code `304` if the project is not starred.
```
-DELETE /projects/:id/star
+POST /projects/:id/unstar
```
| Attribute | Type | Required | Description |
@@ -617,7 +617,7 @@ DELETE /projects/:id/star
| `id` | integer/string | yes | The ID of the project or NAMESPACE/PROJECT_NAME |
```bash
-curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/star"
+curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" "https://gitlab.example.com/api/v3/projects/5/unstar"
```
Example response:
@@ -1194,4 +1194,4 @@ Parameters:
| --------- | ---- | -------- | ----------- |
| `query` | string | yes | A string contained in the project name |
| `order_by` | string | no | Return requests ordered by `id`, `name`, `created_at` or `last_activity_at` fields |
-| `sort` | string | no | Return requests sorted in `asc` or `desc` order | \ No newline at end of file
+| `sort` | string | no | Return requests sorted in `asc` or `desc` order |
diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md
index 0e7c5251329..149927250f2 100644
--- a/doc/api/v3_to_v4.md
+++ b/doc/api/v3_to_v4.md
@@ -13,6 +13,7 @@ changes are in V4:
- Project snippets do not return deprecated field `expires_at`
- Endpoints under `projects/:id/keys` have been removed (use `projects/:id/deploy_keys`)
- Status 409 returned for POST `project/:id/members` when a member already exists
+- Moved `DELETE /projects/:id/star` to `POST /projects/:id/unstar`
- Removed the following deprecated Templates endpoints (these are still accessible with `/templates` prefix)
- `/licences`
- `/licences/:key`