diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-31 00:08:47 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-01-31 00:08:47 +0300 |
commit | c8f773a8593926f4f2dec6f446a3b3e59e9c9909 (patch) | |
tree | 4e5ea1d3b861ff99015f6112da567de7873868aa /doc/api | |
parent | 929b887e5391dea7cb53b88b77b9a35351c87d99 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/broadcast_messages.md | 16 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 4 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 6 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 2 |
4 files changed, 18 insertions, 10 deletions
diff --git a/doc/api/broadcast_messages.md b/doc/api/broadcast_messages.md index 9a15e3ab89d..b9f9621e1f9 100644 --- a/doc/api/broadcast_messages.md +++ b/doc/api/broadcast_messages.md @@ -35,7 +35,8 @@ Example response: "font":"#FFFFFF", "id":1, "active": false, - "target_path": "*/welcome" + "target_path": "*/welcome", + "broadcast_type": "banner" } ] ``` @@ -71,7 +72,8 @@ Example response: "font":"#FFFFFF", "id":1, "active":false, - "target_path": "*/welcome" + "target_path": "*/welcome", + "broadcast_type": "banner" } ``` @@ -92,6 +94,8 @@ Parameters: | `ends_at` | datetime | no | Ending time (defaults to one hour from current time). | | `color` | string | no | Background color hex code. | | `font` | string | no | Foreground color hex code. | +| `target_path`| string | no | Target path of the broadcast message. | +| `broadcast_type`| string | no | Appearance type (defaults to banner) | Example request: @@ -110,7 +114,8 @@ Example response: "font":"#FFFFFF", "id":1, "active": true, - "target_path": "*/welcome" + "target_path": "*/welcome", + "broadcast_type": "notification", } ``` @@ -132,6 +137,8 @@ Parameters: | `ends_at` | datetime | no | Ending time. | | `color` | string | no | Background color hex code. | | `font` | string | no | Foreground color hex code. | +| `target_path`| string | no | Target path of the broadcast message. | +| `broadcast_type`| string | no | Appearance type (defaults to banner) | Example request: @@ -150,7 +157,8 @@ Example response: "font":"#FFFFFF", "id":1, "active": true, - "target_path": "*/welcome" + "target_path": "*/welcome", + "broadcast_type": "notification", } ``` diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 3cb0690abc8..8fc13dd140b 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -2658,9 +2658,9 @@ type GrafanaIntegration { id: ID! """ - API token for the Grafana integration + API token for the Grafana integration. Field is permanently masked. """ - token: String! + token: String! @deprecated(reason: "Plain text token has been masked for security reasons") """ Timestamp of the issue's last activity diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 8e94d4b33d3..f9eda31540a 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -17380,7 +17380,7 @@ }, { "name": "token", - "description": "API token for the Grafana integration", + "description": "API token for the Grafana integration. Field is permanently masked.", "args": [ ], @@ -17393,8 +17393,8 @@ "ofType": null } }, - "isDeprecated": false, - "deprecationReason": null + "isDeprecated": true, + "deprecationReason": "Plain text token has been masked for security reasons" }, { "name": "updatedAt", diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index dc6517f7ea4..9ed47f2aea2 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -403,7 +403,7 @@ Autogenerated return type of EpicTreeReorder | `enabled` | Boolean! | Indicates whether Grafana integration is enabled | | `grafanaUrl` | String! | Url for the Grafana host for the Grafana integration | | `id` | ID! | Internal ID of the Grafana integration | -| `token` | String! | API token for the Grafana integration | +| `token` | String! | API token for the Grafana integration. Field is permanently masked. | | `updatedAt` | Time! | Timestamp of the issue's last activity | ## Group |