diff options
Diffstat (limited to 'doc/api/broadcast_messages.md')
| -rw-r--r-- | doc/api/broadcast_messages.md | 13 |
1 files changed, 4 insertions, 9 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, |