diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-10-09 03:08:41 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-10-09 03:08:41 +0300 |
| commit | c02e2a5ef6b928da420e844b54fc6bbce16754c8 (patch) | |
| tree | 1f738c4c0c7fc04a3235e8bad807972a740611f2 /doc/api/metrics_dashboard_annotations.md | |
| parent | b0980f5557a8621fb08785b06be950ee46796c18 (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api/metrics_dashboard_annotations.md')
| -rw-r--r-- | doc/api/metrics_dashboard_annotations.md | 5 |
1 files changed, 1 insertions, 4 deletions
diff --git a/doc/api/metrics_dashboard_annotations.md b/doc/api/metrics_dashboard_annotations.md index 10dfd3d1c3b..b9d68685c44 100644 --- a/doc/api/metrics_dashboard_annotations.md +++ b/doc/api/metrics_dashboard_annotations.md @@ -18,14 +18,11 @@ POST /environments/:id/metrics_dashboard/annotations/ POST /clusters/:id/metrics_dashboard/annotations/ ``` -NOTE: **Note:** -The value of `dashboard_path` will be treated as a CGI-escaped path, and automatically un-escaped. - Parameters: | Attribute | Type | Required | Description | |:---------------|:---------------|:---------|:-----------------------------------------------------------------------------| -| `dashboard_path` | string | yes | ID of the dashboard which needs to be annotated. | +| `dashboard_path` | string | yes | ID of the dashboard which needs to be annotated. Treated as a CGI-escaped path, and automatically un-escaped. | | `starting_at` | string | yes | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Timestamp marking start point of annotation. | | `ending_at` | string | no | Date time string, ISO 8601 formatted, such as `2016-03-11T03:45:40Z`. Timestamp marking end point of annotation. When not supplied annotation will be displayed as single event at start point. | | `description` | string | yes | Description of the annotation. | |