diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-13 12:09:51 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-13 12:09:51 +0300 |
commit | e79918ce90dc31527be1ef0140a99cfe450d931e (patch) | |
tree | ea700e26de7809e58b7cff6bc58d8b8d89f29201 /doc | |
parent | 01ff651394ec2df7df5ed0282c96fb8133980cb9 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/pipelines.md | 2 | ||||
-rw-r--r-- | doc/api/vulnerability_issue_links.md | 217 |
2 files changed, 1 insertions, 218 deletions
diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 490f1304130..5b67df14ace 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -12,7 +12,7 @@ GET /projects/:id/pipelines |-----------|---------|----------|---------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `scope` | string | no | The scope of pipelines, one of: `running`, `pending`, `finished`, `branches`, `tags` | -| `status` | string | no | The status of pipelines, one of: `running`, `pending`, `success`, `failed`, `canceled`, `skipped`, `created` | +| `status` | string | no | The status of pipelines, one of: `running`, `pending`, `success`, `failed`, `canceled`, `skipped`, `created`, `manual` | | `ref` | string | no | The ref of pipelines | | `sha` | string | no | The SHA of pipelines | | `yaml_errors`| boolean | no | Returns pipelines with invalid configurations | diff --git a/doc/api/vulnerability_issue_links.md b/doc/api/vulnerability_issue_links.md deleted file mode 100644 index 05213e788c4..00000000000 --- a/doc/api/vulnerability_issue_links.md +++ /dev/null @@ -1,217 +0,0 @@ -# Vulnerability Issue links API **(ULTIMATE)** - -CAUTION: **Caution:** -This API is in an alpha stage and considered unstable. -The response payload may be subject to change or breakage -across GitLab releases. - -## List related issues - -Get a list of related issues of a given issue, sorted by the relationship creation datetime (ascending). -Issues will be filtered according to the user authorizations. - -```plaintext -GET /projects/:id/issues/:issue_iid/links -``` - -Parameters: - -| Attribute | Type | Required | Description | -|-------------|---------|----------|--------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `issue_iid` | integer | yes | The internal ID of a project's issue | - -```json -[ - { - "id" : 84, - "iid" : 14, - "issue_link_id": 1 - "project_id" : 4, - "created_at" : "2016-01-07T12:44:33.959Z", - "title" : "Issues with auth", - "state" : "opened", - "assignees" : [], - "assignee" : null, - "labels" : [ - "bug" - ], - "author" : { - "name" : "Alexandra Bashirian", - "avatar_url" : null, - "state" : "active", - "web_url" : "https://gitlab.example.com/eileen.lowe", - "id" : 18, - "username" : "eileen.lowe" - }, - "description" : null, - "updated_at" : "2016-01-07T12:44:33.959Z", - "milestone" : null, - "subscribed" : true, - "user_notes_count": 0, - "due_date": null, - "web_url": "http://example.com/example/example/issues/14", - "confidential": false, - "weight": null, - } -] -``` - -## Create an issue link - -Creates a two-way relation between two issues. User must be allowed to update both issues in order to succeed. - -```plaintext -POST /projects/:id/issues/:issue_iid/links -``` - -| Attribute | Type | Required | Description | -|-------------|---------|----------|--------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `issue_iid` | integer | yes | The internal ID of a project's issue | -| `target_project_id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) of a target project | -| `target_issue_iid` | integer or string | yes | The internal ID of a target project's issue | - -```json -{ - "source_issue" : { - "id" : 83, - "iid" : 11, - "project_id" : 4, - "created_at" : "2016-01-07T12:44:33.959Z", - "title" : "Issues with auth", - "state" : "opened", - "assignees" : [], - "assignee" : null, - "labels" : [ - "bug" - ], - "author" : { - "name" : "Alexandra Bashirian", - "avatar_url" : null, - "state" : "active", - "web_url" : "https://gitlab.example.com/eileen.lowe", - "id" : 18, - "username" : "eileen.lowe" - }, - "description" : null, - "updated_at" : "2016-01-07T12:44:33.959Z", - "milestone" : null, - "subscribed" : true, - "user_notes_count": 0, - "due_date": null, - "web_url": "http://example.com/example/example/issues/11", - "confidential": false, - "weight": null, - }, - "target_issue" : { - "id" : 84, - "iid" : 14, - "project_id" : 4, - "created_at" : "2016-01-07T12:44:33.959Z", - "title" : "Issues with auth", - "state" : "opened", - "assignees" : [], - "assignee" : null, - "labels" : [ - "bug" - ], - "author" : { - "name" : "Alexandra Bashirian", - "avatar_url" : null, - "state" : "active", - "web_url" : "https://gitlab.example.com/eileen.lowe", - "id" : 18, - "username" : "eileen.lowe" - }, - "description" : null, - "updated_at" : "2016-01-07T12:44:33.959Z", - "milestone" : null, - "subscribed" : true, - "user_notes_count": 0, - "due_date": null, - "web_url": "http://example.com/example/example/issues/14", - "confidential": false, - "weight": null, - } -} -``` - -## Delete an issue link - -Deletes an issue link, removing the two-way relationship. - -```plaintext -DELETE /projects/:id/issues/:issue_iid/links/:issue_link_id -``` - -| Attribute | Type | Required | Description | -|-------------|---------|----------|--------------------------------------| -| `id` | integer or string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `issue_iid` | integer | yes | The internal ID of a project's issue | -| `issue_link_id` | integer or string | yes | The ID of an issue relationship | - -```json -{ - "source_issue" : { - "id" : 83, - "iid" : 11, - "project_id" : 4, - "created_at" : "2016-01-07T12:44:33.959Z", - "title" : "Issues with auth", - "state" : "opened", - "assignees" : [], - "assignee" : null, - "labels" : [ - "bug" - ], - "author" : { - "name" : "Alexandra Bashirian", - "avatar_url" : null, - "state" : "active", - "web_url" : "https://gitlab.example.com/eileen.lowe", - "id" : 18, - "username" : "eileen.lowe" - }, - "description" : null, - "updated_at" : "2016-01-07T12:44:33.959Z", - "milestone" : null, - "subscribed" : true, - "user_notes_count": 0, - "due_date": null, - "web_url": "http://example.com/example/example/issues/11", - "confidential": false, - "weight": null, - }, - "target_issue" : { - "id" : 84, - "iid" : 14, - "project_id" : 4, - "created_at" : "2016-01-07T12:44:33.959Z", - "title" : "Issues with auth", - "state" : "opened", - "assignees" : [], - "assignee" : null, - "labels" : [ - "bug" - ], - "author" : { - "name" : "Alexandra Bashirian", - "avatar_url" : null, - "state" : "active", - "web_url" : "https://gitlab.example.com/eileen.lowe", - "id" : 18, - "username" : "eileen.lowe" - }, - "description" : null, - "updated_at" : "2016-01-07T12:44:33.959Z", - "milestone" : null, - "subscribed" : true, - "user_notes_count": 0, - "due_date": null, - "web_url": "http://example.com/example/example/issues/14", - "confidential": false, - "weight": null, - } -} -``` |