diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.graphql | 21 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 23 | ||||
-rw-r--r-- | doc/api/notification_settings.md | 4 |
3 files changed, 43 insertions, 5 deletions
diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 5cf48ab901d..6b62b11750c 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -1863,6 +1863,12 @@ type Epic implements Noteable { descendantCounts: EpicDescendantCount """ + Total weight of open and closed descendant epic's issues. Available only when + feature flag unfiltered_epic_aggregates is enabled. + """ + descendantWeightSum: EpicDescendantWeights + + """ Description of the epic """ description: String @@ -2179,6 +2185,21 @@ type EpicDescendantCount { } """ +Total weight of open and closed descendant issues +""" +type EpicDescendantWeights { + """ + Total weight of completed (closed) issues in this epic, including epic descendants + """ + closedIssues: Int + + """ + Total weight of opened issues in this epic, including epic descendants + """ + openedIssues: Int +} + +""" An edge in a connection. """ type EpicEdge { diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 978fbc35125..1a9be3f496b 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -13,6 +13,9 @@ The API can be explored interactively using the [GraphiQL IDE](../index.md#graph Each table below documents a GraphQL type. Types match loosely to models, but not all fields and methods on a model are available via GraphQL. +CAUTION: **Caution:** +Fields that are deprecated are marked with **{warning-solid}**. + ## AddAwardEmojiPayload Autogenerated return type of AddAwardEmoji @@ -69,7 +72,7 @@ Represents a project or group board | `authoredDate` | Time | Timestamp of when the commit was authored | | `description` | String | Description of the commit message | | `id` | ID! | ID (global ID) of the commit | -| `latestPipeline` | Pipeline | Latest pipeline of the commit | +| `latestPipeline` **{warning-solid}** | Pipeline | **Deprecated:** Use pipelines | | `message` | String | Raw commit message | | `sha` | String! | SHA1 ID of the commit | | `signatureHtml` | String | Rendered HTML of the commit signature | @@ -294,6 +297,7 @@ Represents an epic. | `closedAt` | Time | Timestamp of the epic's closure | | `createdAt` | Time | Timestamp of the epic's creation | | `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues | +| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed descendant epic's issues. Available only when feature flag unfiltered_epic_aggregates is enabled. | | `description` | String | Description of the epic | | `downvotes` | Int! | Number of downvotes the epic has received | | `dueDate` | Time | Due date of the epic | @@ -334,6 +338,15 @@ Counts of descendent epics. | `openedEpics` | Int | Number of opened sub-epics | | `openedIssues` | Int | Number of opened epic issues | +## EpicDescendantWeights + +Total weight of open and closed descendant issues + +| Name | Type | Description | +| --- | ---- | ---------- | +| `closedIssues` | Int | Total weight of completed (closed) issues in this epic, including epic descendants | +| `openedIssues` | Int | Total weight of opened issues in this epic, including epic descendants | + ## EpicIssue Relationship between an epic and an issue @@ -347,7 +360,7 @@ Relationship between an epic and an issue | `description` | String | Description of the issue | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `designCollection` | DesignCollection | Collection of design images associated with this issue | -| `designs` | DesignCollection | Deprecated. Use `designCollection` | +| `designs` **{warning-solid}** | DesignCollection | **Deprecated:** Use designCollection | | `discussionLocked` | Boolean! | Indicates discussion is locked on the issue | | `downvotes` | Int! | Number of downvotes the issue has received | | `dueDate` | Time | Due date of the issue | @@ -417,7 +430,7 @@ Autogenerated return type of EpicTreeReorder | `enabled` | Boolean! | Indicates whether Grafana integration is enabled | | `grafanaUrl` | String! | Url for the Grafana host for the Grafana integration | | `id` | ID! | Internal ID of the Grafana integration | -| `token` | String! | API token for the Grafana integration. Field is permanently masked. | +| `token` **{warning-solid}** | String! | **Deprecated:** Plain text token has been masked for security reasons | | `updatedAt` | Time! | Timestamp of the issue's last activity | ## Group @@ -469,7 +482,7 @@ Autogenerated return type of EpicTreeReorder | `description` | String | Description of the issue | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | | `designCollection` | DesignCollection | Collection of design images associated with this issue | -| `designs` | DesignCollection | Deprecated. Use `designCollection` | +| `designs` **{warning-solid}** | DesignCollection | **Deprecated:** Use designCollection | | `discussionLocked` | Boolean! | Indicates discussion is locked on the issue | | `downvotes` | Int! | Number of downvotes the issue has received | | `dueDate` | Time | Due date of the issue | @@ -578,7 +591,7 @@ Autogenerated return type of MarkAsSpamSnippet | `id` | ID! | ID of the merge request | | `iid` | String! | Internal ID of the merge request | | `inProgressMergeCommitSha` | String | Commit SHA of the merge request if merge is in progress | -| `mergeCommitMessage` | String | Deprecated - renamed to defaultMergeCommitMessage | +| `mergeCommitMessage` **{warning-solid}** | String | **Deprecated:** Renamed to defaultMergeCommitMessage | | `mergeCommitSha` | String | SHA of the merge request commit (set once merged) | | `mergeError` | String | Error message due to a merge error | | `mergeOngoing` | Boolean! | Indicates if a merge is currently occurring | diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 38a5e350bee..596365743fa 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -30,6 +30,7 @@ If the `custom` level is used, specific email events can be controlled. Availabl - `reassign_merge_request` - `merge_merge_request` - `failed_pipeline` +- `fixed_pipeline` - `success_pipeline` - `new_epic` **(ULTIMATE)** @@ -83,6 +84,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab. | `reassign_merge_request` | boolean | no | Enable/disable this notification | | `merge_merge_request` | boolean | no | Enable/disable this notification | | `failed_pipeline` | boolean | no | Enable/disable this notification | +| `fixed_pipeline` | boolean | no | Enable/disable this notification | | `success_pipeline` | boolean | no | Enable/disable this notification | | `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6626) in 11.3) **(ULTIMATE)** | @@ -152,6 +154,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab. | `reassign_merge_request` | boolean | no | Enable/disable this notification | | `merge_merge_request` | boolean | no | Enable/disable this notification | | `failed_pipeline` | boolean | no | Enable/disable this notification | +| `fixed_pipeline` | boolean | no | Enable/disable this notification | | `success_pipeline` | boolean | no | Enable/disable this notification | | `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6626) in 11.3) **(ULTIMATE)** | @@ -178,6 +181,7 @@ Example responses: "reassign_merge_request": false, "merge_merge_request": false, "failed_pipeline": false, + "fixed_pipeline": false, "success_pipeline": false } } |