diff options
Diffstat (limited to 'doc/api/metrics_dashboard_annotations.md')
| -rw-r--r-- | doc/api/metrics_dashboard_annotations.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/metrics_dashboard_annotations.md b/doc/api/metrics_dashboard_annotations.md index 09187a096ef..05bf7156a7e 100644 --- a/doc/api/metrics_dashboard_annotations.md +++ b/doc/api/metrics_dashboard_annotations.md @@ -2,7 +2,7 @@ > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29089) in GitLab 12.10 behind a disabled feature flag. -Metrics dashboard annotations allow you to indicate events on your graphs at a single point in time or over a timespan. +Metrics dashboard annotations allow you to indicate events on your graphs at a single point in time or over a time span. ## Create a new annotation @@ -12,7 +12,7 @@ POST /clusters/:id/metrics_dashboard/annotations/ ``` NOTE: **Note:** -The value of `dashboard_path` will be treated as a CGI-escaped path, and automatically unescaped. +The value of `dashboard_path` will be treated as a CGI-escaped path, and automatically un-escaped. Parameters: @@ -24,7 +24,7 @@ Parameters: | `description` | string | yes | Description of the annotation. | ```shell -curl --header 'Private-Token: <your_access_token>' https://gitlab.example.com/api/v4/environments/1/metrics_dashboard/annotations \ +curl --header "Private-Token: <your_access_token>" "https://gitlab.example.com/api/v4/environments/1/metrics_dashboard/annotations" \ --data-urlencode "dashboard_path=.gitlab/dashboards/custom_metrics.yml" \ --data-urlencode "starting_at=2016-03-11T03:45:40Z" \ --data-urlencode "description=annotation description" |