diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-11 09:09:30 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-11-11 09:09:30 +0300 |
commit | 75ef798ebc8e6bf6960dc2540ea6c3a42c5312c8 (patch) | |
tree | 2906854b44211d46f437ee01c06b0ed784b56695 /doc | |
parent | 48b4860d60e8d3c634c91dea473a86081d9b4727 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/broadcast_messages.md | 13 | ||||
-rw-r--r-- | doc/api/features.md | 25 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 12 |
3 files changed, 29 insertions, 21 deletions
diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index cc777a8bf53..d91557523a9 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -6,7 +6,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Broadcast Messages API **(FREE SELF)** -> `target_access_levels` [introduced](https://gitlab.com/gitlab-org/growth/team-tasks/-/issues/461) in GitLab 14.8 [with a flag](../administration/feature_flags.md) named `role_targeted_broadcast_messages`. Disabled by default. +- > `target_access_levels` [introduced](https://gitlab.com/gitlab-org/growth/team-tasks/-/issues/461) in GitLab 14.8 [with a flag](../administration/feature_flags.md) named `role_targeted_broadcast_messages`. Disabled by default. +- > `color` parameter [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/95829) in GitLab 15.6. Broadcast messages API operates on [broadcast messages](../user/admin_area/broadcast_messages.md). @@ -37,7 +38,6 @@ Example response: "message":"Example broadcast message", "starts_at":"2016-08-24T23:21:16.078Z", "ends_at":"2016-08-26T23:21:16.080Z", - "color":"#E75E40", "font":"#FFFFFF", "id":1, "active": false, @@ -76,7 +76,6 @@ Example response: "message":"Deploy in progress", "starts_at":"2016-08-24T23:21:16.078Z", "ends_at":"2016-08-26T23:21:16.080Z", - "color":"#cecece", "font":"#FFFFFF", "id":1, "active":false, @@ -102,7 +101,6 @@ Parameters: | `message` | string | yes | Message to display. | | `starts_at` | datetime | no | Starting time (defaults to current time in UTC). Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `ends_at` | datetime | no | Ending time (defaults to one hour from current time in UTC). Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `color` | string | no | Background color hex code. | | `font` | string | no | Foreground color hex code. | | `target_access_levels` | array of integers | no | Target access levels (roles) of the broadcast message.| | `target_path` | string | no | Target path of the broadcast message. | @@ -121,7 +119,7 @@ following levels are valid: Example request: ```shell -curl --data "message=Deploy in progress&color=#cecece&target_access_levels[]=10&target_access_levels[]=30" \ +curl --data "message=Deploy in progress&target_access_levels[]=10&target_access_levels[]=30" \ --header "PRIVATE-TOKEN: <your_access_token>" \ "https://gitlab.example.com/api/v4/broadcast_messages" ``` @@ -133,7 +131,6 @@ Example response: "message":"Deploy in progress", "starts_at":"2016-08-26T00:41:35.060Z", "ends_at":"2016-08-26T01:41:35.060Z", - "color":"#cecece", "font":"#FFFFFF", "id":1, "active": true, @@ -160,7 +157,6 @@ Parameters: | `message` | string | no | Message to display. | | `starts_at` | datetime | no | Starting time (UTC). Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `ends_at` | datetime | no | Ending time (UTC). Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `color` | string | no | Background color hex code. | | `font` | string | no | Foreground color hex code. | | `target_access_levels` | array of integers | no | Target access levels (roles) of the broadcast message.| | `target_path` | string | no | Target path of the broadcast message. | @@ -179,7 +175,7 @@ following levels are valid: Example request: ```shell -curl --request PUT --data "message=Update message&color=#000" \ +curl --request PUT --data "message=Update message" \ --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/broadcast_messages/1" ``` @@ -190,7 +186,6 @@ Example response: "message":"Update message", "starts_at":"2016-08-26T00:41:35.060Z", "ends_at":"2016-08-26T01:41:35.060Z", - "color":"#000", "font":"#FFFFFF", "id":1, "active": true, diff --git a/doc/api/features.md b/doc/api/features.md index 6f3af683020..819405bea77 100644 --- a/doc/api/features.md +++ b/doc/api/features.md @@ -111,20 +111,21 @@ percentage of time. POST /features/:name ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `name` | string | yes | Name of the feature to create or update | -| `value` | integer/string | yes | `true` or `false` to enable/disable, or an integer for percentage of time | -| `key` | string | no | `percentage_of_actors` or `percentage_of_time` (default) | -| `feature_group` | string | no | A Feature group name | -| `user` | string | no | A GitLab username or comma-separated multiple usernames | -| `group` | string | no | A GitLab group's path, for example `gitlab-org`, or comma-separated multiple group paths | -| `namespace` | string | no | A GitLab group or user namespace's path, for example `john-doe`, or comma-separated multiple namespace paths. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/353117) in GitLab 15.0. | -| `project` | string | no | A projects path, for example `gitlab-org/gitlab-foss`, or comma-separated multiple project paths | -| `force` | boolean | no | Skip feature flag validation checks, such as a YAML definition | +| Attribute | Type | Required | Description | +|-----------------|----------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `name` | string | yes | Name of the feature to create or update | +| `value` | integer/string | yes | `true` or `false` to enable/disable, or an integer for percentage of time | +| `key` | string | no | `percentage_of_actors` or `percentage_of_time` (default) | +| `feature_group` | string | no | A Feature group name | +| `user` | string | no | A GitLab username or comma-separated multiple usernames | +| `group` | string | no | A GitLab group's path, for example `gitlab-org`, or comma-separated multiple group paths | +| `namespace` | string | no | A GitLab group or user namespace's path, for example `john-doe`, or comma-separated multiple namespace paths. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/353117) in GitLab 15.0. | +| `project` | string | no | A projects path, for example `gitlab-org/gitlab-foss`, or comma-separated multiple project paths | +| `repository` | string | no | A repository path, for example `gitlab-org/gitlab-test.git`, `gitlab-org/gitlab-test.wiki.git`, , `snippets/21.git`, to name a few. Use comma to separate multiple repository paths | +| `force` | boolean | no | Skip feature flag validation checks, such as a YAML definition | You can enable or disable a feature for a `feature_group`, a `user`, -a `group`, a `namespace` and a `project` in a single API call. +a `group`, a `namespace`, a `project`, and a `repository` in a single API call. ```shell curl --data "value=30" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/features/new_library" diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 94b9d63bdbb..d1f71ccb988 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -16348,6 +16348,18 @@ four standard [pagination arguments](#connection-pagination-arguments): | <a id="pipelinejobssecurityreporttypes"></a>`securityReportTypes` | [`[SecurityReportTypeEnum!]`](#securityreporttypeenum) | Filter jobs by the type of security report they produce. | | <a id="pipelinejobsstatuses"></a>`statuses` | [`[CiJobStatus!]`](#cijobstatus) | Filter jobs by status. | +##### `Pipeline.securityReportFinding` + +Vulnerability finding reported on the pipeline. + +Returns [`PipelineSecurityReportFinding`](#pipelinesecurityreportfinding). + +###### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="pipelinesecurityreportfindinguuid"></a>`uuid` | [`String!`](#string) | UUID of the security report finding. | + ##### `Pipeline.securityReportFindings` Vulnerability findings reported on the pipeline. |