diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 75 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 192 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 13 |
3 files changed, 280 insertions, 0 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index f698db84982..898ad11f450 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1878,6 +1878,11 @@ type Epic implements Noteable { hasIssues: Boolean! """ + Current health status. Available only when feature flag save_issuable_health_status is enabled. + """ + healthStatus: HealthStatus + + """ ID of the epic """ id: ID! @@ -2253,6 +2258,11 @@ type EpicIssue implements Noteable { epicIssueId: ID! """ + Current health status. Available only when feature flag save_issuable_health_status is enabled. + """ + healthStatus: HealthStatus + + """ Global ID of the epic-issue relation """ id: ID @@ -3060,6 +3070,15 @@ type GroupPermissions { } """ +Health status of an issue or epic +""" +enum HealthStatus { + atRisk + needsAttention + onTrack +} + +""" State of a GitLab issue or merge request """ enum IssuableState { @@ -3180,6 +3199,11 @@ type Issue implements Noteable { epic: Epic """ + Current health status. Available only when feature flag save_issuable_health_status is enabled. + """ + healthStatus: HealthStatus + + """ Internal ID of the issue """ iid: ID! @@ -4667,6 +4691,7 @@ type Mutation { be destroyed during the update, and no Note will be returned """ updateImageDiffNote(input: UpdateImageDiffNoteInput!): UpdateImageDiffNotePayload + updateIssue(input: UpdateIssueInput!): UpdateIssuePayload """ Updates a Note. If the body of the Note contains only quick actions, the Note @@ -7602,6 +7627,11 @@ input UpdateEpicInput { groupPath: ID! """ + The desired health status + """ + healthStatus: HealthStatus + + """ The iid of the epic to mutate """ iid: String! @@ -7698,6 +7728,51 @@ type UpdateImageDiffNotePayload { } """ +Autogenerated input type of UpdateIssue +""" +input UpdateIssueInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The desired health status + """ + healthStatus: HealthStatus + + """ + The iid of the issue to mutate + """ + iid: String! + + """ + The project the issue to mutate is in + """ + projectPath: ID! +} + +""" +Autogenerated return type of UpdateIssue +""" +type UpdateIssuePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Reasons why the mutation failed. + """ + errors: [String!]! + + """ + The issue after mutation + """ + issue: Issue +} + +""" Autogenerated input type of UpdateNote """ input UpdateNoteInput { diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 38a836acb6b..41872ffa9c2 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -11163,6 +11163,35 @@ "possibleTypes": null }, { + "kind": "ENUM", + "name": "HealthStatus", + "description": "Health status of an issue or epic", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "onTrack", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "needsAttention", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "atRisk", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { "kind": "OBJECT", "name": "DesignConnection", "description": "The connection type for Design.", @@ -19454,6 +19483,33 @@ "deprecationReason": null }, { + "name": "updateIssue", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateIssueInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UpdateIssuePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "updateNote", "description": "Updates a Note. If the body of the Note contains only quick actions, the Note will be destroyed during the update, and no Note will be returned", "args": [ @@ -20264,6 +20320,132 @@ }, { "kind": "OBJECT", + "name": "UpdateIssuePayload", + "description": "Autogenerated return type of UpdateIssue", + "fields": [ + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Reasons why the mutation failed.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "issue", + "description": "The issue after mutation", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "Issue", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateIssueInput", + "description": "Autogenerated input type of UpdateIssue", + "fields": null, + "inputFields": [ + { + "name": "projectPath", + "description": "The project the issue to mutate is in", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "iid", + "description": "The iid of the issue to mutate", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "healthStatus", + "description": "The desired health status", + "type": { + "kind": "ENUM", + "name": "HealthStatus", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "clientMutationId", + "description": "A unique identifier for the client performing the mutation.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "MergeRequestSetLabelsPayload", "description": "Autogenerated return type of MergeRequestSetLabels", "fields": [ @@ -23907,6 +24089,16 @@ "defaultValue": null }, { + "name": "healthStatus", + "description": "The desired health status", + "type": { + "kind": "ENUM", + "name": "HealthStatus", + "ofType": null + }, + "defaultValue": null + }, + { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "type": { diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index c1a5882eb25..19d145a664f 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -293,6 +293,7 @@ Represents an epic. | `group` | Group! | Group to which the epic belongs | | `hasChildren` | Boolean! | Indicates if the epic has children | | `hasIssues` | Boolean! | Indicates if the epic has direct issues | +| `healthStatus` | HealthStatus | Current health status. Available only when feature flag save_issuable_health_status is enabled. | | `id` | ID! | ID of the epic | | `iid` | ID! | Internal ID of the epic | | `parent` | Epic | Parent epic of the epic | @@ -342,6 +343,7 @@ Relationship between an epic and an issue | `dueDate` | Time | Due date of the issue | | `epic` | Epic | Epic to which this issue belongs | | `epicIssueId` | ID! | ID of the epic-issue relation | +| `healthStatus` | HealthStatus | Current health status. Available only when feature flag save_issuable_health_status is enabled. | | `id` | ID | Global ID of the epic-issue relation | | `iid` | ID! | Internal ID of the issue | | `milestone` | Milestone | Milestone of the issue | @@ -461,6 +463,7 @@ Autogenerated return type of EpicTreeReorder | `downvotes` | Int! | Number of downvotes the issue has received | | `dueDate` | Time | Due date of the issue | | `epic` | Epic | Epic to which this issue belongs | +| `healthStatus` | HealthStatus | Current health status. Available only when feature flag save_issuable_health_status is enabled. | | `iid` | ID! | Internal ID of the issue | | `milestone` | Milestone | Milestone of the issue | | `reference` | String! | Internal reference of the issue. Returned in shortened format by default | @@ -1240,6 +1243,16 @@ Autogenerated return type of UpdateImageDiffNote | `errors` | String! => Array | Reasons why the mutation failed. | | `note` | Note | The note after mutation | +## UpdateIssuePayload + +Autogenerated return type of UpdateIssue + +| Name | Type | Description | +| --- | ---- | ---------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Reasons why the mutation failed. | +| `issue` | Issue | The issue after mutation | + ## UpdateNotePayload Autogenerated return type of UpdateNote |