diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-10 18:09:32 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-10 18:09:32 +0000 |
commit | ed5add1c2f001c9bd54e664b32f212de172eca6a (patch) | |
tree | f9449cbecde36706f25a62f426b5398566ae5cca /doc/api | |
parent | de2fb5b82c92c90f90ed67ced45143c04e934fb8 (diff) | |
download | gitlab-ce-ed5add1c2f001c9bd54e664b32f212de172eca6a.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 17 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 54 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 7 |
3 files changed, 78 insertions, 0 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index e79d52d4d10..22ca25e45d3 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1883,6 +1883,16 @@ type Environment { id: ID! """ + Metrics dashboard schema for the environment + """ + metricsDashboard( + """ + Path to a file which defines metrics dashboard eg: 'config/prometheus/common_metrics.yml' + """ + path: String! + ): MetricsDashboard + + """ Human-readable name of the environment """ name: String! @@ -5278,6 +5288,13 @@ type Metadata { version: String! } +type MetricsDashboard { + """ + Path to a file with the dashboard definition + """ + path: String +} + """ Represents a milestone. """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 820f41755d0..40bd27062b3 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -5581,6 +5581,33 @@ "deprecationReason": null }, { + "name": "metricsDashboard", + "description": "Metrics dashboard schema for the environment", + "args": [ + { + "name": "path", + "description": "Path to a file which defines metrics dashboard eg: 'config/prometheus/common_metrics.yml'", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetricsDashboard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "name", "description": "Human-readable name of the environment", "args": [ @@ -15119,6 +15146,33 @@ }, { "kind": "OBJECT", + "name": "MetricsDashboard", + "description": null, + "fields": [ + { + "name": "path", + "description": "Path to a file with the dashboard definition", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "Milestone", "description": "Represents a milestone.", "fields": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 6ed3c5a778e..e1375530bf4 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -324,6 +324,7 @@ Describes where code is deployed for a project | Name | Type | Description | | --- | ---- | ---------- | | `id` | ID! | ID of the environment | +| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment | | `name` | String! | Human-readable name of the environment | | `state` | String! | State of the environment, for example: available/stopped | @@ -815,6 +816,12 @@ Autogenerated return type of MergeRequestSetWip | `revision` | String! | Revision | | `version` | String! | Version | +## MetricsDashboard + +| Name | Type | Description | +| --- | ---- | ---------- | +| `path` | String | Path to a file with the dashboard definition | + ## Milestone Represents a milestone. |