Update documentation
This commit is contained in:
parent
55f2425a67
commit
ca68c81733
|
@ -514,7 +514,7 @@ If the user is already subscribed to the issue, the status code `304`
|
|||
is returned.
|
||||
|
||||
```
|
||||
POST /projects/:id/issues/:issue_id/subscription
|
||||
POST /projects/:id/issues/:issue_id/subscribe
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
@ -523,7 +523,7 @@ POST /projects/:id/issues/:issue_id/subscription
|
|||
| `issue_id` | integer | yes | The ID of a project's issue |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/subscription
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/subscribe
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
@ -569,7 +569,7 @@ from it. If the user is not subscribed to the issue, the
|
|||
status code `304` is returned.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/issues/:issue_id/subscription
|
||||
DELETE /projects/:id/issues/:issue_id/unsubscribe
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
@ -578,7 +578,7 @@ DELETE /projects/:id/issues/:issue_id/subscription
|
|||
| `issue_id` | integer | yes | The ID of a project's issue |
|
||||
|
||||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/subscription
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/issues/93/unsubscribe
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
|
|
@ -193,7 +193,7 @@ If the user is already subscribed to the label, the status code `304`
|
|||
is returned.
|
||||
|
||||
```
|
||||
POST /projects/:id/labels/:label_id/subscription
|
||||
POST /projects/:id/labels/:label_id/subscribe
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
@ -202,7 +202,7 @@ POST /projects/:id/labels/:label_id/subscription
|
|||
| `label_id` | integer or string | yes | The ID or title of a project's label |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/labels/1/subscription
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/labels/1/subscribe
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
@ -228,7 +228,7 @@ from it. If the user is not subscribed to the label, the
|
|||
status code `304` is returned.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/labels/:label_id/subscription
|
||||
DELETE /projects/:id/labels/:label_id/unsubscribe
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
@ -237,7 +237,7 @@ DELETE /projects/:id/labels/:label_id/subscription
|
|||
| `label_id` | integer or string | yes | The ID or title of a project's label |
|
||||
|
||||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/labels/1/subscription
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/labels/1/unsubscribe
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
|
|
@ -667,7 +667,7 @@ Subscribes the authenticated user to a merge request to receive notification. If
|
|||
status code `304` is returned.
|
||||
|
||||
```
|
||||
POST /projects/:id/merge_requests/:merge_request_id/subscription
|
||||
POST /projects/:id/merge_requests/:merge_request_id/subscribe
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
@ -676,7 +676,7 @@ POST /projects/:id/merge_requests/:merge_request_id/subscription
|
|||
| `merge_request_id` | integer | yes | The ID of the merge request |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/17/subscription
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/17/subscribe
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
@ -741,7 +741,7 @@ notifications from that merge request. If the user is
|
|||
not subscribed to the merge request, the status code `304` is returned.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/merge_requests/:merge_request_id/subscription
|
||||
DELETE /projects/:id/merge_requests/:merge_request_id/unsubscribe
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
|
@ -750,7 +750,7 @@ DELETE /projects/:id/merge_requests/:merge_request_id/subscription
|
|||
| `merge_request_id` | integer | yes | The ID of the merge request |
|
||||
|
||||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/17/subscription
|
||||
curl --request POST --header "PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK" https://gitlab.example.com/api/v3/projects/5/merge_requests/17/unsubscribe
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
|
|
@ -29,5 +29,5 @@ changes are in V4:
|
|||
- Return pagination headers for all endpoints that return an array
|
||||
- Removed `DELETE projects/:id/deploy_keys/:key_id/disable`. Use `DELETE projects/:id/deploy_keys/:key_id` instead
|
||||
- Moved `PUT /users/:id/(block|unblock)` to `POST /users/:id/(block|unblock)`
|
||||
- Make subscription API more RESTful. Use `post ":id/#{type}/:subscribable_id/subscribe"` to subscribe and `post ":id/#{type}/:subscribable_id/unsubscribe"` to unsubscribe from a resource.
|
||||
- Make subscription API more RESTful. Use `post ":project_id/:subscribable_type/:subscribable_id/subscribe"` to subscribe and `post ":project_id/:subscribable_type/:subscribable_id/unsubscribe"` to unsubscribe from a resource.
|
||||
- Labels filter on `projects/:id/issues` and `/issues` now matches only issues containing all labels (i.e.: Logical AND, not OR)
|
||||
|
|
Loading…
Reference in New Issue