diff options
Diffstat (limited to 'doc/api/graphql')
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 109 | ||||
| -rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 302 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 13 |
3 files changed, 421 insertions, 3 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 91d6717de7e..9cdc83d584c 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -3009,6 +3009,11 @@ input EpicTreeNodeFieldsInputType { id: ID! """ + ID of the new parent epic + """ + newParentId: ID + + """ The type of the switch, after or before allowed """ relativePosition: MoveType! @@ -5335,11 +5340,108 @@ type Metadata { type MetricsDashboard { """ + Annotations added to the dashboard. Will always return `null` if `metrics_dashboard_annotations` feature flag is disabled + """ + annotations( + """ + Returns the elements in the list that come after the specified cursor. + """ + after: String + + """ + Returns the elements in the list that come before the specified cursor. + """ + before: String + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Timestamp marking date and time from which annotations need to be fetched + """ + from: Time! + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Timestamp marking date and time to which annotations need to be fetched + """ + to: Time + ): MetricsDashboardAnnotationConnection + + """ Path to a file with the dashboard definition """ path: String } +type MetricsDashboardAnnotation { + """ + Description of the annotation + """ + description: String + + """ + Timestamp marking end of annotated time span + """ + endingAt: String + + """ + ID of the annotation + """ + id: ID! + + """ + ID of a dashboard panel to which the annotation should be scoped + """ + panelId: String + + """ + Timestamp marking start of annotated time span + """ + startingAt: String +} + +""" +The connection type for MetricsDashboardAnnotation. +""" +type MetricsDashboardAnnotationConnection { + """ + A list of edges. + """ + edges: [MetricsDashboardAnnotationEdge] + + """ + A list of nodes. + """ + nodes: [MetricsDashboardAnnotation] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type MetricsDashboardAnnotationEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: MetricsDashboardAnnotation +} + """ Represents a milestone. """ @@ -6740,7 +6842,7 @@ type Project { suggestionCommitMessage: String """ - List of project tags + List of project topics (not Git tags) """ tagList: String @@ -9561,6 +9663,11 @@ type Vulnerability { location: JSON """ + The project on which the vulnerability was found + """ + project: Project + + """ Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST) """ reportType: VulnerabilityReportType diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index fb642b1222f..26a2acdb4c6 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -8716,6 +8716,16 @@ } }, "defaultValue": null + }, + { + "name": "newParentId", + "description": "ID of the new parent epic", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -15280,6 +15290,83 @@ "description": null, "fields": [ { + "name": "annotations", + "description": "Annotations added to the dashboard. Will always return `null` if `metrics_dashboard_annotations` feature flag is disabled", + "args": [ + { + "name": "from", + "description": "Timestamp marking date and time from which annotations need to be fetched", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "to", + "description": "Timestamp marking date and time to which annotations need to be fetched", + "type": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetricsDashboardAnnotationConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "path", "description": "Path to a file with the dashboard definition", "args": [ @@ -15303,6 +15390,205 @@ }, { "kind": "OBJECT", + "name": "MetricsDashboardAnnotation", + "description": null, + "fields": [ + { + "name": "description", + "description": "Description of the annotation", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endingAt", + "description": "Timestamp marking end of annotated time span", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "ID of the annotation", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "panelId", + "description": "ID of a dashboard panel to which the annotation should be scoped", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startingAt", + "description": "Timestamp marking start of annotated time span", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetricsDashboardAnnotationConnection", + "description": "The connection type for MetricsDashboardAnnotation.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetricsDashboardAnnotationEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetricsDashboardAnnotation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetricsDashboardAnnotationEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "MetricsDashboardAnnotation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "Milestone", "description": "Represents a milestone.", "fields": [ @@ -20096,7 +20382,7 @@ }, { "name": "tagList", - "description": "List of project tags", + "description": "List of project topics (not Git tags)", "args": [ ], @@ -28864,6 +29150,20 @@ "deprecationReason": null }, { + "name": "project", + "description": "The project on which the vulnerability was found", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "Project", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "reportType", "description": "Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST)", "args": [ diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index d1ea825bef3..4d3d77ba35f 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -833,6 +833,16 @@ Autogenerated return type of MergeRequestSetWip | --- | ---- | ---------- | | `path` | String | Path to a file with the dashboard definition | +## MetricsDashboardAnnotation + +| Name | Type | Description | +| --- | ---- | ---------- | +| `description` | String | Description of the annotation | +| `endingAt` | String | Timestamp marking end of annotated time span | +| `id` | ID! | ID of the annotation | +| `panelId` | String | ID of a dashboard panel to which the annotation should be scoped | +| `startingAt` | String | Timestamp marking start of annotated time span | + ## Milestone Represents a milestone. @@ -985,7 +995,7 @@ Information about pagination in a connection. | `starCount` | Int! | Number of times the project has been starred | | `statistics` | ProjectStatistics | Statistics of the project | | `suggestionCommitMessage` | String | The commit message used to apply merge request suggestions | -| `tagList` | String | List of project tags | +| `tagList` | String | List of project topics (not Git tags) | | `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource | | `visibility` | String | Visibility of the project | | `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each severity of vulnerability of the project. Available only when feature flag `first_class_vulnerabilities` is enabled | @@ -1502,6 +1512,7 @@ Represents a vulnerability. | `description` | String | Description of the vulnerability | | `id` | ID! | GraphQL ID of the vulnerability | | `location` | JSON | The JSON location metadata for the vulnerability. Its format depends on the type of the security scan that found the vulnerability | +| `project` | Project | The project on which the vulnerability was found | | `reportType` | VulnerabilityReportType | Type of the security report that found the vulnerability (SAST, DEPENDENCY_SCANNING, CONTAINER_SCANNING, DAST) | | `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) | | `state` | VulnerabilityState | State of the vulnerability (DETECTED, DISMISSED, RESOLVED, CONFIRMED) | |