Commit 2dfa26d9 authored by lauraMon's avatar lauraMon

Adds graphql docs, etc

* Adds docs and schema
* Adds changelog
* Fixes tiny typo
parent 95befdc4
...@@ -57,7 +57,7 @@ module Types ...@@ -57,7 +57,7 @@ module Types
method: :cancelable?, method: :cancelable?,
null: false null: false
field :destroyable, GraphQL::BOOLEAN_TYPE, field :destroyable, GraphQL::BOOLEAN_TYPE,
description: 'Specifies if a pipeline cann be destroyed', description: 'Specifies if a pipeline can be destroyed',
null: false, null: false,
resolve: -> (pipeline, _args, context) { Ability.allowed?(context[:current_user], :destroy_pipeline, pipeline) } resolve: -> (pipeline, _args, context) { Ability.allowed?(context[:current_user], :destroy_pipeline, pipeline) }
end end
......
---
title: 'GraphQL: Add retryable, cancelable, and destroyable to PipelineType'
merge_request: 40780
author:
type: added
...@@ -10697,6 +10697,11 @@ type Pipeline { ...@@ -10697,6 +10697,11 @@ type Pipeline {
""" """
beforeSha: String beforeSha: String
"""
Specifies if a pipeline is cancelable
"""
cancelable: Boolean!
""" """
Timestamp of the pipeline's commit Timestamp of the pipeline's commit
""" """
...@@ -10719,6 +10724,11 @@ type Pipeline { ...@@ -10719,6 +10724,11 @@ type Pipeline {
""" """
createdAt: Time! createdAt: Time!
"""
Specifies if a pipeline can be destroyed
"""
destroyable: Boolean!
""" """
Detailed status of the pipeline Detailed status of the pipeline
""" """
...@@ -10744,6 +10754,11 @@ type Pipeline { ...@@ -10744,6 +10754,11 @@ type Pipeline {
""" """
iid: String! iid: String!
"""
Specifies if a pipeline is retryable
"""
retryable: Boolean!
""" """
Vulnerability and scanned resource counts for each security scanner of the pipeline Vulnerability and scanned resource counts for each security scanner of the pipeline
""" """
......
...@@ -32015,6 +32015,24 @@ ...@@ -32015,6 +32015,24 @@
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{
"name": "cancelable",
"description": "Specifies if a pipeline is cancelable",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{ {
"name": "committedAt", "name": "committedAt",
"description": "Timestamp of the pipeline's commit", "description": "Timestamp of the pipeline's commit",
...@@ -32075,6 +32093,24 @@ ...@@ -32075,6 +32093,24 @@
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{
"name": "destroyable",
"description": "Specifies if a pipeline can be destroyed",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{ {
"name": "detailedStatus", "name": "detailedStatus",
"description": "Detailed status of the pipeline", "description": "Detailed status of the pipeline",
...@@ -32157,6 +32193,24 @@ ...@@ -32157,6 +32193,24 @@
"isDeprecated": false, "isDeprecated": false,
"deprecationReason": null "deprecationReason": null
}, },
{
"name": "retryable",
"description": "Specifies if a pipeline is retryable",
"args": [
],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "Boolean",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
},
{ {
"name": "securityReportSummary", "name": "securityReportSummary",
"description": "Vulnerability and scanned resource counts for each security scanner of the pipeline", "description": "Vulnerability and scanned resource counts for each security scanner of the pipeline",
...@@ -1650,15 +1650,18 @@ Information about pagination in a connection. ...@@ -1650,15 +1650,18 @@ Information about pagination in a connection.
| Name | Type | Description | | Name | Type | Description |
| --- | ---- | ---------- | | --- | ---- | ---------- |
| `beforeSha` | String | Base SHA of the source branch | | `beforeSha` | String | Base SHA of the source branch |
| `cancelable` | Boolean! | Specifies if a pipeline is cancelable |
| `committedAt` | Time | Timestamp of the pipeline's commit | | `committedAt` | Time | Timestamp of the pipeline's commit |
| `configSource` | PipelineConfigSourceEnum | Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) | | `configSource` | PipelineConfigSourceEnum | Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE) |
| `coverage` | Float | Coverage percentage | | `coverage` | Float | Coverage percentage |
| `createdAt` | Time! | Timestamp of the pipeline's creation | | `createdAt` | Time! | Timestamp of the pipeline's creation |
| `destroyable` | Boolean! | Specifies if a pipeline can be destroyed |
| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline | | `detailedStatus` | DetailedStatus! | Detailed status of the pipeline |
| `duration` | Int | Duration of the pipeline in seconds | | `duration` | Int | Duration of the pipeline in seconds |
| `finishedAt` | Time | Timestamp of the pipeline's completion | | `finishedAt` | Time | Timestamp of the pipeline's completion |
| `id` | ID! | ID of the pipeline | | `id` | ID! | ID of the pipeline |
| `iid` | String! | Internal ID of the pipeline | | `iid` | String! | Internal ID of the pipeline |
| `retryable` | Boolean! | Specifies if a pipeline is retryable |
| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline | | `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline |
| `sha` | String! | SHA of the pipeline's commit | | `sha` | String! | SHA of the pipeline's commit |
| `startedAt` | Time | Timestamp when the pipeline was started | | `startedAt` | Time | Timestamp when the pipeline was started |
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment