diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-30 21:08:07 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-30 21:08:07 +0300 |
commit | 2c72daf2f1744f2b8c8c6674c266907e9ef55558 (patch) | |
tree | e489b6e87557d3f6d8a94f2e7d4d47e633d646b5 /doc | |
parent | 4e9acbfba3682c552b3de707c535e6257ef41054 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 46 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 125 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 15 | ||||
-rw-r--r-- | doc/api/notes.md | 12 | ||||
-rw-r--r-- | doc/api/runners.md | 60 | ||||
-rw-r--r-- | doc/user/project/labels.md | 11 |
6 files changed, 262 insertions, 7 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 12da6728d03..3ebdd8d37dd 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -5336,6 +5336,11 @@ type Note { bodyHtml: String """ + Indicates if this note is confidential + """ + confidential: Boolean + + """ Timestamp of the note creation """ createdAt: Time! @@ -6434,6 +6439,12 @@ type Project { ): VulnerabilityConnection """ + Counts for each severity of vulnerability of the project. Available only when + feature flag `first_class_vulnerabilities` is enabled + """ + vulnerabilitySeveritiesCount: VulnerabilitySeveritiesCount + + """ Web URL of the project """ webUrl: String @@ -9111,6 +9122,41 @@ enum VulnerabilityReportType { } """ +Represents vulnerability counts by severity +""" +type VulnerabilitySeveritiesCount { + """ + Number of vulnerabilities of CRITICAL severity of the project + """ + critical: Int + + """ + Number of vulnerabilities of HIGH severity of the project + """ + high: Int + + """ + Number of vulnerabilities of INFO severity of the project + """ + info: Int + + """ + Number of vulnerabilities of LOW severity of the project + """ + low: Int + + """ + Number of vulnerabilities of MEDIUM severity of the project + """ + medium: Int + + """ + Number of vulnerabilities of UNKNOWN severity of the project + """ + unknown: Int +} + +""" The severity of the vulnerability. """ enum VulnerabilitySeverity { diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 13e506fcb6c..735befc3459 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -16150,6 +16150,20 @@ "deprecationReason": null }, { + "name": "confidential", + "description": "Indicates if this note is confidential", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "createdAt", "description": "Timestamp of the note creation", "args": [ @@ -19172,6 +19186,20 @@ "deprecationReason": null }, { + "name": "vulnerabilitySeveritiesCount", + "description": "Counts for each severity of vulnerability of the project. Available only when feature flag `first_class_vulnerabilities` is enabled", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "VulnerabilitySeveritiesCount", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "webUrl", "description": "Web URL of the project", "args": [ @@ -27432,6 +27460,103 @@ "possibleTypes": null }, { + "kind": "OBJECT", + "name": "VulnerabilitySeveritiesCount", + "description": "Represents vulnerability counts by severity", + "fields": [ + { + "name": "critical", + "description": "Number of vulnerabilities of CRITICAL severity of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "high", + "description": "Number of vulnerabilities of HIGH severity of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "info", + "description": "Number of vulnerabilities of INFO severity of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "low", + "description": "Number of vulnerabilities of LOW severity of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "medium", + "description": "Number of vulnerabilities of MEDIUM severity of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unknown", + "description": "Number of vulnerabilities of UNKNOWN severity of the project", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "ENUM", "name": "VulnerabilitySeverity", "description": "The severity of the vulnerability.", diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 6b7c4925238..995cf3a0073 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -810,6 +810,7 @@ Represents a milestone. | `author` | User! | User who wrote this note | | `body` | String! | Content of the note | | `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` | +| `confidential` | Boolean | Indicates if this note is confidential | | `createdAt` | Time! | Timestamp of the note creation | | `discussion` | Discussion | The discussion this note is a part of | | `id` | ID! | ID of the note | @@ -925,6 +926,7 @@ Information about pagination in a connection. | `tagList` | String | List of project tags | | `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource | | `visibility` | String | Visibility of the project | +| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each severity of vulnerability of the project. Available only when feature flag `first_class_vulnerabilities` is enabled | | `webUrl` | String | Web URL of the project | | `wikiEnabled` | Boolean | (deprecated) Does this project have wiki enabled?. Use `wiki_access_level` instead | @@ -1442,3 +1444,16 @@ Represents a vulnerability. | `state` | VulnerabilityState | State of the vulnerability (DETECTED, DISMISSED, RESOLVED, CONFIRMED) | | `title` | String | Title of the vulnerability | | `vulnerabilityPath` | String | URL to the vulnerability's details page | + +## VulnerabilitySeveritiesCount + +Represents vulnerability counts by severity + +| Name | Type | Description | +| --- | ---- | ---------- | +| `critical` | Int | Number of vulnerabilities of CRITICAL severity of the project | +| `high` | Int | Number of vulnerabilities of HIGH severity of the project | +| `info` | Int | Number of vulnerabilities of INFO severity of the project | +| `low` | Int | Number of vulnerabilities of LOW severity of the project | +| `medium` | Int | Number of vulnerabilities of MEDIUM severity of the project | +| `unknown` | Int | Number of vulnerabilities of UNKNOWN severity of the project | diff --git a/doc/api/notes.md b/doc/api/notes.md index f7d7163b7a8..62e1fe44bae 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -54,7 +54,8 @@ GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at "noteable_id": 377, "noteable_type": "Issue", "noteable_iid": 377, - "resolvable": false + "resolvable": false, + "confidential": false }, { "id": 305, @@ -74,7 +75,8 @@ GET /projects/:id/issues/:issue_iid/notes?sort=asc&order_by=updated_at "noteable_id": 121, "noteable_type": "Issue", "noteable_iid": 121, - "resolvable": false + "resolvable": false, + "confidential": true } ] ``` @@ -332,7 +334,8 @@ Parameters: "noteable_id": 2, "noteable_type": "MergeRequest", "noteable_iid": 2, - "resolvable": false + "resolvable": false, + "confidential": false } ``` @@ -449,7 +452,8 @@ Parameters: }, "expires_at": null, "updated_at": "2013-10-02T07:34:20Z", - "created_at": "2013-10-02T07:34:20Z" + "created_at": "2013-10-02T07:34:20Z", + "confidential": false } ``` diff --git a/doc/api/runners.md b/doc/api/runners.md index 551a7580e54..fa4631c1bd2 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -471,6 +471,66 @@ DELETE /projects/:id/runners/:runner_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/9/runners/9" ``` +## List group's runners + +List all runners (specific and shared) available in the group as well it's ancestor groups. +Shared runners are listed if at least one shared runner is defined. + +```plaintext +GET /groups/:id/runners +GET /groups/:id/runners?type=group_type +GET /groups/:id/runners?status=active +GET /groups/:id/runners?tag_list=tag1,tag2 +``` + +| Attribute | Type | Required | Description | +|------------|----------------|----------|---------------------| +| `id` | integer | yes | The ID of the group owned by the authenticated user | +| `type` | string | no | The type of runners to show, one of: `instance_type`, `group_type`, `project_type` | +| `status` | string | no | The status of runners to show, one of: `active`, `paused`, `online`, `offline` | +| `tag_list` | string array | no | List of of the runner's tags | + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/9/runners" +``` + +Example response: + +```json +[ + { + "id": 3, + "description": "Shared", + "ip_address": "127.0.0.1", + "active": true, + "is_shared": true, + "name": "gitlab-runner", + "online": null, + "status": "not_connected" + }, + { + "id": 6, + "description": "Test", + "ip_address": "127.0.0.1", + "active": true, + "is_shared": true, + "name": "gitlab-runner", + "online": false, + "status": "offline" + }, + { + "id": 8, + "description": "Test 2", + "ip_address": "127.0.0.1", + "active": true, + "is_shared": false, + "name": "gitlab-runner", + "online": null, + "status": "not_connected" + } +] +``` + ## Register a new Runner Register a new Runner for the instance. diff --git a/doc/user/project/labels.md b/doc/user/project/labels.md index a6ef5f5cfcc..9cf50d3aaed 100644 --- a/doc/user/project/labels.md +++ b/doc/user/project/labels.md @@ -74,9 +74,14 @@ and selecting **Delete**. #### Promote a project label to a group label If you previously created a project label and now want to make it available for other -projects within the same group, you can promote it to a group label. If other projects -in the same group have a label with the same name, they will all be overwritten by -the new group label. +projects within the same group, you can promote it to a group label. + +If other projects in the same group have a label with the same title, they will all be +merged with the new group label. If a group label with the same title exists, it will +also be merged. + +All issues, merge requests, issue board lists, issue board filters, and label subscriptions +with the old labels will be assigned to the new group label. WARNING: **Caution:** Promoting a label is a permanent action, and cannot be reversed. |