Port some EE API docs to CE
The following EE files had small differences with their CE counterpart so they have been ported to CE: - doc/api/boards.md - doc/api/discussions.md - doc/api/notes.md - doc/api/resource_label_events.md - doc/api/services.md
This commit is contained in:
Achilleas Pipinellis
Evan Read
parent
1c508b951c
commit
77eb61e898
|
|
@ -141,6 +141,173 @@ Example response:
|
|||
}
|
||||
```
|
||||
|
||||
## Create a board **[STARTER]**
|
||||
|
||||
Creates a board.
|
||||
|
||||
```
|
||||
POST /projects/:id/boards
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||
| `name` | string | yes | The name of the new board |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards?name=newboard
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"project": {
|
||||
"id": 5,
|
||||
"name": "Diaspora Project Site",
|
||||
"name_with_namespace": "Diaspora / Diaspora Project Site",
|
||||
"path": "diaspora-project-site",
|
||||
"path_with_namespace": "diaspora/diaspora-project-site",
|
||||
"http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
|
||||
"web_url": "http://example.com/diaspora/diaspora-project-site"
|
||||
},
|
||||
"name": "newboard",
|
||||
"milestone": {
|
||||
"id": 12
|
||||
"title": "10.0"
|
||||
},
|
||||
"lists" : [
|
||||
{
|
||||
"id" : 1,
|
||||
"label" : {
|
||||
"name" : "Testing",
|
||||
"color" : "#F0AD4E",
|
||||
"description" : null
|
||||
},
|
||||
"position" : 1
|
||||
},
|
||||
{
|
||||
"id" : 2,
|
||||
"label" : {
|
||||
"name" : "Ready",
|
||||
"color" : "#FF0000",
|
||||
"description" : null
|
||||
},
|
||||
"position" : 2
|
||||
},
|
||||
{
|
||||
"id" : 3,
|
||||
"label" : {
|
||||
"name" : "Production",
|
||||
"color" : "#FF5F00",
|
||||
"description" : null
|
||||
},
|
||||
"position" : 3
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
## Update a board **[STARTER]**
|
||||
|
||||
> [Introduced][ee-5954] in [GitLab Starter](https://about.gitlab.com/pricing/) 11.1.
|
||||
|
||||
Updates a board.
|
||||
|
||||
```
|
||||
PUT /projects/:id/boards/:board_id
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ------------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||
| `board_id` | integer | yes | The ID of a board |
|
||||
| `name` | string | no | The new name of the board |
|
||||
| `assignee_id` | integer | no | The assignee the board should be scoped to |
|
||||
| `milestone_id` | integer | no | The milestone the board should be scoped to |
|
||||
| `labels` | string | no | Comma-separated list of label names which the board should be scoped to |
|
||||
| `weight` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
|
||||
|
||||
|
||||
```bash
|
||||
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1?name=new_name&milestone_id=43&assignee_id=1&labels=Doing&weight=4
|
||||
```
|
||||
|
||||
Example response:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 1,
|
||||
"project": {
|
||||
"id": 5,
|
||||
"name": "Diaspora Project Site",
|
||||
"name_with_namespace": "Diaspora / Diaspora Project Site",
|
||||
"path": "diaspora-project-site",
|
||||
"path_with_namespace": "diaspora/diaspora-project-site",
|
||||
"created_at": "2018-07-03T05:48:49.982Z",
|
||||
"default_branch": null,
|
||||
"tag_list": [],
|
||||
"ssh_url_to_repo": "ssh://user@example.com/diaspora/diaspora-project-site.git",
|
||||
"http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
|
||||
"web_url": "http://example.com/diaspora/diaspora-project-site",
|
||||
"readme_url": null,
|
||||
"avatar_url": null,
|
||||
"star_count": 0,
|
||||
"forks_count": 0,
|
||||
"last_activity_at": "2018-07-03T05:48:49.982Z"
|
||||
},
|
||||
"lists": [],
|
||||
"name": "new_name",
|
||||
"group": null,
|
||||
"milestone": {
|
||||
"id": 43,
|
||||
"iid": 1,
|
||||
"project_id": 15,
|
||||
"title": "Milestone 1",
|
||||
"description": "Milestone 1 desc",
|
||||
"state": "active",
|
||||
"created_at": "2018-07-03T06:36:42.618Z",
|
||||
"updated_at": "2018-07-03T06:36:42.618Z",
|
||||
"due_date": null,
|
||||
"start_date": null,
|
||||
"web_url": "http://example.com/root/board1/milestones/1"
|
||||
},
|
||||
"assignee": {
|
||||
"id": 1,
|
||||
"name": "Administrator",
|
||||
"username": "root",
|
||||
"state": "active",
|
||||
"avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
||||
"web_url": "http://example.com/root"
|
||||
},
|
||||
"labels": [{
|
||||
"id": 10,
|
||||
"name": "Doing",
|
||||
"color": "#5CB85C",
|
||||
"description": null
|
||||
}],
|
||||
"weight": 4
|
||||
}
|
||||
```
|
||||
|
||||
## Delete a board **[STARTER]**
|
||||
|
||||
Deletes a board.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/boards/:board_id
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------- | ---- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||
| `board_id` | integer | yes | The ID of a board |
|
||||
|
||||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1
|
||||
```
|
||||
|
||||
## List board lists
|
||||
|
||||
Get a list of the board's lists.
|
||||
|
|
@ -237,7 +404,15 @@ POST /projects/:id/boards/:board_id/lists
|
|||
| --------- | ---- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
|
||||
| `board_id` | integer | yes | The ID of a board |
|
||||
| `label_id` | integer | yes | The ID of a label |
|
||||
| `label_id` | integer | no | The ID of a label |
|
||||
| `assignee_id` **[PREMIUM]** | integer | no | The ID of a user |
|
||||
| `milestone_id` **[PREMIUM]** | integer | no | The ID of a milestone |
|
||||
|
||||
NOTE: **Note**:
|
||||
Label, assignee and milestone arguments are mutually exclusive,
|
||||
that is, only one of them are accepted in a request.
|
||||
Check the [Issue Board docs](../user/project/issue_board.md#summary-of-features-per-tier)
|
||||
for more information regarding the required license for each list type.
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists?label_id=5
|
||||
|
|
@ -307,3 +482,5 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id
|
|||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1
|
||||
```
|
||||
|
||||
[ee-5954]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5954
|
||||
|
|
|
|||
|
|
@ -1,6 +1,12 @@
|
|||
# Discussions API
|
||||
|
||||
Discussions are set of related notes on snippets, issues, merge requests or commits.
|
||||
Discussions are a set of related notes on:
|
||||
|
||||
- Snippets
|
||||
- Issues
|
||||
- Epics **[ULTIMATE]**
|
||||
- Merge requests
|
||||
- Commits
|
||||
|
||||
This includes system notes, which are notes about changes to the object (for example, when a milestone changes, there will be a corresponding system note). Label notes are not part of this API, but recorded as separate events in [resource label events](resource_label_events.md).
|
||||
|
||||
|
|
@ -424,6 +430,214 @@ Parameters:
|
|||
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/636
|
||||
```
|
||||
|
||||
## Epics **[ULTIMATE]**
|
||||
|
||||
### List group epic discussions
|
||||
|
||||
Gets a list of all discussions for a single epic.
|
||||
|
||||
```
|
||||
GET /groups/:id/epics/:epic_id/discussions
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ------------------- | ---------------- | ---------- | ------------ |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": "6a9c1750b37d513a43987b574953fceb50b03ce7",
|
||||
"individual_note": false,
|
||||
"notes": [
|
||||
{
|
||||
"id": 1126,
|
||||
"type": "DiscussionNote",
|
||||
"body": "discussion text",
|
||||
"attachment": null,
|
||||
"author": {
|
||||
"id": 1,
|
||||
"name": "root",
|
||||
"username": "root",
|
||||
"state": "active",
|
||||
"avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
|
||||
"web_url": "http://localhost:3000/root"
|
||||
},
|
||||
"created_at": "2018-03-03T21:54:39.668Z",
|
||||
"updated_at": "2018-03-03T21:54:39.668Z",
|
||||
"system": false,
|
||||
"noteable_id": 3,
|
||||
"noteable_type": "Epic",
|
||||
"noteable_id": null,
|
||||
"resolvable": false
|
||||
},
|
||||
{
|
||||
"id": 1129,
|
||||
"type": "DiscussionNote",
|
||||
"body": "reply to the discussion",
|
||||
"attachment": null,
|
||||
"author": {
|
||||
"id": 1,
|
||||
"name": "root",
|
||||
"username": "root",
|
||||
"state": "active",
|
||||
"avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
|
||||
"web_url": "http://localhost:3000/root"
|
||||
},
|
||||
"created_at": "2018-03-04T13:38:02.127Z",
|
||||
"updated_at": "2018-03-04T13:38:02.127Z",
|
||||
"system": false,
|
||||
"noteable_id": 3,
|
||||
"noteable_type": "Epic",
|
||||
"noteable_id": null,
|
||||
"resolvable": false
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": "87805b7c09016a7058e91bdbe7b29d1f284a39e6",
|
||||
"individual_note": true,
|
||||
"notes": [
|
||||
{
|
||||
"id": 1128,
|
||||
"type": null,
|
||||
"body": "a single comment",
|
||||
"attachment": null,
|
||||
"author": {
|
||||
"id": 1,
|
||||
"name": "root",
|
||||
"username": "root",
|
||||
"state": "active",
|
||||
"avatar_url": "https://www.gravatar.com/avatar/00afb8fb6ab07c3ee3e9c1f38777e2f4?s=80&d=identicon",
|
||||
"web_url": "http://localhost:3000/root"
|
||||
},
|
||||
"created_at": "2018-03-04T09:17:22.520Z",
|
||||
"updated_at": "2018-03-04T09:17:22.520Z",
|
||||
"system": false,
|
||||
"noteable_id": 3,
|
||||
"noteable_type": "Epic",
|
||||
"noteable_id": null,
|
||||
"resolvable": false
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
```bash
|
||||
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/discussions
|
||||
```
|
||||
|
||||
### Get single epic discussion
|
||||
|
||||
Returns a single discussion for a specific group epic
|
||||
|
||||
```
|
||||
GET /groups/:id/epics/:epic_id/discussions/:discussion_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `discussion_id` | integer | yes | The ID of a discussion |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7
|
||||
```
|
||||
|
||||
### Create new epic discussion
|
||||
|
||||
Creates a new discussion to a single group epic. This is similar to creating
|
||||
a note but but another comments (replies) can be added to it later.
|
||||
|
||||
```
|
||||
POST /groups/:id/epics/:epic_id/discussions
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `body` | string | yes | The content of a discussion |
|
||||
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/discussions?body=comment
|
||||
```
|
||||
|
||||
### Add note to existing epic discussion
|
||||
|
||||
Adds a new note to the discussion. This can also
|
||||
[create a discussion from a single comment](../user/discussions/#start-a-discussion-by-replying-to-a-standard-comment).
|
||||
|
||||
```
|
||||
POST /groups/:id/epics/:epic_id/discussions/:discussion_id/notes
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `discussion_id` | integer | yes | The ID of a discussion |
|
||||
| `note_id` | integer | yes | The ID of a discussion note |
|
||||
| `body` | string | yes | The content of a discussion |
|
||||
| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment
|
||||
```
|
||||
|
||||
### Modify existing epic discussion note
|
||||
|
||||
Modify existing discussion note of an epic.
|
||||
|
||||
```
|
||||
PUT /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `discussion_id` | integer | yes | The ID of a discussion |
|
||||
| `note_id` | integer | yes | The ID of a discussion note |
|
||||
| `body` | string | yes | The content of a discussion |
|
||||
|
||||
```bash
|
||||
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes/1108?body=comment
|
||||
```
|
||||
|
||||
### Delete an epic discussion note
|
||||
|
||||
Deletes an existing discussion note of an epic.
|
||||
|
||||
```
|
||||
DELETE /groups/:id/epics/:epic_id/discussions/:discussion_id/notes/:note_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `discussion_id` | integer | yes | The ID of a discussion |
|
||||
| `note_id` | integer | yes | The ID of a discussion note |
|
||||
|
||||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/636
|
||||
```
|
||||
|
||||
## Merge requests
|
||||
|
||||
### List project merge request discussions
|
||||
|
|
|
|||
130
doc/api/notes.md
130
doc/api/notes.md
|
|
@ -1,6 +1,11 @@
|
|||
# Notes API
|
||||
|
||||
Notes are comments on snippets, issues or merge requests.
|
||||
Notes are comments on:
|
||||
|
||||
- Snippets
|
||||
- Issues
|
||||
- Merge requests
|
||||
- Epics **[ULTIMATE]**
|
||||
|
||||
This includes system notes, which are notes about changes to the object (for example, when a milestone changes, there will be a corresponding system note). Label notes are not part of this API, but recorded as separate events in [resource label events](resource_label_events.md).
|
||||
|
||||
|
|
@ -390,3 +395,126 @@ Parameters:
|
|||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/merge_requests/7/notes/1602
|
||||
```
|
||||
|
||||
## Epics **[ULTIMATE]**
|
||||
|
||||
### List all epic notes
|
||||
|
||||
Gets a list of all notes for a single epic. Epic notes are comments users can post to an epic.
|
||||
|
||||
```
|
||||
GET /groups/:id/epics/:epic_id/notes
|
||||
GET /groups/:id/epics/:epic_id/notes?sort=asc&order_by=updated_at
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ------------------- | ---------------- | ---------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of a group epic |
|
||||
| `sort` | string | no | Return epic notes sorted in `asc` or `desc` order. Default is `desc` |
|
||||
| `order_by` | string | no | Return epic notes ordered by `created_at` or `updated_at` fields. Default is `created_at` |
|
||||
|
||||
```bash
|
||||
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/notes
|
||||
```
|
||||
|
||||
### Get single epic note
|
||||
|
||||
Returns a single note for a given epic.
|
||||
|
||||
```
|
||||
GET /groups/:id/epics/:epic_id/notes/:note_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `note_id` | integer | yes | The ID of a note |
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 52,
|
||||
"title": "Epic",
|
||||
"file_name": "epic.rb",
|
||||
"author": {
|
||||
"id": 1,
|
||||
"username": "pipin",
|
||||
"email": "admin@example.com",
|
||||
"name": "Pip",
|
||||
"state": "active",
|
||||
"created_at": "2013-09-30T13:46:01Z"
|
||||
},
|
||||
"expires_at": null,
|
||||
"updated_at": "2013-10-02T07:34:20Z",
|
||||
"created_at": "2013-10-02T07:34:20Z"
|
||||
}
|
||||
```
|
||||
|
||||
```bash
|
||||
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/11/notes/1
|
||||
```
|
||||
|
||||
### Create new epic note
|
||||
|
||||
Creates a new note for a single epic. Epic notes are comments users can post to an epic.
|
||||
If you create a note where the body only contains an Award Emoji, you'll receive this object back.
|
||||
|
||||
```
|
||||
POST /groups/:id/epics/:epic_id/notes
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `body` | string | yes | The content of a note |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note
|
||||
```
|
||||
|
||||
### Modify existing epic note
|
||||
|
||||
Modify existing note of an epic.
|
||||
|
||||
```
|
||||
PUT /groups/:id/epics/:epic_id/notes/:note_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `note_id` | integer | yes | The ID of a note |
|
||||
| `body` | string | yes | The content of a note |
|
||||
|
||||
```bash
|
||||
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/snippet/11/notes?body=note
|
||||
```
|
||||
|
||||
### Delete an epic note
|
||||
|
||||
Deletes an existing note of an epic.
|
||||
|
||||
```
|
||||
DELETE /groups/:id/epics/:epic_id/notes/:note_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `note_id` | integer | yes | The ID of a note |
|
||||
|
||||
```bash
|
||||
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/epics/52/notes/1659
|
||||
```
|
||||
|
|
|
|||
|
|
@ -88,6 +88,92 @@ Parameters:
|
|||
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/issues/11/resource_label_events/1
|
||||
```
|
||||
|
||||
## Epics **[ULTIMATE]**
|
||||
|
||||
### List group epic label events
|
||||
|
||||
Gets a list of all label events for a single epic.
|
||||
|
||||
```
|
||||
GET /groups/:id/epics/:epic_id/resource_label_events
|
||||
```
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| ------------------- | ---------------- | ---------- | ------------ |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id": 106,
|
||||
"user": {
|
||||
"id": 1,
|
||||
"name": "Administrator",
|
||||
"username": "root",
|
||||
"state": "active",
|
||||
"avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
||||
"web_url": "http://gitlab.example.com/root"
|
||||
},
|
||||
"created_at": "2018-08-19T11:43:01.746Z",
|
||||
"resource_type": "Epic",
|
||||
"resource_id": 33,
|
||||
"label": {
|
||||
"id": 73,
|
||||
"name": "a1",
|
||||
"color": "#34495E",
|
||||
"description": ""
|
||||
},
|
||||
"action": "add"
|
||||
},
|
||||
{
|
||||
"id": 107,
|
||||
"user": {
|
||||
"id": 1,
|
||||
"name": "Administrator",
|
||||
"username": "root",
|
||||
"state": "active",
|
||||
"avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
|
||||
"web_url": "http://gitlab.example.com/root"
|
||||
},
|
||||
"created_at": "2018-08-19T11:43:01.746Z",
|
||||
"resource_type": "Epic",
|
||||
"resource_id": 33,
|
||||
"label": {
|
||||
"id": 37,
|
||||
"name": "glabel2",
|
||||
"color": "#A8D695",
|
||||
"description": ""
|
||||
},
|
||||
"action": "add"
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
```bash
|
||||
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events
|
||||
```
|
||||
|
||||
### Get single epic label event
|
||||
|
||||
Returns a single label event for a specific group epic
|
||||
|
||||
```
|
||||
GET /groups/:id/epics/:epic_id/resource_label_events/:resource_label_event_id
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
| Attribute | Type | Required | Description |
|
||||
| --------------- | -------------- | -------- | ----------- |
|
||||
| `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) |
|
||||
| `epic_id` | integer | yes | The ID of an epic |
|
||||
| `resource_label_event_id` | integer | yes | The ID of a label event |
|
||||
|
||||
```bash
|
||||
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/11/resource_label_events/107
|
||||
```
|
||||
|
||||
## Merge requests
|
||||
|
||||
### List project merge request label events
|
||||
|
|
|
|||
|
|
@ -1101,6 +1101,75 @@ Get JetBrains TeamCity CI service settings for a project.
|
|||
GET /projects/:id/services/teamcity
|
||||
```
|
||||
|
||||
## Jenkins CI **[STARTER]**
|
||||
|
||||
A continuous integration and build server
|
||||
|
||||
### Create/Edit Jenkins CI service
|
||||
|
||||
Set Jenkins CI service for a project.
|
||||
|
||||
```
|
||||
PUT /projects/:id/services/jenkins
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
- `jenkins_url` (**required**) - Jenkins URL like http://jenkins.example.com
|
||||
- `project_name` (**required**) - The URL-friendly project name. Example: my_project_name
|
||||
- `username` (optional) - A user with access to the Jenkins server, if applicable
|
||||
- `password` (optional) - The password of the user
|
||||
|
||||
### Delete Jenkins CI service
|
||||
|
||||
Delete Jenkins CI service for a project.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/services/jenkins
|
||||
```
|
||||
|
||||
### Get Jenkins CI service settings
|
||||
|
||||
Get Jenkins CI service settings for a project.
|
||||
|
||||
```
|
||||
GET /projects/:id/services/jenkins
|
||||
```
|
||||
|
||||
## Jenkins CI (Deprecated) Service
|
||||
|
||||
A continuous integration and build server
|
||||
|
||||
### Create/Edit Jenkins CI (Deprecated) service
|
||||
|
||||
Set Jenkins CI (Deprecated) service for a project.
|
||||
|
||||
```
|
||||
PUT /projects/:id/services/jenkins-deprecated
|
||||
```
|
||||
|
||||
Parameters:
|
||||
|
||||
- `project_url` (**required**) - Jenkins project URL like http://jenkins.example.com/job/my-project/
|
||||
- `multiproject_enabled` (optional) - Multi-project mode is configured in Jenkins GitLab Hook plugin
|
||||
- `pass_unstable` (optional) - Unstable builds will be treated as passing
|
||||
|
||||
### Delete Jenkins CI (Deprecated) service
|
||||
|
||||
Delete Jenkins CI (Deprecated) service for a project.
|
||||
|
||||
```
|
||||
DELETE /projects/:id/services/jenkins-deprecated
|
||||
```
|
||||
|
||||
### Get Jenkins CI (Deprecated) service settings
|
||||
|
||||
Get Jenkins CI (Deprecated) service settings for a project.
|
||||
|
||||
```
|
||||
GET /projects/:id/services/jenkins-deprecated
|
||||
```
|
||||
|
||||
[jira-doc]: ../user/project/integrations/jira.md
|
||||
[old-jira-api]: https://gitlab.com/gitlab-org/gitlab-ce/blob/8-13-stable/doc/api/services.md#jira
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue