diff options
Diffstat (limited to 'doc/api')
105 files changed, 14149 insertions, 5762 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 8fb3269d28b..d6119fbfa43 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -21,7 +21,7 @@ Contributions are welcome. For a list of the available resources and their endpoints, see [API resources](api_resources.md). -## SCIM **(SILVER ONLY)** +## SCIM **(PREMIUM SAAS)** GitLab provides an [SCIM API](scim.md) that both implements [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644) and provides the @@ -124,7 +124,7 @@ There are several methods you can use to authenticate with the GitLab API: - [GitLab CI/CD job token](#gitlab-ci-job-token) **(Specific endpoints only)** NOTE: -Project access tokens are supported for self-managed instances on Core and +Project access tokens are supported for self-managed instances on Free and higher. They're also supported on GitLab.com Bronze and higher. For administrators who want to authenticate with the API as a specific user, or who want @@ -200,16 +200,16 @@ With a few API endpoints you can use a [GitLab CI/CD job token](../user/project/ to authenticate with the API: - Packages: - - [Composer Repository](../user/packages/composer_repository/index.md) - - [Conan Repository](../user/packages/conan_repository/index.md) + - [Package Registry for Composer](../user/packages/composer_repository/index.md) + - [Package Registry for Conan](../user/packages/conan_repository/index.md) - [Container Registry](../user/packages/container_registry/index.md) (`$CI_REGISTRY_PASSWORD` is `$CI_JOB_TOKEN`) - [Go Proxy](../user/packages/go_proxy/index.md) - - [Maven Repository](../user/packages/maven_repository/index.md#authenticate-with-a-ci-job-token-in-maven) - - [NPM Repository](../user/packages/npm_registry/index.md#authenticate-with-a-ci-job-token) - - [Nuget Repository](../user/packages/nuget_repository/index.md) - - [PyPI Repository](../user/packages/pypi_repository/index.md#authenticate-with-a-ci-job-token) - - [Generic packages](../user/packages/generic_packages/index.md#publish-a-generic-package-by-using-cicd) + - [Package Registry for Maven](../user/packages/maven_repository/index.md#authenticate-with-a-ci-job-token-in-maven) + - [Package Registry for npm](../user/packages/npm_registry/index.md#authenticate-with-a-ci-job-token) + - [Package Registry for NuGet](../user/packages/nuget_repository/index.md) + - [Package Registry for PyPI](../user/packages/pypi_repository/index.md#authenticate-with-a-ci-job-token) + - [Package Registry for generic packages](../user/packages/generic_packages/index.md#publish-a-generic-package-by-using-cicd) - [Get job artifacts](job_artifacts.md#get-job-artifacts) - [Pipeline triggers](pipeline_triggers.md) (using the `token=` parameter) - [Release creation](releases/index.md#create-a-release) @@ -744,3 +744,15 @@ For administrator documentation on rate limit settings, see [Rate limits](../security/rate_limits.md). To find the settings that are specifically used by GitLab.com, see [GitLab.com-specific rate limits](../user/gitlab_com/index.md#gitlabcom-specific-rate-limits). + +## Content type + +The GitLab API supports the `application/json` content type by default, though +some API endpoints also support `text/plain`. + +In [GitLab 13.9 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/250342), +API endpoints do not support `text/plain` by default, unless it's explicitly documented. + +This change is deployed behind the `:api_always_use_application_json` [feature flag](../user/feature_flags.md), +enabled by default. On GitLab self-managed instances, GitLab administrators can choose +to [disable it](../administration/feature_flags.md). **(FREE SELF)** diff --git a/doc/api/admin_sidekiq_queues.md b/doc/api/admin_sidekiq_queues.md index 7f2f2b8668c..9cbdcb863d6 100644 --- a/doc/api/admin_sidekiq_queues.md +++ b/doc/api/admin_sidekiq_queues.md @@ -4,7 +4,7 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Sidekiq queues administration API **(CORE ONLY)** +# Sidekiq queues administration API **(FREE SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25998) in GitLab 12.9 diff --git a/doc/api/api_resources.md b/doc/api/api_resources.md index 029e434749f..ebe856715a6 100644 --- a/doc/api/api_resources.md +++ b/doc/api/api_resources.md @@ -25,6 +25,7 @@ The following API resources are available in the project context: | Resource | Available endpoints | |:--------------------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | [Access requests](access_requests.md) | `/projects/:id/access_requests` (also available for groups) | +| [Access tokens](resource_access_tokens.md) | `/projects/:id/access_tokens` | | [Award emoji](award_emoji.md) | `/projects/:id/issues/.../award_emoji`, `/projects/:id/merge_requests/.../award_emoji`, `/projects/:id/snippets/.../award_emoji` | | [Branches](branches.md) | `/projects/:id/repository/branches/`, `/projects/:id/repository/merged_branches` | | [Commits](commits.md) | `/projects/:id/repository/commits`, `/projects/:id/statuses` | @@ -76,7 +77,7 @@ The following API resources are available in the project context: | [Remote mirrors](remote_mirrors.md) | `/projects/:id/remote_mirrors` | | [Repositories](repositories.md) | `/projects/:id/repository` | | [Repository files](repository_files.md) | `/projects/:id/repository/files` | -| [Repository submodules](repository_submodules.md) | `/projects/:id/repository/submodules` | +| [Repository submodules](repository_submodules.md) | `/projects/:id/repository/submodules` | | [Resource label events](resource_label_events.md) | `/projects/:id/issues/.../resource_label_events`, `/projects/:id/merge_requests/.../resource_label_events` (also available for groups) | | [Runners](runners.md) | `/projects/:id/runners` (also available standalone) | | [Search](search.md) | `/projects/:id/search` (also available for groups and standalone) | @@ -127,10 +128,10 @@ The following API resources are available outside of project and group contexts | Resource | Available endpoints | |:---------------------------------------------------|:------------------------------------------------------------------------| | [Instance-level CI/CD variables](instance_level_ci_variables.md) | `/admin/ci/variables` | -| [Sidekiq queues administration](admin_sidekiq_queues.md) **(CORE ONLY)** | `/admin/sidekiq/queues/:queue_name` | -| [Appearance](appearance.md) **(CORE ONLY)** | `/application/appearance` | +| [Sidekiq queues administration](admin_sidekiq_queues.md) **(FREE SELF)** | `/admin/sidekiq/queues/:queue_name` | +| [Appearance](appearance.md) **(FREE SELF)** | `/application/appearance` | | [Applications](applications.md) | `/applications` | -| [Audit Events](audit_events.md) **(PREMIUM ONLY)** | `/audit_events` | +| [Audit Events](audit_events.md) **(PREMIUM SELF)** | `/audit_events` | | [Avatar](avatar.md) | `/avatar` | | [Broadcast messages](broadcast_messages.md) | `/broadcast_messages` | | [Code snippets](snippets.md) | `/snippets` | @@ -138,14 +139,15 @@ The following API resources are available outside of project and group contexts | [Deploy keys](deploy_keys.md) | `/deploy_keys` (also available for projects) | | [Events](events.md) | `/events`, `/users/:id/events` (also available for projects) | | [Feature flags](features.md) | `/features` | -| [Geo Nodes](geo_nodes.md) **(PREMIUM ONLY)** | `/geo_nodes` | +| [Geo Nodes](geo_nodes.md) **(PREMIUM SELF)** | `/geo_nodes` | | [Group Activity Analytics](group_activity_analytics.md) **(STARTER)** | `/analytics/group_activity/{issues_count | merge_requests_count | new_members_count }` | +| [Group repository storage moves](group_repository_storage_moves.md) **(PREMIUM SELF)** | `/group_repository_storage_moves` | | [Import repository from GitHub](import.md) | `/import/github` | | [Instance clusters](instance_clusters.md) | `/admin/clusters` | | [Issues](issues.md) | `/issues` (also available for groups and projects) | | [Issues Statistics](issues_statistics.md) | `/issues_statistics` (also available for groups and projects) | | [Keys](keys.md) | `/keys` | -| [License](license.md) **(CORE ONLY)** | `/license` | +| [License](license.md) **(FREE SELF)** | `/license` | | [Markdown](markdown.md) | `/markdown` | | [Merge requests](merge_requests.md) | `/merge_requests` (also available for groups and projects) | | [Metrics dashboard annotations](metrics_dashboard_annotations.md) | `/environments/:id/metrics_dashboard/annotations`, `/clusters/:id/metrics_dashboard/annotations` | @@ -154,13 +156,13 @@ The following API resources are available outside of project and group contexts | [Pages domains](pages_domains.md) | `/pages/domains` (also available for projects) | | [Personal access tokens](personal_access_tokens.md) | `/personal_access_tokens` | | [Projects](projects.md) | `/users/:id/projects` (also available for projects) | -| [Project repository storage moves](project_repository_storage_moves.md) **(CORE ONLY)** | `/project_repository_storage_moves` | +| [Project repository storage moves](project_repository_storage_moves.md) **(FREE SELF)** | `/project_repository_storage_moves` | | [Runners](runners.md) | `/runners` (also available for projects) | | [Search](search.md) | `/search` (also available for groups and projects) | -| [Settings](settings.md) **(CORE ONLY)** | `/application/settings` | -| [Snippet repository storage moves](snippet_repository_storage_moves.md) **(CORE ONLY)** | `/snippet_repository_storage_moves` | +| [Settings](settings.md) **(FREE SELF)** | `/application/settings` | +| [Snippet repository storage moves](snippet_repository_storage_moves.md) **(FREE SELF)** | `/snippet_repository_storage_moves` | | [Statistics](statistics.md) | `/application/statistics` | -| [Sidekiq metrics](sidekiq_metrics.md) **(CORE ONLY)** | `/sidekiq` | +| [Sidekiq metrics](sidekiq_metrics.md) **(FREE SELF)** | `/sidekiq` | | [Suggestions](suggestions.md) | `/suggestions` | | [System hooks](system_hooks.md) | `/hooks` | | [To-dos](todos.md) | `/todos` | diff --git a/doc/api/appearance.md b/doc/api/appearance.md index d03fc94cfcf..5689cacd9ce 100644 --- a/doc/api/appearance.md +++ b/doc/api/appearance.md @@ -4,7 +4,7 @@ group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Appearance API **(CORE ONLY)** +# Appearance API **(FREE SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/16647) in GitLab 12.7. diff --git a/doc/api/applications.md b/doc/api/applications.md index eb4930c8721..19a80685b6f 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -14,7 +14,7 @@ Applications API operates on OAuth applications for: - [Allowing access to GitLab resources on a user's behalf](oauth2.md). NOTE: -Only admin users can use the Applications API. +Only administrator users can use the Applications API. ## Create an application diff --git a/doc/api/audit_events.md b/doc/api/audit_events.md index 5017c8defaf..78bf292a3d7 100644 --- a/doc/api/audit_events.md +++ b/doc/api/audit_events.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Audit Events API -## Instance Audit Events **(PREMIUM ONLY)** +## Instance Audit Events **(PREMIUM SELF)** The Audit Events API allows you to retrieve [instance audit events](../administration/audit_events.md#instance-events). @@ -126,7 +126,7 @@ Example response: } ``` -## Group Audit Events **(STARTER)** +## Group Audit Events **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34078) in GitLab 12.5. @@ -233,7 +233,7 @@ Example response: } ``` -## Project Audit Events **(STARTER)** +## Project Audit Events **(PREMIUM)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/219238) in GitLab 13.1. diff --git a/doc/api/avatar.md b/doc/api/avatar.md index ccaa50eedd8..14fdc5e8afd 100644 --- a/doc/api/avatar.md +++ b/doc/api/avatar.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ## Get a single avatar URL -Get a single [avatar](../user/profile/index.md#profile-settings) URL for a user with the given email address. +Get a single [avatar](../user/profile/index.md#user-settings) URL for a user with the given email address. If: diff --git a/doc/api/boards.md b/doc/api/boards.md index e86f0d846ed..021e4103228 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w Every API call to boards must be authenticated. -If a user is not a member of a project and the project is private, a `GET` -request on that project will result to a `404` status code. +If a user is not a member of a private project, +a `GET` request on that project results in a `404` status code. ## List project issue boards @@ -488,7 +488,7 @@ Example response: ## Delete a board list from a board -Only for admins and project owners. Deletes the board list in question. +Only for administrators and project owners. Deletes a board list. ```plaintext DELETE /projects/:id/boards/:board_id/lists/:list_id diff --git a/doc/api/branches.md b/doc/api/branches.md index 74383841272..e9e27a358f0 100644 --- a/doc/api/branches.md +++ b/doc/api/branches.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Branches API +# Branches API **(FREE)** This API operates on [repository branches](../user/project/repository/branches/index.md). diff --git a/doc/api/build_triggers.md b/doc/api/build_triggers.md deleted file mode 100644 index 13adf949981..00000000000 --- a/doc/api/build_triggers.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: 'pipeline_triggers.md' ---- - -This document was moved to [another location](pipeline_triggers.md). - -<!-- This redirect file can be deleted after February 1, 2021. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/builds.md b/doc/api/builds.md deleted file mode 100644 index b7b61e853a8..00000000000 --- a/doc/api/builds.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: 'jobs.md' ---- - -This document was moved to [another location](jobs.md). - -<!-- This redirect file can be deleted after February 1, 2021. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/commits.md b/doc/api/commits.md index 81014956fc5..f4896f75c93 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -5,7 +5,9 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Commits API +# Commits API **(FREE)** + +This API operates on [repository commits](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository). Read more about [GitLab-specific information](../user/project/repository/index.md#commits) for commits. ## List repository commits diff --git a/doc/api/dependency_proxy.md b/doc/api/dependency_proxy.md index ab691aaecea..8448edef9c5 100644 --- a/doc/api/dependency_proxy.md +++ b/doc/api/dependency_proxy.md @@ -9,9 +9,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w ## Purge the dependency proxy for a group > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11631) in GitLab 12.10. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/273655) to [GitLab Core](https://about.gitlab.com/pricing/) in GitLab 13.6. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/273655) to [GitLab Free](https://about.gitlab.com/pricing/) in GitLab 13.6. -Deletes the cached manifests and blobs for a group. This endpoint requires group admin access. +Deletes the cached manifests and blobs for a group. This endpoint requires group owner access. WARNING: [A bug exists](https://gitlab.com/gitlab-org/gitlab/-/issues/277161) for this API. diff --git a/doc/api/deploy_key_multiple_projects.md b/doc/api/deploy_key_multiple_projects.md deleted file mode 100644 index 16ce201c1c0..00000000000 --- a/doc/api/deploy_key_multiple_projects.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: deploy_keys.md#adding-deploy-keys-to-multiple-projects ---- - -This document was moved to [another location](deploy_keys.md#adding-deploy-keys-to-multiple-projects). - -<!-- This redirect file can be deleted after February 1, 2021. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/deploy_keys.md b/doc/api/deploy_keys.md index 91046717c1d..30a56e6253b 100644 --- a/doc/api/deploy_keys.md +++ b/doc/api/deploy_keys.md @@ -4,11 +4,11 @@ group: Release info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Deploy Keys API +# Deploy keys API ## List all deploy keys -Get a list of all deploy keys across all projects of the GitLab instance. This endpoint requires admin access and is not available on GitLab.com. +Get a list of all deploy keys across all projects of the GitLab instance. This endpoint requires administrator access and is not available on GitLab.com. ```plaintext GET /deploy_keys diff --git a/doc/api/deploy_tokens.md b/doc/api/deploy_tokens.md index 2bdec4a0688..eae46d5f2f5 100644 --- a/doc/api/deploy_tokens.md +++ b/doc/api/deploy_tokens.md @@ -10,7 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/21811) in GitLab 12.9. -Get a list of all deploy tokens across the GitLab instance. This endpoint requires admin access. +Get a list of all deploy tokens across the GitLab instance. This endpoint requires administrator access. ```plaintext GET /deploy_tokens diff --git a/doc/api/discussions.md b/doc/api/discussions.md index a7a53987fe9..d88d4780e65 100644 --- a/doc/api/discussions.md +++ b/doc/api/discussions.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference, api --- -# Discussions API +# Discussions API **(FREE)** Discussions are a set of related notes on: @@ -156,7 +156,7 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `issue_iid` | integer | yes | The IID of an issue | | `body` | string | yes | The content of the thread | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions?body=comment" @@ -182,7 +182,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a thread | | `note_id` | integer | yes | The ID of a thread note | | `body` | string | yes | The content of the note/reply | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/issues/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment" @@ -365,7 +365,7 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `snippet_id` | integer | yes | The ID of an snippet | | `body` | string | yes | The content of a discussion | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions?body=comment" @@ -388,7 +388,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a thread | | `note_id` | integer | yes | The ID of a thread note | | `body` | string | yes | The content of the note/reply | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/snippets/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment" @@ -572,7 +572,7 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) | | `epic_id` | integer | yes | The ID of an epic | | `body` | string | yes | The content of the thread | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions?body=comment" @@ -596,7 +596,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a thread | | `note_id` | integer | yes | The ID of a thread note | | `body` | string | yes | The content of the note/reply | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epics/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment" @@ -847,7 +847,7 @@ Parameters: | `merge_request_iid` | integer | yes | The IID of a merge request | | `body` | string | yes | The content of the thread | | `commit_id` | string | no | SHA referencing commit to start this thread on | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | | `position` | hash | no | Position when creating a diff note | | `position[base_sha]` | string | yes | Base commit SHA in the source branch | | `position[start_sha]` | string | yes | SHA referencing commit in target branch | @@ -912,7 +912,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a thread | | `note_id` | integer | yes | The ID of a thread note | | `body` | string | yes | The content of the note/reply | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/merge_requests/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment" @@ -1147,7 +1147,7 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `commit_id` | integer | yes | The ID of a commit | | `body` | string | yes | The content of the thread | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | | `position` | hash | no | Position when creating a diff note | | `position[base_sha]` | string | yes | Base commit SHA in the source branch | | `position[start_sha]` | string | yes | SHA referencing commit in target branch | @@ -1183,7 +1183,7 @@ Parameters: | `discussion_id` | integer | yes | The ID of a thread | | `note_id` | integer | yes | The ID of a thread note | | `body` | string | yes | The content of the note/reply | -| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires admin or project/group owner rights) | +| `created_at` | string | no | Date time string, ISO 8601 formatted, e.g. 2016-03-11T03:45:40Z (requires administrator or project/group owner rights) | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/commits/11/discussions/6a9c1750b37d513a43987b574953fceb50b03ce7/notes?body=comment diff --git a/doc/api/dora4_group_analytics.md b/doc/api/dora4_group_analytics.md new file mode 100644 index 00000000000..7a7260f40e8 --- /dev/null +++ b/doc/api/dora4_group_analytics.md @@ -0,0 +1,84 @@ +--- +stage: Release +group: Release +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +type: reference, api +--- + +# DORA4 Analytics Group API **(ULTIMATE ONLY)** + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/291747) in GitLab 13.9. +> - It's [deployed behind a feature flag](../user/feature_flags.md), disabled by default. +> - It's disabled on GitLab.com. +> - It's not recommended for production use. +> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-dora4-analytics-group-api). **(ULTIMATE ONLY)** + +WARNING: +This feature might not be available to you. Check the **version history** note above for details. + +All methods require reporter authorization. + +## List group deployment frequencies + +Get a list of all group deployment frequencies: + +```plaintext +GET /groups/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval +``` + +Attributes: + +| Attribute | Type | Required | Description | +|--------------|--------|----------|-----------------------| +| `id` | string | yes | The ID of the group. | + +Parameters: + +| Parameter | Type | Required | Description | +|--------------|--------|----------|-----------------------| +| `environment`| string | yes | The name of the environment to filter by. | +| `from` | string | yes | Datetime range to start from. Inclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). | +| `to` | string | no | Datetime range to end at. Exclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`). | +| `interval` | string | no | The bucketing interval (`all`, `monthly`, `daily`). | + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval" +``` + +Example response: + +```json +[ + { + "from": "2017-01-01", + "to": "2017-01-02", + "value": 106 + }, + { + "from": "2017-01-02", + "to": "2017-01-03", + "value": 55 + } +] +``` + +## Enable or disable DORA4 Analytics Group API **(ULTIMATE ONLY)** + +DORA4 Analytics Group API is under development and not ready for production use. It is +deployed behind a feature flag that is **disabled by default**. +[GitLab administrators with access to the GitLab Rails console](../administration/feature_flags.md) +can enable it. + +To enable it: + +```ruby +Feature.enable(:dora4_group_deployment_frequency_api) +``` + +To disable it: + +```ruby +Feature.disable(:dora4_group_deployment_frequency_api) +``` diff --git a/doc/api/dora4_project_analytics.md b/doc/api/dora4_project_analytics.md new file mode 100644 index 00000000000..a1becb056bf --- /dev/null +++ b/doc/api/dora4_project_analytics.md @@ -0,0 +1,54 @@ +--- +stage: Release +group: Release +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +type: reference, api +--- + +# DORA4 Analytics Project API **(ULTIMATE ONLY)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/279039) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.7. + +All methods require reporter authorization. + +## List project deployment frequencies + +Get a list of all project deployment frequencies, sorted by date: + +```plaintext +GET /projects/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval +``` + +| Attribute | Type | Required | Description | +|--------------|--------|----------|-----------------------| +| `id` | string | yes | The ID of the project | + +| Parameter | Type | Required | Description | +|--------------|--------|----------|-----------------------| +| `environment`| string | yes | The name of the environment to filter by | +| `from` | string | yes | Datetime range to start from, inclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`) | +| `to` | string | no | Datetime range to end at, exclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`) | +| `interval` | string | no | The bucketing interval (`all`, `monthly`, `daily`) | + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval" +``` + +Example response: + +```json +[ + { + "from": "2017-01-01", + "to": "2017-01-02", + "value": 106 + }, + { + "from": "2017-01-02", + "to": "2017-01-03", + "value": 55 + } +] +``` diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index cabab18ed71..228f68531fd 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -12,9 +12,10 @@ Manages parent-child [epic relationships](../user/group/epics/index.md#multi-lev Every API call to `epic_links` must be authenticated. -If a user makes a `GET` request to a private group they are not a member of, the result is a `404` status code. +If a user is not a member of a private group, a `GET` request on that +group results in a `404` status code. -Multi-level Epics are available only in GitLab [Ultimate/Gold](https://about.gitlab.com/pricing/). +Multi-level Epics are available only in GitLab [Ultimate](https://about.gitlab.com/pricing/). If the Multi-level Epics feature is not available, a `403` status code is returned. ## List epics related to a given epic diff --git a/doc/api/error_tracking.md b/doc/api/error_tracking.md index 12ff0148661..c737edbdc44 100644 --- a/doc/api/error_tracking.md +++ b/doc/api/error_tracking.md @@ -4,7 +4,7 @@ group: Health info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Error Tracking settings API +# Error Tracking settings API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/34940) in GitLab 12.7. diff --git a/doc/api/events.md b/doc/api/events.md index d073e7ed633..e2ff779f3bf 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -25,7 +25,7 @@ Available action types for the `action` parameter are: - `destroyed` - `expired` -Note that these options are downcased. +Note that these options are in lower case. ### Target Types @@ -39,7 +39,7 @@ Available target types for the `target_type` parameter are: - `snippet` - `user` -Note that these options are downcased. +Note that these options are in lower case. ### Date formatting diff --git a/doc/api/feature_flag_user_lists.md b/doc/api/feature_flag_user_lists.md index ba03b81ebfd..e0a5fe99663 100644 --- a/doc/api/feature_flag_user_lists.md +++ b/doc/api/feature_flag_user_lists.md @@ -4,10 +4,10 @@ group: Release info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Feature flag user lists API **(CORE)** +# Feature flag user lists API **(FREE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/205409) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.10. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to GitLab Core in 13.5. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to GitLab Free in 13.5. API for accessing GitLab Feature Flag User Lists. diff --git a/doc/api/feature_flags.md b/doc/api/feature_flags.md index e8d6911463d..77d30475555 100644 --- a/doc/api/feature_flags.md +++ b/doc/api/feature_flags.md @@ -4,11 +4,11 @@ group: Release info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Feature Flags API **(CORE)** +# Feature Flags API **(FREE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Starter](https://about.gitlab.com/pricing/) in 13.4. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.5. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.5. API for accessing resources of [GitLab Feature Flags](../operations/feature_flags.md). diff --git a/doc/api/feature_flags_legacy.md b/doc/api/feature_flags_legacy.md index 8a5af39a37f..33ea2727fb9 100644 --- a/doc/api/feature_flags_legacy.md +++ b/doc/api/feature_flags_legacy.md @@ -4,11 +4,11 @@ group: Release info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Legacy Feature Flags API **(CORE)** +# Legacy Feature Flags API **(FREE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/9566) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.5. > - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Starter](https://about.gitlab.com/pricing/) in 13.4. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.5. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212318) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.5. WARNING: This API is deprecated and [scheduled for removal in GitLab 14.0](https://gitlab.com/gitlab-org/gitlab/-/issues/213369). Use [this API](feature_flags.md) instead. diff --git a/doc/api/features.md b/doc/api/features.md index 0ed0dec1b6d..cb3ee04d076 100644 --- a/doc/api/features.md +++ b/doc/api/features.md @@ -128,7 +128,7 @@ POST /features/:name | `user` | string | no | A GitLab username | | `group` | string | no | A GitLab group's path, for example `gitlab-org` | | `project` | string | no | A projects path, for example `gitlab-org/gitlab-foss` | -| `force` | boolean | no | Skip feature flag validation checks, ie. YAML definition | +| `force` | boolean | no | Skip feature flag validation checks, such as a YAML definition | Note that you can enable or disable a feature for a `feature_group`, a `user`, a `group`, and a `project` in a single API call. diff --git a/doc/api/geo_nodes.md b/doc/api/geo_nodes.md index 280d02ced32..a2417af5285 100644 --- a/doc/api/geo_nodes.md +++ b/doc/api/geo_nodes.md @@ -4,10 +4,10 @@ group: Geo info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Geo Nodes API **(PREMIUM ONLY)** +# Geo Nodes API **(PREMIUM SELF)** To interact with Geo node endpoints, you need to authenticate yourself as an -admin. +administrator. ## Create a new Geo node @@ -307,37 +307,37 @@ Example response: "health_status": "Healthy", "missing_oauth_application": false, "attachments_count": 1, - "attachments_synced_count": nil, - "attachments_failed_count": nil, + "attachments_synced_count": null, + "attachments_failed_count": null, "attachments_synced_missing_on_primary_count": 0, "attachments_synced_in_percentage": "0.00%", - "db_replication_lag_seconds": nil, + "db_replication_lag_seconds": null, "lfs_objects_count": 0, - "lfs_objects_synced_count": nil, - "lfs_objects_failed_count": nil, + "lfs_objects_synced_count": null, + "lfs_objects_failed_count": null, "lfs_objects_synced_missing_on_primary_count": 0, "lfs_objects_synced_in_percentage": "0.00%", "job_artifacts_count": 2, - "job_artifacts_synced_count": nil, - "job_artifacts_failed_count": nil, + "job_artifacts_synced_count": null, + "job_artifacts_failed_count": null, "job_artifacts_synced_missing_on_primary_count": 0, "job_artifacts_synced_in_percentage": "0.00%", "container_repositories_count": 3, - "container_repositories_synced_count": nil, - "container_repositories_failed_count": nil, + "container_repositories_synced_count": null, + "container_repositories_failed_count": null, "container_repositories_synced_in_percentage": "0.00%", "design_repositories_count": 3, - "design_repositories_synced_count": nil, - "design_repositories_failed_count": nil, + "design_repositories_synced_count": null, + "design_repositories_failed_count": null, "design_repositories_synced_in_percentage": "0.00%", "projects_count": 41, "repositories_count": 41, - "repositories_failed_count": nil, - "repositories_synced_count": nil, + "repositories_failed_count": null, + "repositories_synced_count": null, "repositories_synced_in_percentage": "0.00%", "wikis_count": 41, - "wikis_failed_count": nil, - "wikis_synced_count": nil, + "wikis_failed_count": null, + "wikis_synced_count": null, "wikis_synced_in_percentage": "0.00%", "replication_slots_count": 1, "replication_slots_used_count": 1, @@ -367,7 +367,7 @@ Example response: "repositories_checked_in_percentage": "17.07%", "last_event_id": 23, "last_event_timestamp": 1509681166, - "cursor_last_event_id": nil, + "cursor_last_event_id": null, "cursor_last_event_timestamp": 0, "last_successful_status_check_timestamp": 1510125024, "version": "10.3.0", @@ -408,12 +408,12 @@ Example response: "job_artifacts_synced_missing_on_primary_count": 0, "job_artifacts_synced_in_percentage": "50.00%", "container_repositories_count": 3, - "container_repositories_synced_count": nil, - "container_repositories_failed_count": nil, + "container_repositories_synced_count": null, + "container_repositories_failed_count": null, "container_repositories_synced_in_percentage": "0.00%", "design_repositories_count": 3, - "design_repositories_synced_count": nil, - "design_repositories_failed_count": nil, + "design_repositories_synced_count": null, + "design_repositories_failed_count": null, "design_repositories_synced_in_percentage": "0.00%", "projects_count": 41, "repositories_count": 41, @@ -424,10 +424,10 @@ Example response: "wikis_failed_count": 0, "wikis_synced_count": 41, "wikis_synced_in_percentage": "100.00%", - "replication_slots_count": nil, - "replication_slots_used_count": nil, + "replication_slots_count": null, + "replication_slots_used_count": null, "replication_slots_used_in_percentage": "0.00%", - "replication_slots_max_retained_wal_bytes": nil, + "replication_slots_max_retained_wal_bytes": null, "repositories_checksummed_count": 20, "repositories_checksum_failed_count": 5, "repositories_checksummed_in_percentage": "48.78%", @@ -518,12 +518,12 @@ Example response: "job_artifacts_synced_missing_on_primary_count": 0, "job_artifacts_synced_in_percentage": "50.00%", "container_repositories_count": 3, - "container_repositories_synced_count": nil, - "container_repositories_failed_count": nil, + "container_repositories_synced_count": null, + "container_repositories_failed_count": null, "container_repositories_synced_in_percentage": "0.00%", "design_repositories_count": 3, - "design_repositories_synced_count": nil, - "design_repositories_failed_count": nil, + "design_repositories_synced_count": null, + "design_repositories_failed_count": null, "design_repositories_synced_in_percentage": "0.00%", "projects_count": 41, "repositories_count": 41, @@ -534,10 +534,10 @@ Example response: "wikis_failed_count": 0, "wikis_synced_count": 41, "wikis_synced_in_percentage": "100.00%", - "replication_slots_count": nil, - "replication_slots_used_count": nil, + "replication_slots_count": null, + "replication_slots_used_count": null, "replication_slots_used_in_percentage": "0.00%", - "replication_slots_max_retained_wal_bytes": nil, + "replication_slots_max_retained_wal_bytes": null, "last_event_id": 23, "last_event_timestamp": 1509681166, "cursor_last_event_id": 23, diff --git a/doc/api/graphql/getting_started.md b/doc/api/graphql/getting_started.md index ca2b7989700..1b7e273f7a1 100644 --- a/doc/api/graphql/getting_started.md +++ b/doc/api/graphql/getting_started.md @@ -314,9 +314,10 @@ Pagination is a way of only asking for a subset of the records (say, the first 1 If we want more of them, we can make another request for the next 10 from the server (in the form of something like "please give me the next 10 records"). -By default, the GitLab GraphQL API returns only the first 100 records of any collection. +By default, the GitLab GraphQL API returns 100 records per page. This can be changed by using `first` or `last` arguments. Both arguments take a value, so `first: 10` returns the first 10 records, and `last: 10` the last 10 records. +There is a limit on how many records will be returned per page, which is generally `100`. Example: Retrieve only the first 2 issues (slicing). The `cursor` field gives us a position from which we can retrieve further records relative to that one. diff --git a/doc/api/graphql/img/users_query_example_v13_8.png b/doc/api/graphql/img/users_query_example_v13_8.png Binary files differindex b4c2b4e999a..155824cad6e 100644 --- a/doc/api/graphql/img/users_query_example_v13_8.png +++ b/doc/api/graphql/img/users_query_example_v13_8.png diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index 45a327d323b..7a68b1cdf16 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -48,7 +48,7 @@ libraries](https://graphql.org/code/#graphql-clients) to consume the API and avoid manual parsing. Since there's no fixed endpoints and data model, new abilities can be -added to the API without creating breaking changes. This allows us to +added to the API without creating [breaking changes](../../development/contributing/#breaking-changes). This allows us to have a versionless API as described in [the GraphQL documentation](https://graphql.org/learn/best-practices/#versioning). @@ -117,6 +117,43 @@ information about multiplexed queries is also available for [GraphQL Ruby](https://graphql-ruby.org/queries/multiplex.html), the library GitLab uses on the backend. +## Limits + +The following limits apply to the GitLab GraphQL API. + +### Max page size + +By default, connections return at most `100` records ("nodes") per page, +and this limit applies to most connections in the API. Particular connections +may have different max page size limits that are higher or lower. + +### Max query complexity + +The GitLab GraphQL API scores the _complexity_ of a query. Generally, larger +queries will have a higher complexity score. This limit is designed to protect +the API from performing queries that could negatively impact its overall performance. + +The complexity of a single query is limited to a maximum of: + +- `200` for unauthenticated requests. +- `250` for authenticated requests. + +There is no way to discover the complexity of a query except by exceeding the limit. + +If a query exceeds the complexity limit an error message response will +be returned. + +In general, each field in a query will add `1` to the complexity score, although +this can be higher or lower for particular fields. Sometimes the addition of +certain arguments may also increase the complexity of a query. + +The complexity limits may be revised in future, and additionally, the complexity +of a query may be altered. + +### Request timeout + +Requests time out at 30 seconds. + ## Reference The GitLab GraphQL reference [is available](reference/index.md). diff --git a/doc/api/graphql/reference/gitlab_schema.graphql b/doc/api/graphql/reference/gitlab_schema.graphql index 94792a49933..4e89f663efc 100644 --- a/doc/api/graphql/reference/gitlab_schema.graphql +++ b/doc/api/graphql/reference/gitlab_schema.graphql @@ -3,12 +3,12 @@ Represents the access level of a relationship between a User and object that it """ type AccessLevel { """ - Integer representation of access level + Integer representation of access level. """ integerValue: Int """ - String representation of access level + String representation of access level. """ stringValue: AccessLevelEnum } @@ -40,7 +40,7 @@ input AddAwardEmojiInput { clientMutationId: String """ - The emoji name + The emoji name. """ name: String! } @@ -180,7 +180,7 @@ Describes an alert from the project's Alert Management """ type AlertManagementAlert implements Noteable { """ - Assignees of the alert + Assignees of the alert. """ assignees( """ @@ -205,27 +205,27 @@ type AlertManagementAlert implements Noteable { ): UserConnection """ - Timestamp the alert was created + Timestamp the alert was created. """ createdAt: Time """ - Description of the alert + Description of the alert. """ description: String """ - Alert details + Alert details. """ details: JSON """ - The URL of the alert detail page + The URL of the alert detail page. """ detailsUrl: String! """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -250,47 +250,47 @@ type AlertManagementAlert implements Noteable { ): DiscussionConnection! """ - Timestamp the alert ended + Timestamp the alert ended. """ endedAt: Time """ - Environment for the alert + Environment for the alert. """ environment: Environment """ - Number of events of this alert + Number of events of this alert. """ eventCount: Int """ - List of hosts the alert came from + List of hosts the alert came from. """ hosts: [String!] """ - Internal ID of the alert + Internal ID of the alert. """ iid: ID! """ - Internal ID of the GitLab issue attached to the alert + Internal ID of the GitLab issue attached to the alert. """ issueIid: ID """ - URL for metrics embed for the alert + URL for metrics embed for the alert. """ metricsDashboardUrl: String """ - Monitoring tool the alert came from + Monitoring tool the alert came from. """ monitoringTool: String """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -315,42 +315,42 @@ type AlertManagementAlert implements Noteable { ): NoteConnection! """ - The alert condition for Prometheus + The alert condition for Prometheus. """ prometheusAlert: PrometheusAlert """ - Runbook for the alert as defined in alert details + Runbook for the alert as defined in alert details. """ runbook: String """ - Service the alert came from + Service the alert came from. """ service: String """ - Severity of the alert + Severity of the alert. """ severity: AlertManagementSeverity """ - Timestamp the alert was raised + Timestamp the alert was raised. """ startedAt: Time """ - Status of the alert + Status of the alert. """ status: AlertManagementStatus """ - Title of the alert + Title of the alert. """ title: String """ - Todos of the current user for the alert + To-do items of the current user for the alert. """ todos( """ @@ -405,7 +405,7 @@ type AlertManagementAlert implements Noteable { ): TodoConnection """ - Timestamp the alert was last updated + Timestamp the alert was last updated. """ updatedAt: Time } @@ -570,7 +570,7 @@ type AlertManagementAlertStatusCountsType { acknowledged: Int """ - Total number of alerts for the project + Total number of alerts for the project. """ all: Int @@ -580,7 +580,7 @@ type AlertManagementAlertStatusCountsType { ignored: Int """ - Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project + Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. """ open: Int @@ -615,79 +615,79 @@ An endpoint and credentials used to accept alerts for a project """ type AlertManagementHttpIntegration implements AlertManagementIntegration { """ - Whether the endpoint is currently accepting alerts + Whether the endpoint is currently accepting alerts. """ active: Boolean """ - URL at which Prometheus metrics can be queried to populate the metrics dashboard + URL at which Prometheus metrics can be queried to populate the metrics dashboard. """ apiUrl: String """ - ID of the integration + ID of the integration. """ id: ID! """ - Name of the integration + Name of the integration. """ name: String """ - Token used to authenticate alert notification requests + Token used to authenticate alert notification requests. """ token: String """ - Type of integration + Type of integration. """ type: AlertManagementIntegrationType! """ - Endpoint which accepts alert notifications + Endpoint which accepts alert notifications. """ url: String } """ -Identifier of AlertManagement::HttpIntegration +Identifier of AlertManagement::HttpIntegration. """ scalar AlertManagementHttpIntegrationID interface AlertManagementIntegration { """ - Whether the endpoint is currently accepting alerts + Whether the endpoint is currently accepting alerts. """ active: Boolean """ - URL at which Prometheus metrics can be queried to populate the metrics dashboard + URL at which Prometheus metrics can be queried to populate the metrics dashboard. """ apiUrl: String """ - ID of the integration + ID of the integration. """ id: ID! """ - Name of the integration + Name of the integration. """ name: String """ - Token used to authenticate alert notification requests + Token used to authenticate alert notification requests. """ token: String """ - Type of integration + Type of integration. """ type: AlertManagementIntegrationType! """ - Endpoint which accepts alert notifications + Endpoint which accepts alert notifications. """ url: String } @@ -743,6 +743,26 @@ enum AlertManagementIntegrationType { } """ +Parsed field from an alert used for custom mappings +""" +type AlertManagementPayloadAlertField { + """ + Human-readable label of the payload path. + """ + label: String + + """ + Path to value inside payload JSON. + """ + path: [String!] + + """ + Type of the parsed value. + """ + type: AlertManagementPayloadAlertFieldType +} + +""" Field that are available while modifying the custom mapping attributes for an HTTP integration """ input AlertManagementPayloadAlertFieldInput { @@ -847,37 +867,37 @@ An endpoint and credentials used to accept Prometheus alerts for a project """ type AlertManagementPrometheusIntegration implements AlertManagementIntegration { """ - Whether the endpoint is currently accepting alerts + Whether the endpoint is currently accepting alerts. """ active: Boolean """ - URL at which Prometheus metrics can be queried to populate the metrics dashboard + URL at which Prometheus metrics can be queried to populate the metrics dashboard. """ apiUrl: String """ - ID of the integration + ID of the integration. """ id: ID! """ - Name of the integration + Name of the integration. """ name: String """ - Token used to authenticate alert notification requests + Token used to authenticate alert notification requests. """ token: String """ - Type of integration + Type of integration. """ type: AlertManagementIntegrationType! """ - Endpoint which accepts alert notifications + Endpoint which accepts alert notifications. """ url: String } @@ -997,7 +1017,7 @@ type AlertSetAssigneesPayload { issue: Issue """ - The todo after mutation. + The to-do item after mutation. """ todo: Todo } @@ -1047,17 +1067,138 @@ type AlertTodoCreatePayload { issue: Issue """ - The todo after mutation. + The to-do item after mutation. """ todo: Todo } """ -Identifier of Analytics::DevopsAdoption::Segment +Identifier of Analytics::DevopsAdoption::Segment. """ scalar AnalyticsDevopsAdoptionSegmentID """ +Data associated with configuring API fuzzing scans in GitLab CI +""" +type ApiFuzzingCiConfiguration { + """ + All available scan modes. + """ + scanModes: [ApiFuzzingScanMode!] + + """ + All default scan profiles. + """ + scanProfiles: [ApiFuzzingScanProfile!] +} + +""" +Autogenerated input type of ApiFuzzingCiConfigurationCreate +""" +input ApiFuzzingCiConfigurationCreateInput { + """ + File path or URL to the file that defines the API surface for scanning. Must + be in the format specified by the `scanMode` argument. + """ + apiSpecificationFile: String! + + """ + CI variable containing the password for authenticating with the target API. + """ + authPassword: String + + """ + CI variable containing the username for authenticating with the target API. + """ + authUsername: String + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Full path of the project. + """ + projectPath: ID! + + """ + The mode for API fuzzing scans. + """ + scanMode: ApiFuzzingScanMode! + + """ + Name of a default profile to use for scanning. Ex: Quick-10. + """ + scanProfile: String + + """ + URL for the target of API fuzzing scans. + """ + target: String! +} + +""" +Autogenerated return type of ApiFuzzingCiConfigurationCreate +""" +type ApiFuzzingCiConfigurationCreatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. + """ + configurationYaml: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. + """ + gitlabCiYamlEditPath: String +} + +""" +All possible ways to specify the API surface for an API fuzzing scan +""" +enum ApiFuzzingScanMode { + """ + The API surface is specified by a HAR file. + """ + HAR + + """ + The API surface is specified by a OPENAPI file. + """ + OPENAPI +} + +""" +An API Fuzzing scan profile. +""" +type ApiFuzzingScanProfile { + """ + A short description of the profile. + """ + description: String + + """ + The unique name of the profile. + """ + name: String + + """ + A syntax highlit HTML representation of the YAML. + """ + yaml: String +} + +""" User availability status """ enum AvailabilityEnum { @@ -1077,32 +1218,32 @@ An emoji awarded by a user """ type AwardEmoji { """ - The emoji description + The emoji description. """ description: String! """ - The emoji as an icon + The emoji as an icon. """ emoji: String! """ - The emoji name + The emoji name. """ name: String! """ - The emoji in unicode + The emoji in Unicode. """ unicode: String! """ - The unicode version for this emoji + The Unicode version for this emoji. """ unicodeVersion: String! """ - The user who awarded the emoji + The user who awarded the emoji. """ user: User! } @@ -1122,7 +1263,7 @@ input AwardEmojiAddInput { clientMutationId: String """ - The emoji name + The emoji name. """ name: String! } @@ -1148,6 +1289,41 @@ type AwardEmojiAddPayload { } """ +The connection type for AwardEmoji. +""" +type AwardEmojiConnection { + """ + A list of edges. + """ + edges: [AwardEmojiEdge] + + """ + A list of nodes. + """ + nodes: [AwardEmoji] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type AwardEmojiEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: AwardEmoji +} + +""" Autogenerated input type of AwardEmojiRemove """ input AwardEmojiRemoveInput { @@ -1162,7 +1338,7 @@ input AwardEmojiRemoveInput { clientMutationId: String """ - The emoji name + The emoji name. """ name: String! } @@ -1202,7 +1378,7 @@ input AwardEmojiToggleInput { clientMutationId: String """ - The emoji name + The emoji name. """ name: String! } @@ -1233,18 +1409,18 @@ type AwardEmojiTogglePayload { } """ -Identifier of Awardable +Identifier of Awardable. """ scalar AwardableID type BaseService implements Service { """ - Indicates if the service is active + Indicates if the service is active. """ active: Boolean """ - Class name of the service + Class name of the service. """ type: String } @@ -1257,52 +1433,52 @@ scalar BigInt type Blob implements Entry { """ - Flat path of the entry + Flat path of the entry. """ flatPath: String! """ - ID of the entry + ID of the entry. """ id: ID! """ - LFS ID of the blob + LFS ID of the blob. """ lfsOid: String """ - Blob mode in numeric format + Blob mode in numeric format. """ mode: String """ - Name of the entry + Name of the entry. """ name: String! """ - Path of the entry + Path of the entry. """ path: String! """ - Last commit sha for the entry + Last commit SHA for the entry. """ sha: String! """ - Type of tree entry + Type of tree entry. """ type: EntryType! """ - Web path of the blob + Web path of the blob. """ webPath: String """ - Web URL of the blob + Web URL of the blob. """ webUrl: String } @@ -1356,12 +1532,12 @@ Represents a project or group board """ type Board { """ - The board assignee + The board assignee. """ assignee: User """ - Epics associated with board issues + Epics associated with board issues. """ epics( """ @@ -1391,17 +1567,17 @@ type Board { ): BoardEpicConnection """ - Whether or not backlog list is hidden + Whether or not backlog list is hidden. """ hideBacklogList: Boolean """ - Whether or not closed list is hidden + Whether or not closed list is hidden. """ hideClosedList: Boolean """ - ID (global ID) of the board + ID (global ID) of the board. """ id: ID! @@ -1411,7 +1587,7 @@ type Board { iteration: Iteration """ - Labels of the board + Labels of the board. """ labels( """ @@ -1436,7 +1612,7 @@ type Board { ): LabelConnection """ - Lists of the board + Lists of the board. """ lists( """ @@ -1471,12 +1647,12 @@ type Board { ): BoardListConnection """ - The board milestone + The board milestone. """ milestone: Milestone """ - Name of the board + Name of the board. """ name: String @@ -1491,7 +1667,7 @@ type Board { webUrl: String! """ - Weight of the board + Weight of the board. """ weight: Int } @@ -1534,14 +1710,39 @@ type BoardEdge { """ Represents an epic on an issue board """ -type BoardEpic implements CurrentUserTodos & Noteable { +type BoardEpic implements CurrentUserTodos & Eventable & Noteable { """ - Author of the epic + Author of the epic. """ author: User! """ - Children (sub-epics) of the epic + A list of award emojis associated with the epic. + """ + awardEmoji( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): AwardEmojiConnection + + """ + Children (sub-epics) of the epic. """ children( """ @@ -1639,22 +1840,22 @@ type BoardEpic implements CurrentUserTodos & Noteable { ): EpicConnection """ - Timestamp of when the epic was closed + Timestamp of when the epic was closed. """ closedAt: Time """ - Indicates if the epic is confidential + Indicates if the epic is confidential. """ confidential: Boolean """ - Timestamp of when the epic was created + Timestamp of when the epic was created. """ createdAt: Time """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -1678,28 +1879,28 @@ type BoardEpic implements CurrentUserTodos & Noteable { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! """ - Number of open and closed descendant epics and issues + Number of open and closed descendant epics and issues. """ descendantCounts: EpicDescendantCount """ - Total weight of open and closed issues in the epic and its descendants + Total weight of open and closed issues in the epic and its descendants. """ descendantWeightSum: EpicDescendantWeights """ - Description of the epic + Description of the epic. """ description: String """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -1724,67 +1925,92 @@ type BoardEpic implements CurrentUserTodos & Noteable { ): DiscussionConnection! """ - Number of downvotes the epic has received + Number of downvotes the epic has received. """ downvotes: Int! """ - Due date of the epic + Due date of the epic. """ dueDate: Time """ - Fixed due date of the epic + Fixed due date of the epic. """ dueDateFixed: Time """ - Inherited due date of the epic from milestones + Inherited due date of the epic from milestones. """ dueDateFromMilestones: Time """ - Indicates if the due date has been manually set + Indicates if the due date has been manually set. """ dueDateIsFixed: Boolean """ - Group to which the epic belongs + A list of events associated with the object. + """ + events( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): EventConnection + + """ + Group to which the epic belongs. """ group: Group! """ - Indicates if the epic has children + Indicates if the epic has children. """ hasChildren: Boolean! """ - Indicates if the epic has direct issues + Indicates if the epic has direct issues. """ hasIssues: Boolean! """ - Indicates if the epic has a parent epic + Indicates if the epic has a parent epic. """ hasParent: Boolean! """ - Current health status of the epic + Current health status of the epic. """ healthStatus: EpicHealthStatus """ - ID of the epic + ID of the epic. """ id: ID! """ - Internal ID of the epic + Internal ID of the epic. """ iid: ID! """ - A list of issues associated with the epic + A list of issues associated with the epic. """ issues( """ @@ -1809,7 +2035,7 @@ type BoardEpic implements CurrentUserTodos & Noteable { ): EpicIssueConnection """ - Labels assigned to the epic + Labels assigned to the epic. """ labels( """ @@ -1834,7 +2060,7 @@ type BoardEpic implements CurrentUserTodos & Noteable { ): LabelConnection """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -1859,12 +2085,12 @@ type BoardEpic implements CurrentUserTodos & Noteable { ): NoteConnection! """ - Parent epic of the epic + Parent epic of the epic. """ parent: Epic """ - List of participants for the epic + List of participants for the epic. """ participants( """ @@ -1889,77 +2115,77 @@ type BoardEpic implements CurrentUserTodos & Noteable { ): UserConnection """ - Internal reference of the epic. Returned in shortened format by default + Internal reference of the epic. Returned in shortened format by default. """ reference( """ - Indicates if the reference should be returned in full + Indicates if the reference should be returned in full. """ full: Boolean = false ): String! """ - URI path of the epic-issue relationship + URI path of the epic-issue relationship. """ relationPath: String """ - The relative position of the epic in the epic tree + The relative position of the epic in the epic tree. """ relativePosition: Int """ - Start date of the epic + Start date of the epic. """ startDate: Time """ - Fixed start date of the epic + Fixed start date of the epic. """ startDateFixed: Time """ - Inherited start date of the epic from milestones + Inherited start date of the epic from milestones. """ startDateFromMilestones: Time """ - Indicates if the start date has been manually set + Indicates if the start date has been manually set. """ startDateIsFixed: Boolean """ - State of the epic + State of the epic. """ state: EpicState! """ - Indicates the currently logged in user is subscribed to the epic + Indicates the currently logged in user is subscribed to the epic. """ subscribed: Boolean! """ - Title of the epic + Title of the epic. """ title: String """ - Timestamp of when the epic was updated + Timestamp of when the epic was updated. """ updatedAt: Time """ - Number of upvotes the epic has received + Number of upvotes the epic has received. """ upvotes: Int! """ - Number of user discussions in the epic + Number of user discussions in the epic. """ userDiscussionsCount: Int! """ - Number of user notes of the epic + Number of user notes of the epic. """ userNotesCount: Int! @@ -1969,17 +2195,17 @@ type BoardEpic implements CurrentUserTodos & Noteable { userPermissions: EpicPermissions! """ - User preferences for the epic on the issue board + User preferences for the epic on the issue board. """ userPreferences: BoardEpicUserPreferences """ - Web path of the epic + Web path of the epic. """ webPath: String! """ - Web URL of the epic + Web URL of the epic. """ webUrl: String! } @@ -2024,79 +2250,79 @@ Represents user preferences for a board epic """ type BoardEpicUserPreferences { """ - Indicates epic should be displayed as collapsed + Indicates epic should be displayed as collapsed. """ collapsed: Boolean! } """ -Identifier of Board +Identifier of Board. """ scalar BoardID input BoardIssueInput { """ - Filter by assignee username + Filter by assignee username. """ assigneeUsername: [String] """ - Filter by author username + Filter by author username. """ authorUsername: String """ - Filter by epic ID. Incompatible with epicWildcardId + Filter by epic ID. Incompatible with epicWildcardId. """ epicId: EpicID """ - Filter by epic ID wildcard. Incompatible with epicId + Filter by epic ID wildcard. Incompatible with epicId. """ epicWildcardId: EpicWildcardId """ - Filter by iteration title + Filter by iteration title. """ iterationTitle: String """ - Filter by iteration ID wildcard + Filter by iteration ID wildcard. """ iterationWildcardId: IterationWildcardId """ - Filter by label name + Filter by label name. """ labelName: [String] """ - Filter by milestone title + Filter by milestone title. """ milestoneTitle: String """ - Filter by reaction emoji + Filter by reaction emoji. """ myReactionEmoji: String """ - List of negated params. Warning: this argument is experimental and a subject to change in future + List of negated params. Warning: this argument is experimental and a subject to change in future. """ not: NegatedBoardIssueInput """ - Filter by release tag + Filter by release tag. """ releaseTag: String """ - Search query for issue title or description + Search query for issue title or description. """ search: String """ - Filter by weight + Filter by weight. """ weight: String } @@ -2106,22 +2332,22 @@ Represents a list for an issue board """ type BoardList { """ - Assignee in the list + Assignee in the list. """ assignee: User """ - Indicates if list is collapsed for this user + Indicates if list is collapsed for this user. """ collapsed: Boolean """ - ID (global ID) of the list + ID (global ID) of the list. """ id: ID! """ - Board issues + Board issues. """ issues( """ @@ -2151,57 +2377,57 @@ type BoardList { ): IssueConnection """ - Count of issues in the list + Count of issues in the list. """ issuesCount: Int """ - Iteration of the list + Iteration of the list. """ iteration: Iteration """ - Label of the list + Label of the list. """ label: Label """ - The current limit metric for the list + The current limit metric for the list. """ limitMetric: ListLimitMetric """ - Type of the list + Type of the list. """ listType: String! """ - Maximum number of issues in the list + Maximum number of issues in the list. """ maxIssueCount: Int """ - Maximum weight of issues in the list + Maximum weight of issues in the list. """ maxIssueWeight: Int """ - Milestone of the list + Milestone of the list. """ milestone: Milestone """ - Position of list within the board + Position of list within the board. """ position: Int """ - Title of the list + Title of the list. """ title: String! """ - Total weight of all issues in the list + Total weight of all issues in the list. """ totalWeight: Int } @@ -2281,7 +2507,7 @@ type BoardListCreatePayload { errors: [String!]! """ - List of the issue board. + Issue list in the issue board. """ list: BoardList } @@ -2352,23 +2578,23 @@ type BoardListUpdateLimitMetricsPayload { } """ -Identifier of Boards::EpicBoard +Identifier of Boards::EpicBoard. """ scalar BoardsEpicBoardID """ -Identifier of Boards::EpicList +Identifier of Boards::EpicList. """ scalar BoardsEpicListID type Branch { """ - Commit for the branch + Commit for the branch. """ commit: Commit """ - Name of the branch + Name of the branch. """ name: String! } @@ -2378,31 +2604,38 @@ Represents the total number of issues and their weights for a particular day """ type BurnupChartDailyTotals { """ - Number of closed issues as of this day + Number of closed issues as of this day. """ completedCount: Int! """ - Total weight of closed issues as of this day + Total weight of closed issues as of this day. """ completedWeight: Int! """ - Date for burnup totals + Date for burnup totals. """ date: ISO8601Date! """ - Number of issues as of this day + Number of issues as of this day. """ scopeCount: Int! """ - Total weight of issues as of this day + Total weight of issues as of this day. """ scopeWeight: Int! } +type CiApplicationSettings { + """ + Whether to keep the latest jobs artifacts. + """ + keepLatestArtifact: Boolean +} + type CiBuildNeed { """ Name of the job we need to complete. @@ -2482,17 +2715,17 @@ type CiCdSettingsUpdatePayload { type CiConfig { """ - Linting errors + Linting errors. """ errors: [String!] """ - Merged CI config YAML + Merged CI configuration YAML. """ mergedYaml: String """ - Stages of the pipeline + Stages of the pipeline. """ stages( """ @@ -2517,14 +2750,14 @@ type CiConfig { ): CiConfigStageConnection """ - Status of linting, can be either valid or invalid + Status of linting, can be either valid or invalid. """ status: CiConfigStatus } type CiConfigGroup { """ - Jobs in group + Jobs in group. """ jobs( """ @@ -2549,12 +2782,12 @@ type CiConfigGroup { ): CiConfigJobConnection """ - Name of the job group + Name of the job group. """ name: String """ - Size of the job group + Size of the job group. """ size: Int } @@ -2725,7 +2958,7 @@ type CiConfigJobRestriction { type CiConfigNeed { """ - Name of the need + Name of the need. """ name: String } @@ -2767,7 +3000,7 @@ type CiConfigNeedEdge { type CiConfigStage { """ - Groups of jobs for the stage + Groups of jobs for the stage. """ groups( """ @@ -2792,7 +3025,7 @@ type CiConfigStage { ): CiConfigGroupConnection """ - Name of the stage + Name of the stage. """ name: String } @@ -2849,12 +3082,12 @@ enum CiConfigStatus { type CiGroup { """ - Detailed status of the group + Detailed status of the group. """ detailedStatus: DetailedStatus """ - Jobs in group + Jobs in group. """ jobs( """ @@ -2879,12 +3112,12 @@ type CiGroup { ): CiJobConnection """ - Name of the job group + Name of the job group. """ name: String """ - Size of the group + Size of the group. """ size: Int } @@ -2926,7 +3159,7 @@ type CiGroupEdge { type CiJob { """ - Artifacts generated by the job + Artifacts generated by the job. """ artifacts( """ @@ -2951,17 +3184,17 @@ type CiJob { ): CiJobArtifactConnection """ - Detailed status of the job + Detailed status of the job. """ detailedStatus: DetailedStatus """ - Name of the job + Name of the job. """ name: String """ - References to builds that must complete before the jobs run + References to builds that must complete before the jobs run. """ needs( """ @@ -2986,24 +3219,24 @@ type CiJob { ): CiBuildNeedConnection """ - Pipeline the job belongs to + Pipeline the job belongs to. """ pipeline: Pipeline """ - Schedule for the build + Schedule for the build. """ scheduledAt: Time } type CiJobArtifact { """ - URL for downloading the artifact's file + URL for downloading the artifact's file. """ downloadPath: String """ - File type of the artifact + File type of the artifact. """ fileType: JobArtifactFileType } @@ -3079,18 +3312,18 @@ type CiJobEdge { } """ -Identifier of Ci::Pipeline +Identifier of Ci::Pipeline. """ scalar CiPipelineID type CiStage { """ - Detailed status of the stage + Detailed status of the stage. """ detailedStatus: DetailedStatus """ - Group of jobs for the stage + Group of jobs for the stage. """ groups( """ @@ -3115,7 +3348,7 @@ type CiStage { ): CiGroupConnection """ - Name of the stage + Name of the stage. """ name: String } @@ -3157,27 +3390,32 @@ type CiStageEdge { type ClusterAgent { """ - Timestamp the cluster agent was created + Timestamp the cluster agent was created. """ createdAt: Time """ - ID of the cluster agent + User object, containing information about the person who created the agent. + """ + createdByUser: User + + """ + ID of the cluster agent. """ id: ID! """ - Name of the cluster agent + Name of the cluster agent. """ name: String """ - The project this cluster agent is associated with + The project this cluster agent is associated with. """ project: Project """ - Tokens associated with the cluster agent + Tokens associated with the cluster agent. """ tokens( """ @@ -3202,7 +3440,7 @@ type ClusterAgent { ): ClusterAgentTokenConnection """ - Timestamp the cluster agent was updated + Timestamp the cluster agent was updated. """ updatedAt: Time } @@ -3212,7 +3450,7 @@ The connection type for ClusterAgent. """ type ClusterAgentConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -3279,17 +3517,22 @@ type ClusterAgentEdge { type ClusterAgentToken { """ - Cluster agent this token is associated with + Cluster agent this token is associated with. """ clusterAgent: ClusterAgent """ - Timestamp the token was created + Timestamp the token was created. """ createdAt: Time """ - Global ID of the token + The user who created the token. + """ + createdByUser: User + + """ + Global ID of the token. """ id: ClustersAgentTokenID! } @@ -3299,7 +3542,7 @@ The connection type for ClusterAgentToken. """ type ClusterAgentTokenConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -3405,17 +3648,17 @@ type ClusterAgentTokenEdge { } """ -Identifier of Clusters::Agent +Identifier of Clusters::Agent. """ scalar ClustersAgentID """ -Identifier of Clusters::AgentToken +Identifier of Clusters::AgentToken. """ scalar ClustersAgentTokenID """ -Identifier of Clusters::Cluster +Identifier of Clusters::Cluster. """ scalar ClustersClusterID @@ -3501,27 +3744,27 @@ type CodeCoverageSummary { type Commit { """ - Author of the commit + Author of the commit. """ author: User """ - Commit authors gravatar + Commit authors gravatar. """ authorGravatar: String """ - Commit authors name + Commit authors name. """ authorName: String """ - Timestamp of when the commit was authored + Timestamp of when the commit was authored. """ authoredDate: Time """ - Description of the commit message + Description of the commit message. """ description: String @@ -3531,17 +3774,17 @@ type Commit { descriptionHtml: String """ - ID (global ID) of the commit + ID (global ID) of the commit. """ id: ID! """ - Raw commit message + Raw commit message. """ message: String """ - Pipelines of the commit ordered latest first + Pipelines of the commit ordered latest first. """ pipelines( """ @@ -3581,22 +3824,22 @@ type Commit { ): PipelineConnection """ - SHA1 ID of the commit + SHA1 ID of the commit. """ sha: String! """ - Short SHA1 ID of the commit + Short SHA1 ID of the commit. """ shortId: String! """ - Rendered HTML of the commit signature + Rendered HTML of the commit signature. """ signatureHtml: String """ - Title of the commit message + Title of the commit message. """ title: String @@ -3606,49 +3849,49 @@ type Commit { titleHtml: String """ - Web path of the commit + Web path of the commit. """ webPath: String! """ - Web URL of the commit + Web URL of the commit. """ webUrl: String! } input CommitAction { """ - The action to perform, create, delete, move, update, chmod + The action to perform, create, delete, move, update, chmod. """ action: CommitActionMode! """ - Content of the file + Content of the file. """ content: String """ - Encoding of the file. Default is text + Encoding of the file. Default is text. """ encoding: CommitEncoding """ - Enables/disables the execute flag on the file + Enables/disables the execute flag on the file. """ executeFilemode: Boolean """ - Full path to the file + Full path to the file. """ filePath: String! """ - Last known file commit ID + Last known file commit ID. """ lastCommitId: String """ - Original full path to the file being moved + Original full path to the file being moved. """ previousPath: String } @@ -3723,7 +3966,7 @@ input CommitCreateInput { clientMutationId: String """ - Raw commit message + Raw commit message. """ message: String! @@ -3790,24 +4033,30 @@ Represents a ComplianceFramework associated with a Project """ type ComplianceFramework { """ - Hexadecimal representation of compliance framework's label color + Hexadecimal representation of compliance framework's label color. """ color: String! """ - Description of the compliance framework + Description of the compliance framework. """ description: String! """ - Compliance framework ID + Compliance framework ID. """ id: ID! """ - Name of the compliance framework + Name of the compliance framework. """ name: String! + + """ + Full path of the compliance pipeline configuration stored in a project + repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`. + """ + pipelineConfigurationFullPath: String } """ @@ -3860,14 +4109,35 @@ input ComplianceFrameworkInput { New name for the compliance framework. """ name: String + + """ + Full path of the compliance pipeline configuration stored in a project + repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`. + """ + pipelineConfigurationFullPath: String } """ -Identifier of ComplianceManagement::Framework +Identifier of ComplianceManagement::Framework. """ scalar ComplianceManagementFrameworkID """ +Composer metadata +""" +type ComposerMetadata { + """ + Data of the Composer JSON file. + """ + composerJson: PackageComposerJsonType! + + """ + Target SHA of the package. + """ + targetSha: String! +} + +""" Autogenerated input type of ConfigureSast """ input ConfigureSastInput { @@ -3917,47 +4187,47 @@ A tag expiration policy designed to keep only the images that matter most """ type ContainerExpirationPolicy { """ - This container expiration policy schedule + This container expiration policy schedule. """ cadence: ContainerExpirationPolicyCadenceEnum! """ - Timestamp of when the container expiration policy was created + Timestamp of when the container expiration policy was created. """ createdAt: Time! """ - Indicates whether this container expiration policy is enabled + Indicates whether this container expiration policy is enabled. """ enabled: Boolean! """ - Number of tags to retain + Number of tags to retain. """ keepN: ContainerExpirationPolicyKeepEnum """ - Tags with names matching this regex pattern will expire + Tags with names matching this regex pattern will expire. """ nameRegex: UntrustedRegexp """ - Tags with names matching this regex pattern will be preserved + Tags with names matching this regex pattern will be preserved. """ nameRegexKeep: UntrustedRegexp """ - Next time that this container expiration policy will get executed + Next time that this container expiration policy will get executed. """ nextRunAt: Time """ - Tags older that this will expire + Tags older that this will expire. """ olderThan: ContainerExpirationPolicyOlderThanEnum """ - Timestamp of when the container expiration policy was updated + Timestamp of when the container expiration policy was updated. """ updatedAt: Time! } @@ -4088,7 +4358,7 @@ type ContainerRepository { path: String! """ - Project of the container registry + Project of the container registry. """ project: Project! @@ -4198,7 +4468,7 @@ type ContainerRepositoryDetails { path: String! """ - Project of the container registry + Project of the container registry. """ project: Project! @@ -4208,7 +4478,7 @@ type ContainerRepositoryDetails { status: ContainerRepositoryStatus """ - Tags of the container repository + Tags of the container repository. """ tags( """ @@ -4259,11 +4529,66 @@ type ContainerRepositoryEdge { } """ -Identifier of ContainerRepository +Identifier of ContainerRepository. """ scalar ContainerRepositoryID """ +Values for sorting container repositories +""" +enum ContainerRepositorySort { + """ + Created at ascending order + """ + CREATED_ASC + + """ + Created at descending order + """ + CREATED_DESC + + """ + Name by ascending order + """ + NAME_ASC + + """ + Name by descending order + """ + NAME_DESC + + """ + Updated at ascending order + """ + UPDATED_ASC + + """ + Updated at descending order + """ + UPDATED_DESC + + """ + Created at ascending order + """ + created_asc @deprecated(reason: "Use CREATED_ASC. Deprecated in 13.5.") + + """ + Created at descending order + """ + created_desc @deprecated(reason: "Use CREATED_DESC. Deprecated in 13.5.") + + """ + Updated at ascending order + """ + updated_asc @deprecated(reason: "Use UPDATED_ASC. Deprecated in 13.5.") + + """ + Updated at descending order + """ + updated_desc @deprecated(reason: "Use UPDATED_DESC. Deprecated in 13.5.") +} + +""" Status of a container repository """ enum ContainerRepositoryStatus { @@ -4408,7 +4733,7 @@ type CreateAlertIssuePayload { issue: Issue """ - The todo after mutation. + The to-do item after mutation. """ todo: Todo } @@ -4488,17 +4813,17 @@ input CreateBoardInput { clientMutationId: String """ - The group full path the resource is associated with. + Full path of the group with which the resource is associated. """ groupPath: ID """ - Whether or not backlog list is hidden + Whether or not backlog list is hidden. """ hideBacklogList: Boolean """ - Whether or not closed list is hidden + Whether or not closed list is hidden. """ hideClosedList: Boolean @@ -4513,7 +4838,7 @@ input CreateBoardInput { labelIds: [LabelID!] """ - Labels of the issue + Labels of the issue. """ labels: [String!] @@ -4528,7 +4853,7 @@ input CreateBoardInput { name: String """ - The project full path the resource is associated with. + Full path of the project with which the resource is associated. """ projectPath: ID @@ -4738,14 +5063,9 @@ input CreateDevopsAdoptionSegmentInput { clientMutationId: String """ - The array of group IDs to set for the segment. + Namespace ID to set for the segment. """ - groupIds: [GroupID!] - - """ - Name of the segment. - """ - name: String! + namespaceId: NamespaceID! } """ @@ -4773,7 +5093,7 @@ Autogenerated input type of CreateDiffNote """ input CreateDiffNoteInput { """ - Content of the note + Content of the note. """ body: String! @@ -4793,7 +5113,7 @@ input CreateDiffNoteInput { noteableId: NoteableID! """ - The position of this note on a diff + The position of this note on a diff. """ position: DiffPositionInput! } @@ -4903,7 +5223,7 @@ Autogenerated input type of CreateImageDiffNote """ input CreateImageDiffNoteInput { """ - Content of the note + Content of the note. """ body: String! @@ -4923,7 +5243,7 @@ input CreateImageDiffNoteInput { noteableId: NoteableID! """ - The position of this note on a diff + The position of this note on a diff. """ position: DiffImagePositionInput! } @@ -4963,7 +5283,7 @@ input CreateIssueInput { clientMutationId: String """ - Indicates the issue is confidential + Indicates the issue is confidential. """ confidential: Boolean @@ -4973,7 +5293,7 @@ input CreateIssueInput { createdAt: Time """ - Description of the issue + Description of the issue. """ description: String @@ -4983,7 +5303,7 @@ input CreateIssueInput { discussionToResolve: String """ - Due date of the issue + Due date of the issue. """ dueDate: ISO8601Date @@ -5008,12 +5328,12 @@ input CreateIssueInput { labelIds: [LabelID!] """ - Labels of the issue + Labels of the issue. """ labels: [String!] """ - Indicates discussion is locked on the issue + Indicates discussion is locked on the issue. """ locked: Boolean @@ -5033,7 +5353,7 @@ input CreateIssueInput { projectPath: ID! """ - Title of the issue + Title of the issue. """ title: String! @@ -5083,12 +5403,12 @@ input CreateIterationInput { dueDate: String """ - The target group for the iteration. + Full path of the group with which the resource is associated. """ groupPath: ID """ - The target project for the iteration. + Full path of the project with which the resource is associated. """ projectPath: ID @@ -5128,7 +5448,7 @@ Autogenerated input type of CreateNote """ input CreateNoteInput { """ - Content of the note + Content of the note. """ body: String! @@ -5228,6 +5548,13 @@ input CreateSnippetInput { blobActions: [SnippetBlobActionInputType!] """ + A valid CAPTCHA response value obtained by using the provided captchaSiteKey + with a CAPTCHA API to present a challenge to be solved on the client. Required + to resubmit if the previous operation returned "NeedsCaptchaResponse: true". + """ + captchaResponse: String + + """ A unique identifier for the client performing the mutation. """ clientMutationId: String @@ -5243,6 +5570,13 @@ input CreateSnippetInput { projectPath: ID """ + The spam log ID which must be passed along with a valid CAPTCHA response for + the operation to be completed. Required to resubmit if the previous operation + returned "NeedsCaptchaResponse: true". + """ + spamLogId: Int + + """ Title of the snippet. """ title: String! @@ -5263,6 +5597,13 @@ Autogenerated return type of CreateSnippet """ type CreateSnippetPayload { """ + The CAPTCHA site key which must be used to render a challenge for the user to + solve to obtain a valid captchaResponse value. Included only when an operation + was not completed because "NeedsCaptchaResponse" is true. + """ + captchaSiteKey: String + + """ A unique identifier for the client performing the mutation. """ clientMutationId: String @@ -5273,14 +5614,31 @@ type CreateSnippetPayload { errors: [String!]! """ + Indicates whether the operation was detected as possible spam and not + completed. If CAPTCHA is enabled, the request must be resubmitted with a valid + CAPTCHA response and spam_log_id included for the operation to be completed. + Included only when an operation was not completed because + "NeedsCaptchaResponse" is true. + """ + needsCaptchaResponse: Boolean + + """ The snippet after mutation. """ snippet: Snippet """ - Indicates whether the operation returns a record detected as spam. + Indicates whether the operation was detected as definite spam. There is no + option to resubmit the request with a CAPTCHA response. """ spam: Boolean + + """ + The spam log ID which must be passed along with a valid CAPTCHA response for + an operation to be completed. Included only when an operation was not + completed because "NeedsCaptchaResponse" is true. + """ + spamLogId: Int } """ @@ -5335,7 +5693,7 @@ type CreateTestCasePayload { interface CurrentUserTodos { """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -5359,7 +5717,7 @@ interface CurrentUserTodos { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! @@ -5370,22 +5728,22 @@ A custom emoji uploaded by user """ type CustomEmoji { """ - Whether the emoji is an external link + Whether the emoji is an external link. """ external: Boolean! """ - The ID of the emoji + The ID of the emoji. """ id: CustomEmojiID! """ - The name of the emoji + The name of the emoji. """ name: String! """ - The link to file of the emoji + The link to file of the emoji. """ url: String! } @@ -5426,7 +5784,7 @@ type CustomEmojiEdge { } """ -Identifier of CustomEmoji +Identifier of CustomEmoji. """ scalar CustomEmojiID @@ -5475,6 +5833,288 @@ type DastOnDemandScanCreatePayload { pipelineUrl: String } +""" +Represents a DAST Profile +""" +type DastProfile { + """ + The associated scanner profile. + """ + dastScannerProfile: DastScannerProfile + + """ + The associated site profile. + """ + dastSiteProfile: DastSiteProfile + + """ + The description of the scan. + """ + description: String + + """ + Relative web path to the edit page of a profile. + """ + editPath: String + + """ + ID of the profile. + """ + id: DastProfileID! + + """ + The name of the profile. + """ + name: String +} + +""" +The connection type for DastProfile. +""" +type DastProfileConnection { + """ + A list of edges. + """ + edges: [DastProfileEdge] + + """ + A list of nodes. + """ + nodes: [DastProfile] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +Autogenerated input type of DastProfileCreate +""" +input DastProfileCreateInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + ID of the scanner profile to be associated. + """ + dastScannerProfileId: DastScannerProfileID! + + """ + ID of the site profile to be associated. + """ + dastSiteProfileId: DastSiteProfileID! + + """ + The description of the profile. Defaults to an empty string. + """ + description: String = "" + + """ + The project the profile belongs to. + """ + fullPath: ID! + + """ + The name of the profile. + """ + name: String! + + """ + Run scan using profile after creation. Defaults to false. + """ + runAfterCreate: Boolean = false +} + +""" +Autogenerated return type of DastProfileCreate +""" +type DastProfileCreatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The created profile. + """ + dastProfile: DastProfile + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. + """ + pipelineUrl: String +} + +""" +Autogenerated input type of DastProfileDelete +""" +input DastProfileDeleteInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + ID of the profile to be deleted. + """ + id: DastProfileID! +} + +""" +Autogenerated return type of DastProfileDelete +""" +type DastProfileDeletePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! +} + +""" +An edge in a connection. +""" +type DastProfileEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: DastProfile +} + +""" +Identifier of Dast::Profile. +""" +scalar DastProfileID + +""" +Autogenerated input type of DastProfileRun +""" +input DastProfileRunInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Full path for the project the scanner profile belongs to. + """ + fullPath: ID! + + """ + ID of the profile to be used for the scan. + """ + id: DastProfileID! +} + +""" +Autogenerated return type of DastProfileRun +""" +type DastProfileRunPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + URL of the pipeline that was created. + """ + pipelineUrl: String +} + +""" +Autogenerated input type of DastProfileUpdate +""" +input DastProfileUpdateInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + ID of the scanner profile to be associated. + """ + dastScannerProfileId: DastScannerProfileID + + """ + ID of the site profile to be associated. + """ + dastSiteProfileId: DastSiteProfileID + + """ + The description of the profile. Defaults to an empty string. + """ + description: String = "" + + """ + The project the profile belongs to. + """ + fullPath: ID! + + """ + ID of the profile to be deleted. + """ + id: DastProfileID! + + """ + The name of the profile. + """ + name: String + + """ + Run scan using profile after update. Defaults to false. + """ + runAfterUpdate: Boolean = false +} + +""" +Autogenerated return type of DastProfileUpdate +""" +type DastProfileUpdatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The updated profile. + """ + dastProfile: DastProfile + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + The URL of the pipeline that was created. Requires the input argument + `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no + pipeline will be created. + """ + pipelineUrl: String +} + enum DastScanTypeEnum { """ Active DAST scan. This scan will make active attacks against the target site. @@ -5492,22 +6132,22 @@ Represents a DAST scanner profile """ type DastScannerProfile { """ - Relative web path to the edit page of a scanner profile + Relative web path to the edit page of a scanner profile. """ editPath: String """ - ID of the DAST scanner profile Deprecated in 13.6: Use `id`. + ID of the DAST scanner profile. Deprecated in 13.6: Use `id`. """ globalId: DastScannerProfileID! @deprecated(reason: "Use `id`. Deprecated in 13.6.") """ - ID of the DAST scanner profile + ID of the DAST scanner profile. """ id: DastScannerProfileID! """ - Name of the DAST scanner profile + Name of the DAST scanner profile. """ profileName: String @@ -5522,12 +6162,12 @@ type DastScannerProfile { showDebugMessages: Boolean! """ - The maximum number of minutes allowed for the spider to traverse the site + The maximum number of minutes allowed for the spider to traverse the site. """ spiderTimeout: Int """ - The maximum number of seconds allowed for the site under test to respond to a request + The maximum number of seconds allowed for the site under test to respond to a request. """ targetTimeout: Int @@ -5682,7 +6322,7 @@ type DastScannerProfileEdge { } """ -Identifier of DastScannerProfile +Identifier of DastScannerProfile. """ scalar DastScannerProfileID @@ -5763,27 +6403,27 @@ Represents a DAST Site Profile """ type DastSiteProfile { """ - Relative web path to the edit page of a site profile + Relative web path to the edit page of a site profile. """ editPath: String """ - ID of the site profile + ID of the site profile. """ id: DastSiteProfileID! """ - Normalized URL of the target to be scanned + Normalized URL of the target to be scanned. """ normalizedTargetUrl: String """ - The name of the site profile + The name of the site profile. """ profileName: String """ - The URL of the target to be scanned + The URL of the target to be scanned. """ targetUrl: String @@ -5793,7 +6433,7 @@ type DastSiteProfile { userPermissions: DastSiteProfilePermissions! """ - The current validation status of the site profile + The current validation status of the site profile. """ validationStatus: DastSiteProfileValidationStatusEnum } @@ -5914,7 +6554,7 @@ type DastSiteProfileEdge { } """ -Identifier of DastSiteProfile +Identifier of DastSiteProfile. """ scalar DastSiteProfileID @@ -6056,7 +6696,7 @@ type DastSiteTokenCreatePayload { } """ -Identifier of DastSiteToken +Identifier of DastSiteToken. """ scalar DastSiteTokenID @@ -6065,17 +6705,17 @@ Represents a DAST Site Validation """ type DastSiteValidation { """ - Global ID of the site validation + Global ID of the site validation. """ id: DastSiteValidationID! """ - Normalized URL of the target to be validated + Normalized URL of the target to be validated. """ normalizedTargetUrl: String """ - Status of the site validation + Status of the site validation. """ status: DastSiteProfileValidationStatusEnum! } @@ -6171,10 +6811,45 @@ type DastSiteValidationEdge { } """ -Identifier of DastSiteValidation +Identifier of DastSiteValidation. """ scalar DastSiteValidationID +""" +Autogenerated input type of DastSiteValidationRevoke +""" +input DastSiteValidationRevokeInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The project the site validation belongs to. + """ + fullPath: ID! + + """ + Normalized URL of the target to be revoked. + """ + normalizedTargetUrl: String! +} + +""" +Autogenerated return type of DastSiteValidationRevoke +""" +type DastSiteValidationRevokePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! +} + enum DastSiteValidationStrategyEnum { """ Header validation @@ -6347,17 +7022,17 @@ The response from the AdminSidekiqQueuesDeleteJobs mutation """ type DeleteJobsResponse { """ - Whether or not the entire queue was processed in time; if not, retrying the same request is safe + Whether or not the entire queue was processed in time; if not, retrying the same request is safe. """ completed: Boolean """ - The number of matching jobs deleted + The number of matching jobs deleted. """ deletedJobs: Int """ - The queue size after processing + The queue size after processing. """ queueSize: Int } @@ -6367,7 +7042,7 @@ A single design """ type Design implements CurrentUserTodos & DesignFields & Noteable { """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -6391,18 +7066,18 @@ type Design implements CurrentUserTodos & DesignFields & Noteable { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! """ - The diff refs for this design + The diff refs for this design. """ diffRefs: DiffRefs! """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -6427,27 +7102,27 @@ type Design implements CurrentUserTodos & DesignFields & Noteable { ): DiscussionConnection! """ - How this design was changed in the current version + How this design was changed in the current version. """ event: DesignVersionEvent! """ - The filename of the design + The filename of the design. """ filename: String! """ - The full path to the design file + The full path to the design file. """ fullPath: String! """ - The ID of this design + The ID of this design. """ id: ID! """ - The URL of the full-sized image + The URL of the full-sized image. """ image: String! @@ -6457,12 +7132,12 @@ type Design implements CurrentUserTodos & DesignFields & Noteable { imageV432x230: String """ - The issue the design belongs to + The issue the design belongs to. """ issue: Issue! """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -6487,17 +7162,17 @@ type Design implements CurrentUserTodos & DesignFields & Noteable { ): NoteConnection! """ - The total count of user-created notes for this design + The total count of user-created notes for this design. """ notesCount: Int! """ - The project the design belongs to + The project the design belongs to. """ project: Project! """ - All versions related to this design ordered newest first + All versions related to this design ordered newest first. """ versions( """ @@ -6537,37 +7212,37 @@ A design pinned to a specific version. The image field reflects the design as of """ type DesignAtVersion implements DesignFields { """ - The underlying design + The underlying design. """ design: Design! """ - The diff refs for this design + The diff refs for this design. """ diffRefs: DiffRefs! """ - How this design was changed in the current version + How this design was changed in the current version. """ event: DesignVersionEvent! """ - The filename of the design + The filename of the design. """ filename: String! """ - The full path to the design file + The full path to the design file. """ fullPath: String! """ - The ID of this design + The ID of this design. """ id: ID! """ - The URL of the full-sized image + The URL of the full-sized image. """ image: String! @@ -6577,22 +7252,22 @@ type DesignAtVersion implements DesignFields { imageV432x230: String """ - The issue the design belongs to + The issue the design belongs to. """ issue: Issue! """ - The total count of user-created notes for this design + The total count of user-created notes for this design. """ notesCount: Int! """ - The project the design belongs to + The project the design belongs to. """ project: Project! """ - The version this design-at-versions is pinned to + The version this design-at-versions is pinned to. """ version: DesignVersion! } @@ -6637,12 +7312,12 @@ A collection of designs """ type DesignCollection { """ - Copy state of the design collection + Copy state of the design collection. """ copyState: DesignCollectionCopyState """ - Find a specific design + Find a specific design. """ design( """ @@ -6657,7 +7332,7 @@ type DesignCollection { ): Design """ - Find a design as of a version + Find a design as of a version. """ designAtVersion( """ @@ -6667,7 +7342,7 @@ type DesignCollection { ): DesignAtVersion """ - All designs for the design collection + All designs for the design collection. """ designs( """ @@ -6708,17 +7383,17 @@ type DesignCollection { ): DesignConnection! """ - Issue associated with the design collection + Issue associated with the design collection. """ issue: Issue! """ - Project associated with the design collection + Project associated with the design collection. """ project: Project! """ - A specific version + A specific version. """ version( """ @@ -6733,7 +7408,7 @@ type DesignCollection { ): DesignVersion """ - All versions related to all designs, ordered newest first + All versions related to all designs, ordered newest first. """ versions( """ @@ -6825,32 +7500,32 @@ type DesignEdge { interface DesignFields { """ - The diff refs for this design + The diff refs for this design. """ diffRefs: DiffRefs! """ - How this design was changed in the current version + How this design was changed in the current version. """ event: DesignVersionEvent! """ - The filename of the design + The filename of the design. """ filename: String! """ - The full path to the design file + The full path to the design file. """ fullPath: String! """ - The ID of this design + The ID of this design. """ id: ID! """ - The URL of the full-sized image + The URL of the full-sized image. """ image: String! @@ -6860,24 +7535,24 @@ interface DesignFields { imageV432x230: String """ - The issue the design belongs to + The issue the design belongs to. """ issue: Issue! """ - The total count of user-created notes for this design + The total count of user-created notes for this design. """ notesCount: Int! """ - The project the design belongs to + The project the design belongs to. """ project: Project! } type DesignManagement { """ - Find a design as of a version + Find a design as of a version. """ designAtVersion( """ @@ -6887,7 +7562,7 @@ type DesignManagement { ): DesignAtVersion """ - Find a version + Find a version. """ version( """ @@ -6943,12 +7618,12 @@ type DesignManagementDeletePayload { } """ -Identifier of DesignManagement::DesignAtVersion +Identifier of DesignManagement::DesignAtVersion. """ scalar DesignManagementDesignAtVersionID """ -Identifier of DesignManagement::Design +Identifier of DesignManagement::Design. """ scalar DesignManagementDesignID @@ -7048,7 +7723,7 @@ type DesignManagementUploadPayload { } """ -Identifier of DesignManagement::Version +Identifier of DesignManagement::Version. """ scalar DesignManagementVersionID @@ -7057,7 +7732,7 @@ A specific version in which designs were added, modified or deleted """ type DesignVersion { """ - A particular design as of this version, provided it is visible at this version + A particular design as of this version, provided it is visible at this version. """ designAtVersion( """ @@ -7077,7 +7752,7 @@ type DesignVersion { ): DesignAtVersion! """ - All designs that were changed in the version + All designs that were changed in the version. """ designs( """ @@ -7102,7 +7777,7 @@ type DesignVersion { ): DesignConnection! """ - All designs that are visible at this version, as of this version + All designs that are visible at this version, as of this version. """ designsAtVersion( """ @@ -7137,12 +7812,12 @@ type DesignVersion { ): DesignAtVersionConnection! """ - ID of the design version + ID of the design version. """ id: ID! """ - SHA of the design version + SHA of the design version. """ sha: ID! } @@ -7454,47 +8129,47 @@ type DestroySnippetPayload { type DetailedStatus { """ - Action information for the status. This includes method, button title, icon, path, and title + Action information for the status. This includes method, button title, icon, path, and title. """ action: StatusAction """ - Path of the details for the status + Path of the details for the status. """ detailsPath: String """ - Favicon of the status + Favicon of the status. """ favicon: String """ - Group of the status + Group of the status. """ group: String """ - Indicates if the status has further details + Indicates if the status has further details. """ hasDetails: Boolean """ - Icon of the status + Icon of the status. """ icon: String """ - Label of the status + Label of the status. """ label: String """ - Text of the status + Text of the status. """ text: String """ - Tooltip associated with the status + Tooltip associated with the status. """ tooltip: String } @@ -7504,24 +8179,19 @@ Segment """ type DevopsAdoptionSegment { """ - Assigned groups - """ - groups: [Group!] - - """ - ID of the segment + ID of the segment. """ id: ID! """ - The latest adoption metrics for the segment + The latest adoption metrics for the segment. """ latestSnapshot: DevopsAdoptionSnapshot """ - Name of the segment + Segment namespace. """ - name: String! + namespace: Namespace } """ @@ -7564,69 +8234,69 @@ Snapshot """ type DevopsAdoptionSnapshot { """ - At least one deployment succeeded + At least one deployment succeeded. """ deploySucceeded: Boolean! """ - The end time for the snapshot where the data points were collected + The end time for the snapshot where the data points were collected. """ endTime: Time! """ - At least one issue was opened + At least one issue was opened. """ issueOpened: Boolean! """ - At least one merge request was approved + At least one merge request was approved. """ mergeRequestApproved: Boolean! """ - At least one merge request was opened + At least one merge request was opened. """ mergeRequestOpened: Boolean! """ - At least one pipeline succeeded + At least one pipeline succeeded. """ pipelineSucceeded: Boolean! """ - The time the snapshot was recorded + The time the snapshot was recorded. """ recordedAt: Time! """ - At least one runner was used + At least one runner was used. """ runnerConfigured: Boolean! """ - At least one security scan succeeded + At least one security scan succeeded. """ securityScanSucceeded: Boolean! """ - The start time for the snapshot where the data points were collected + The start time for the snapshot where the data points were collected. """ startTime: Time! } input DiffImagePositionInput { """ - Merge base of the branch the comment was made on + Merge base of the branch the comment was made on. """ baseSha: String """ - SHA of the HEAD at the time the comment was made + SHA of the HEAD at the time the comment was made. """ headSha: String! """ - Total height of the image + Total height of the image. """ height: Int! @@ -7637,118 +8307,118 @@ input DiffImagePositionInput { paths: DiffPathsInput! """ - SHA of the branch being compared against + SHA of the branch being compared against. """ startSha: String! """ - Total width of the image + Total width of the image. """ width: Int! """ - X position of the note + X position of the note. """ x: Int! """ - Y position of the note + Y position of the note. """ y: Int! } """ -Identifier of DiffNote +Identifier of DiffNote. """ scalar DiffNoteID input DiffPathsInput { """ - The path of the file on the head sha + The path of the file on the head sha. """ newPath: String """ - The path of the file on the start sha + The path of the file on the start sha. """ oldPath: String } type DiffPosition { """ - Information about the branch, HEAD, and base at the time of commenting + Information about the branch, HEAD, and base at the time of commenting. """ diffRefs: DiffRefs! """ - Path of the file that was changed + Path of the file that was changed. """ filePath: String! """ - Total height of the image + Total height of the image. """ height: Int """ - Line on HEAD SHA that was changed + Line on HEAD SHA that was changed. """ newLine: Int """ - Path of the file on the HEAD SHA + Path of the file on the HEAD SHA. """ newPath: String """ - Line on start SHA that was changed + Line on start SHA that was changed. """ oldLine: Int """ - Path of the file on the start SHA + Path of the file on the start SHA. """ oldPath: String """ - Type of file the position refers to + Type of file the position refers to. """ positionType: DiffPositionType! """ - Total width of the image + Total width of the image. """ width: Int """ - X position of the note + X position of the note. """ x: Int """ - Y position of the note + Y position of the note. """ y: Int } input DiffPositionInput { """ - Merge base of the branch the comment was made on + Merge base of the branch the comment was made on. """ baseSha: String """ - SHA of the HEAD at the time the comment was made + SHA of the HEAD at the time the comment was made. """ headSha: String! """ - Line on HEAD SHA that was changed + Line on HEAD SHA that was changed. """ newLine: Int! """ - Line on start SHA that was changed + Line on start SHA that was changed. """ oldLine: Int @@ -7759,7 +8429,7 @@ input DiffPositionInput { paths: DiffPathsInput! """ - SHA of the branch being compared against + SHA of the branch being compared against. """ startSha: String! } @@ -7774,17 +8444,17 @@ enum DiffPositionType { type DiffRefs { """ - Merge base of the branch the comment was made on + Merge base of the branch the comment was made on. """ baseSha: String """ - SHA of the HEAD at the time the comment was made + SHA of the HEAD at the time the comment was made. """ headSha: String! """ - SHA of the branch being compared against + SHA of the branch being compared against. """ startSha: String! } @@ -7794,17 +8464,17 @@ Changes to a single file """ type DiffStats { """ - Number of lines added to this file + Number of lines added to this file. """ additions: Int! """ - Number of lines deleted from this file + Number of lines deleted from this file. """ deletions: Int! """ - File path, relative to repository root + File path, relative to repository root. """ path: String! } @@ -7814,39 +8484,39 @@ Aggregated summary of changes """ type DiffStatsSummary { """ - Number of lines added + Number of lines added. """ additions: Int! """ - Number of lines changed + Number of lines changed. """ changes: Int! """ - Number of lines deleted + Number of lines deleted. """ deletions: Int! """ - Number of files changed + Number of files changed. """ fileCount: Int! } type Discussion implements ResolvableInterface { """ - Timestamp of the discussion's creation + Timestamp of the discussion's creation. """ createdAt: Time! """ - ID of this discussion + ID of this discussion. """ - id: ID! + id: DiscussionID! """ - All notes in the discussion + All notes in the discussion. """ notes( """ @@ -7871,27 +8541,27 @@ type Discussion implements ResolvableInterface { ): NoteConnection! """ - ID used to reply to this discussion + ID used to reply to this discussion. """ - replyId: ID! + replyId: DiscussionID! """ - Indicates if the object can be resolved + Indicates if the object can be resolved. """ resolvable: Boolean! """ - Indicates if the object is resolved + Indicates if the object is resolved. """ resolved: Boolean! """ - Timestamp of when the object was resolved + Timestamp of when the object was resolved. """ resolvedAt: Time """ - User who resolved the object + User who resolved the object. """ resolvedBy: User } @@ -7932,7 +8602,7 @@ type DiscussionEdge { } """ -Identifier of Discussion +Identifier of Discussion. """ scalar DiscussionID @@ -8023,32 +8693,32 @@ type DismissVulnerabilityPayload { interface Entry { """ - Flat path of the entry + Flat path of the entry. """ flatPath: String! """ - ID of the entry + ID of the entry. """ id: ID! """ - Name of the entry + Name of the entry. """ name: String! """ - Path of the entry + Path of the entry. """ path: String! """ - Last commit sha for the entry + Last commit SHA for the entry. """ sha: String! """ - Type of tree entry + Type of tree entry. """ type: EntryType! } @@ -8067,17 +8737,17 @@ Describes where code is deployed for a project """ type Environment { """ - ID of the environment + ID of the environment. """ id: ID! """ - The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned + The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. """ latestOpenedMostSevereAlert: AlertManagementAlert """ - Metrics dashboard schema for the environment + Metrics dashboard schema for the environment. """ metricsDashboard( """ @@ -8087,7 +8757,7 @@ type Environment { ): MetricsDashboard """ - Human-readable name of the environment + Human-readable name of the environment. """ name: String! @@ -8097,7 +8767,7 @@ type Environment { path: String! """ - State of the environment, for example: available/stopped + State of the environment, for example: available/stopped. """ state: String! } @@ -8138,7 +8808,7 @@ type EnvironmentEdge { } """ -Identifier of Environment +Identifier of Environment. """ scalar EnvironmentID @@ -8180,14 +8850,39 @@ type EnvironmentsCanaryIngressUpdatePayload { """ Represents an epic """ -type Epic implements CurrentUserTodos & Noteable { +type Epic implements CurrentUserTodos & Eventable & Noteable { """ - Author of the epic + Author of the epic. """ author: User! """ - Children (sub-epics) of the epic + A list of award emojis associated with the epic. + """ + awardEmoji( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): AwardEmojiConnection + + """ + Children (sub-epics) of the epic. """ children( """ @@ -8285,22 +8980,22 @@ type Epic implements CurrentUserTodos & Noteable { ): EpicConnection """ - Timestamp of when the epic was closed + Timestamp of when the epic was closed. """ closedAt: Time """ - Indicates if the epic is confidential + Indicates if the epic is confidential. """ confidential: Boolean """ - Timestamp of when the epic was created + Timestamp of when the epic was created. """ createdAt: Time """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -8324,28 +9019,28 @@ type Epic implements CurrentUserTodos & Noteable { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! """ - Number of open and closed descendant epics and issues + Number of open and closed descendant epics and issues. """ descendantCounts: EpicDescendantCount """ - Total weight of open and closed issues in the epic and its descendants + Total weight of open and closed issues in the epic and its descendants. """ descendantWeightSum: EpicDescendantWeights """ - Description of the epic + Description of the epic. """ description: String """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -8370,67 +9065,92 @@ type Epic implements CurrentUserTodos & Noteable { ): DiscussionConnection! """ - Number of downvotes the epic has received + Number of downvotes the epic has received. """ downvotes: Int! """ - Due date of the epic + Due date of the epic. """ dueDate: Time """ - Fixed due date of the epic + Fixed due date of the epic. """ dueDateFixed: Time """ - Inherited due date of the epic from milestones + Inherited due date of the epic from milestones. """ dueDateFromMilestones: Time """ - Indicates if the due date has been manually set + Indicates if the due date has been manually set. """ dueDateIsFixed: Boolean """ - Group to which the epic belongs + A list of events associated with the object. + """ + events( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): EventConnection + + """ + Group to which the epic belongs. """ group: Group! """ - Indicates if the epic has children + Indicates if the epic has children. """ hasChildren: Boolean! """ - Indicates if the epic has direct issues + Indicates if the epic has direct issues. """ hasIssues: Boolean! """ - Indicates if the epic has a parent epic + Indicates if the epic has a parent epic. """ hasParent: Boolean! """ - Current health status of the epic + Current health status of the epic. """ healthStatus: EpicHealthStatus """ - ID of the epic + ID of the epic. """ id: ID! """ - Internal ID of the epic + Internal ID of the epic. """ iid: ID! """ - A list of issues associated with the epic + A list of issues associated with the epic. """ issues( """ @@ -8455,7 +9175,7 @@ type Epic implements CurrentUserTodos & Noteable { ): EpicIssueConnection """ - Labels assigned to the epic + Labels assigned to the epic. """ labels( """ @@ -8480,7 +9200,7 @@ type Epic implements CurrentUserTodos & Noteable { ): LabelConnection """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -8505,12 +9225,12 @@ type Epic implements CurrentUserTodos & Noteable { ): NoteConnection! """ - Parent epic of the epic + Parent epic of the epic. """ parent: Epic """ - List of participants for the epic + List of participants for the epic. """ participants( """ @@ -8535,77 +9255,77 @@ type Epic implements CurrentUserTodos & Noteable { ): UserConnection """ - Internal reference of the epic. Returned in shortened format by default + Internal reference of the epic. Returned in shortened format by default. """ reference( """ - Indicates if the reference should be returned in full + Indicates if the reference should be returned in full. """ full: Boolean = false ): String! """ - URI path of the epic-issue relationship + URI path of the epic-issue relationship. """ relationPath: String """ - The relative position of the epic in the epic tree + The relative position of the epic in the epic tree. """ relativePosition: Int """ - Start date of the epic + Start date of the epic. """ startDate: Time """ - Fixed start date of the epic + Fixed start date of the epic. """ startDateFixed: Time """ - Inherited start date of the epic from milestones + Inherited start date of the epic from milestones. """ startDateFromMilestones: Time """ - Indicates if the start date has been manually set + Indicates if the start date has been manually set. """ startDateIsFixed: Boolean """ - State of the epic + State of the epic. """ state: EpicState! """ - Indicates the currently logged in user is subscribed to the epic + Indicates the currently logged in user is subscribed to the epic. """ subscribed: Boolean! """ - Title of the epic + Title of the epic. """ title: String """ - Timestamp of when the epic was updated + Timestamp of when the epic was updated. """ updatedAt: Time """ - Number of upvotes the epic has received + Number of upvotes the epic has received. """ upvotes: Int! """ - Number of user discussions in the epic + Number of user discussions in the epic. """ userDiscussionsCount: Int! """ - Number of user notes of the epic + Number of user notes of the epic. """ userNotesCount: Int! @@ -8615,12 +9335,12 @@ type Epic implements CurrentUserTodos & Noteable { userPermissions: EpicPermissions! """ - Web path of the epic + Web path of the epic. """ webPath: String! """ - Web URL of the epic + Web URL of the epic. """ webUrl: String! } @@ -8746,6 +9466,56 @@ type EpicBoardConnection { } """ +Autogenerated input type of EpicBoardCreate +""" +input EpicBoardCreateInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Full path of the group with which the resource is associated. + """ + groupPath: ID + + """ + Whether or not backlog list is hidden. + """ + hideBacklogList: Boolean + + """ + Whether or not closed list is hidden. + """ + hideClosedList: Boolean + + """ + The board name. + """ + name: String +} + +""" +Autogenerated return type of EpicBoardCreate +""" +type EpicBoardCreatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The created epic board. + """ + epicBoard: EpicBoard + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! +} + +""" An edge in a connection. """ type EpicBoardEdge { @@ -8761,6 +9531,51 @@ type EpicBoardEdge { } """ +Autogenerated input type of EpicBoardListCreate +""" +input EpicBoardListCreateInput { + """ + Create the backlog list. + """ + backlog: Boolean + + """ + Global ID of the issue board to mutate. + """ + boardId: BoardsEpicBoardID! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Global ID of an existing label. + """ + labelId: LabelID +} + +""" +Autogenerated return type of EpicBoardListCreate +""" +type EpicBoardListCreatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + Epic list in the epic board. + """ + list: EpicList +} + +""" The connection type for Epic. """ type EpicConnection { @@ -8785,22 +9600,22 @@ Counts of descendent epics """ type EpicDescendantCount { """ - Number of closed child epics + Number of closed child epics. """ closedEpics: Int """ - Number of closed epic issues + Number of closed epic issues. """ closedIssues: Int """ - Number of opened child epics + Number of opened child epics. """ openedEpics: Int """ - Number of opened epic issues + Number of opened epic issues. """ openedIssues: Int } @@ -8810,12 +9625,12 @@ Total weight of open and closed descendant issues """ type EpicDescendantWeights { """ - Total weight of completed (closed) issues in this epic, including epic descendants + 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 + Total weight of opened issues in this epic, including epic descendants. """ openedIssues: Int } @@ -8840,23 +9655,23 @@ Health status of child issues """ type EpicHealthStatus { """ - Number of issues at risk + Number of issues at risk. """ issuesAtRisk: Int """ - Number of issues that need attention + Number of issues that need attention. """ issuesNeedingAttention: Int """ - Number of issues on track + Number of issues on track. """ issuesOnTrack: Int } """ -Identifier of Epic +Identifier of Epic. """ scalar EpicID @@ -8865,12 +9680,12 @@ Relationship between an epic and an issue """ type EpicIssue implements CurrentUserTodos & Noteable { """ - Alert associated to this issue + Alert associated to this issue. """ alertManagementAlert: AlertManagementAlert """ - Assignees of the issue + Assignees of the issue. """ assignees( """ @@ -8895,7 +9710,7 @@ type EpicIssue implements CurrentUserTodos & Noteable { ): UserConnection """ - User that created the issue + User that created the issue. """ author: User! @@ -8910,27 +9725,27 @@ type EpicIssue implements CurrentUserTodos & Noteable { blockedByCount: Int """ - Timestamp of when the issue was closed + Timestamp of when the issue was closed. """ closedAt: Time """ - Indicates the issue is confidential + Indicates the issue is confidential. """ confidential: Boolean! """ - User specific email address for the issue + User specific email address for the issue. """ createNoteEmail: String """ - Timestamp of when the issue was created + Timestamp of when the issue was created. """ createdAt: Time! """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -8954,13 +9769,13 @@ type EpicIssue implements CurrentUserTodos & Noteable { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! """ - Description of the issue + Description of the issue. """ description: String @@ -8970,17 +9785,17 @@ type EpicIssue implements CurrentUserTodos & Noteable { descriptionHtml: String """ - Collection of design images associated with this issue + Collection of design images associated with this issue. """ designCollection: DesignCollection """ - Indicates discussion is locked on the issue + Indicates discussion is locked on the issue. """ discussionLocked: Boolean! """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -9005,17 +9820,17 @@ type EpicIssue implements CurrentUserTodos & Noteable { ): DiscussionConnection! """ - Number of downvotes the issue has received + Number of downvotes the issue has received. """ downvotes: Int! """ - Due date of the issue + Due date of the issue. """ dueDate: Time """ - Indicates if a project has email notifications disabled: `true` if email notifications are disabled + Indicates if a project has email notifications disabled: `true` if email notifications are disabled. """ emailsDisabled: Boolean! @@ -9025,7 +9840,7 @@ type EpicIssue implements CurrentUserTodos & Noteable { epic: Epic """ - ID of the epic-issue relation + ID of the epic-issue relation. """ epicIssueId: ID! @@ -9035,22 +9850,22 @@ type EpicIssue implements CurrentUserTodos & Noteable { healthStatus: HealthStatus """ - Human-readable time estimate of the issue + Human-readable time estimate of the issue. """ humanTimeEstimate: String """ - Human-readable total time reported as spent on the issue + Human-readable total time reported as spent on the issue. """ humanTotalTimeSpent: String """ - Global ID of the epic-issue relation + Global ID of the epic-issue relation. """ id: ID """ - Internal ID of the issue + Internal ID of the issue. """ iid: ID! @@ -9060,7 +9875,7 @@ type EpicIssue implements CurrentUserTodos & Noteable { iteration: Iteration """ - Labels of the issue + Labels of the issue. """ labels( """ @@ -9090,22 +9905,22 @@ type EpicIssue implements CurrentUserTodos & Noteable { metricImages: [MetricImage!] """ - Milestone of the issue + Milestone of the issue. """ milestone: Milestone """ - Indicates if issue got moved from other project + Indicates if issue got moved from other project. """ moved: Boolean """ - Updated Issue after it got moved to another project + Updated Issue after it got moved to another project. """ movedTo: Issue """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -9130,7 +9945,7 @@ type EpicIssue implements CurrentUserTodos & Noteable { ): NoteConnection! """ - List of participants in the issue + List of participants in the issue. """ participants( """ @@ -9155,27 +9970,27 @@ type EpicIssue implements CurrentUserTodos & Noteable { ): UserConnection """ - Internal reference of the issue. Returned in shortened format by default + Internal reference of the issue. Returned in shortened format by default. """ reference( """ - Boolean option specifying whether the reference should be returned in full + Boolean option specifying whether the reference should be returned in full. """ full: Boolean = false ): String! """ - URI path of the epic-issue relation + URI path of the epic-issue relation. """ relationPath: String """ - Relative position of the issue (used for positioning in epic tree and issue boards) + Relative position of the issue (used for positioning in epic tree and issue boards). """ relativePosition: Int """ - Severity level of the incident + Severity level of the incident. """ severity: IssuableSeverity @@ -9185,7 +10000,7 @@ type EpicIssue implements CurrentUserTodos & Noteable { slaDueAt: Time """ - State of the issue + State of the issue. """ state: IssueState! @@ -9195,22 +10010,22 @@ type EpicIssue implements CurrentUserTodos & Noteable { statusPagePublishedIncident: Boolean """ - Indicates the currently logged in user is subscribed to the issue + Indicates the currently logged in user is subscribed to the issue. """ subscribed: Boolean! """ - Task completion status of the issue + Task completion status of the issue. """ taskCompletionStatus: TaskCompletionStatus! """ - Time estimate of the issue + Time estimate of the issue. """ timeEstimate: Int! """ - Title of the issue + Title of the issue. """ title: String! @@ -9220,37 +10035,37 @@ type EpicIssue implements CurrentUserTodos & Noteable { titleHtml: String """ - Total time reported as spent on the issue + Total time reported as spent on the issue. """ totalTimeSpent: Int! """ - Type of the issue + Type of the issue. """ type: IssueType """ - Timestamp of when the issue was last updated + Timestamp of when the issue was last updated. """ updatedAt: Time! """ - User that last updated the issue + User that last updated the issue. """ updatedBy: User """ - Number of upvotes the issue has received + Number of upvotes the issue has received. """ upvotes: Int! """ - Number of user discussions in the issue + Number of user discussions in the issue. """ userDiscussionsCount: Int! """ - Number of user notes of the issue + Number of user notes of the issue. """ userNotesCount: Int! @@ -9260,12 +10075,12 @@ type EpicIssue implements CurrentUserTodos & Noteable { userPermissions: IssuePermissions! """ - Web path of the issue + Web path of the issue. """ webPath: String! """ - Web URL of the issue + Web URL of the issue. """ webUrl: String! @@ -9280,7 +10095,7 @@ The connection type for EpicIssue. """ type EpicIssueConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -9300,7 +10115,7 @@ type EpicIssueConnection { pageInfo: PageInfo! """ - Total weight of issues collection + Total weight of issues collection. """ weight: Int! } @@ -9554,22 +10369,22 @@ A node of an epic tree. """ input EpicTreeNodeFieldsInputType { """ - The ID of the epic_issue or issue that the actual epic or issue is switched with + The ID of the epic_issue or issue that the actual epic or issue is switched with. """ adjacentReferenceId: EpicTreeSortingID """ - The ID of the epic_issue or epic that is being moved + The ID of the epic_issue or epic that is being moved. """ id: EpicTreeSortingID! """ - ID of the new parent epic + ID of the new parent epic. """ newParentId: EpicID """ - The type of the switch, after or before allowed + The type of the switch, after or before allowed. """ relativePosition: MoveType } @@ -9610,7 +10425,7 @@ type EpicTreeReorderPayload { } """ -Identifier of EpicTreeSorting +Identifier of EpicTreeSorting. """ scalar EpicTreeSortingID @@ -9630,6 +10445,168 @@ enum EpicWildcardId { } """ +Representing an event +""" +type Event { + """ + Action of the event. + """ + action: EventAction! + + """ + Author of this event. + """ + author: User! + + """ + When this event was created. + """ + createdAt: Time! + + """ + ID of the event. + """ + id: ID! + + """ + When this event was updated. + """ + updatedAt: Time! +} + +""" +Event action +""" +enum EventAction { + """ + Approved action + """ + APPROVED + + """ + Archived action + """ + ARCHIVED + + """ + Closed action + """ + CLOSED + + """ + Commented action + """ + COMMENTED + + """ + Created action + """ + CREATED + + """ + Destroyed action + """ + DESTROYED + + """ + Expired action + """ + EXPIRED + + """ + Joined action + """ + JOINED + + """ + Left action + """ + LEFT + + """ + Merged action + """ + MERGED + + """ + Pushed action + """ + PUSHED + + """ + Reopened action + """ + REOPENED + + """ + Updated action + """ + UPDATED +} + +""" +The connection type for Event. +""" +type EventConnection { + """ + A list of edges. + """ + edges: [EventEdge] + + """ + A list of nodes. + """ + nodes: [Event] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type EventEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: Event +} + +interface Eventable { + """ + A list of events associated with the object. + """ + events( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): EventConnection +} + +""" Autogenerated input type of ExportRequirements """ input ExportRequirementsInput { @@ -9654,6 +10631,11 @@ input ExportRequirementsInput { search: String """ + List of selected requirements fields to be exported. + """ + selectedFields: [String!] + + """ List requirements by sort order. """ sort: Sort @@ -9684,69 +10666,69 @@ Represents an external issue """ type ExternalIssue { """ - Timestamp of when the issue was created + Timestamp of when the issue was created. """ createdAt: Time """ - Type of external tracker + Type of external tracker. """ externalTracker: String """ - Relative reference of the issue in the external tracker + Relative reference of the issue in the external tracker. """ relativeReference: String """ - Status of the issue in the external tracker + Status of the issue in the external tracker. """ status: String """ - Title of the issue in the external tracker + Title of the issue in the external tracker. """ title: String """ - Timestamp of when the issue was updated + Timestamp of when the issue was updated. """ updatedAt: Time """ - URL to the issue in the external tracker + URL to the issue in the external tracker. """ webUrl: String } type GeoNode { """ - The maximum concurrency of container repository sync for this secondary node + The maximum concurrency of container repository sync for this secondary node. """ containerRepositoriesMaxCapacity: Int """ - Indicates whether this Geo node is enabled + Indicates whether this Geo node is enabled. """ enabled: Boolean """ - The maximum concurrency of LFS/attachment backfill for this secondary node + The maximum concurrency of LFS/attachment backfill for this secondary node. """ filesMaxCapacity: Int """ - ID of this GeoNode + ID of this GeoNode. """ id: ID! """ - The URL defined on the primary node that secondary nodes should use to contact it + The URL defined on the primary node that secondary nodes should use to contact it. """ internalUrl: String """ - Find merge request diff registries on this Geo node + Find merge request diff registries on this Geo node. """ mergeRequestDiffRegistries( """ @@ -9776,17 +10758,17 @@ type GeoNode { ): MergeRequestDiffRegistryConnection """ - The interval (in days) in which the repository verification is valid. Once expired, it will be reverified + The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. """ minimumReverificationInterval: Int """ - The unique identifier for this Geo node + The unique identifier for this Geo node. """ name: String """ - Package file registries of the GeoNode + Package file registries of the GeoNode. """ packageFileRegistries( """ @@ -9816,17 +10798,17 @@ type GeoNode { ): PackageFileRegistryConnection """ - Indicates whether this Geo node is the primary + Indicates whether this Geo node is the primary. """ primary: Boolean """ - The maximum concurrency of repository backfill for this secondary node + The maximum concurrency of repository backfill for this secondary node. """ reposMaxCapacity: Int """ - The namespaces that should be synced, if `selective_sync_type` == `namespaces` + The namespaces that should be synced, if `selective_sync_type` == `namespaces`. """ selectiveSyncNamespaces( """ @@ -9851,17 +10833,17 @@ type GeoNode { ): NamespaceConnection """ - The repository storages whose projects should be synced, if `selective_sync_type` == `shards` + The repository storages whose projects should be synced, if `selective_sync_type` == `shards`. """ selectiveSyncShards: [String!] """ - Indicates if syncing is limited to only specific groups, or shards + Indicates if syncing is limited to only specific groups, or shards. """ selectiveSyncType: String """ - Find snippet repository registries on this Geo node + Find snippet repository registries on this Geo node. """ snippetRepositoryRegistries( """ @@ -9891,12 +10873,12 @@ type GeoNode { ): SnippetRepositoryRegistryConnection """ - Indicates if this secondary node will replicate blobs in Object Storage + Indicates if this secondary node will replicate blobs in Object Storage. """ syncObjectStorage: Boolean """ - Find terraform state version registries on this Geo node + Find terraform state version registries on this Geo node. """ terraformStateVersionRegistries( """ @@ -9926,71 +10908,101 @@ type GeoNode { ): TerraformStateVersionRegistryConnection """ - The user-facing URL for this Geo node + The user-facing URL for this Geo node. """ url: String """ - The maximum concurrency of repository verification for this secondary node + The maximum concurrency of repository verification for this secondary node. """ verificationMaxCapacity: Int } """ -Identifier of Gitlab::ErrorTracking::DetailedError +Identifier of Gitlab::ErrorTracking::DetailedError. """ scalar GitlabErrorTrackingDetailedErrorID +""" +Autogenerated input type of GitlabSubscriptionActivate +""" +input GitlabSubscriptionActivateInput { + """ + Activation code received after purchasing a GitLab subscription. + """ + activationCode: String! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String +} + +""" +Autogenerated return type of GitlabSubscriptionActivate +""" +type GitlabSubscriptionActivatePayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! +} + type GrafanaIntegration { """ - Timestamp of the issue's creation + Timestamp of the issue's creation. """ createdAt: Time! """ - Indicates whether Grafana integration is enabled + Indicates whether Grafana integration is enabled. """ enabled: Boolean! """ - URL for the Grafana host for the Grafana integration + URL for the Grafana host for the Grafana integration. """ grafanaUrl: String! """ - Internal ID of the Grafana integration + Internal ID of the Grafana integration. """ id: ID! """ - Timestamp of the issue's last activity + Timestamp of the issue's last activity. """ updatedAt: Time! } type Group { """ - Size limit for repositories in the namespace in bytes + Size limit for repositories in the namespace in bytes. """ actualRepositorySizeLimit: Float """ - Additional storage purchased for the root namespace in bytes + Additional storage purchased for the root namespace in bytes. """ additionalPurchasedStorageSize: Float """ - Indicates whether Auto DevOps is enabled for all projects within this group + Indicates whether Auto DevOps is enabled for all projects within this group. """ autoDevopsEnabled: Boolean """ - Avatar URL of the group + Avatar URL of the group. """ avatarUrl: String """ - A single board of the group + A single board of the group. """ board( """ @@ -10000,7 +11012,7 @@ type Group { ): Board """ - Boards of the group + Boards of the group. """ boards( """ @@ -10030,7 +11042,7 @@ type Group { ): BoardConnection """ - Represents the code coverage activity for this group + Represents the code coverage activity for this group. """ codeCoverageActivities( """ @@ -10091,7 +11103,7 @@ type Group { ): ComplianceFrameworkConnection """ - Container repositories of the group + Container repositories of the group. """ containerRepositories( """ @@ -10118,20 +11130,25 @@ type Group { Filter the container repositories by their name. """ name: String + + """ + Sort container repositories by this criteria. + """ + sort: ContainerRepositorySort = created_desc ): ContainerRepositoryConnection """ - Number of container repositories in the group + Number of container repositories in the group. """ containerRepositoriesCount: Int! """ - Includes at least one project where the repository size exceeds the limit + Includes at least one project where the repository size exceeds the limit. """ containsLockedProjects: Boolean! """ - Custom emoji within this namespace Available only when feature flag `custom_emoji` is enabled. + Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. """ customEmoji( """ @@ -10156,7 +11173,7 @@ type Group { ): CustomEmojiConnection """ - Description of the namespace + Description of the namespace. """ description: String @@ -10166,12 +11183,12 @@ type Group { descriptionHtml: String """ - Indicates if a group has email notifications disabled + Indicates if a group has email notifications disabled. """ emailsDisabled: Boolean """ - Find a single epic + Find a single epic. """ epic( """ @@ -10249,7 +11266,7 @@ type Group { ): Epic """ - Find a single epic board + Find a single epic board. """ epicBoard( """ @@ -10259,7 +11276,7 @@ type Group { ): EpicBoard """ - Find epic boards + Find epic boards. """ epicBoards( """ @@ -10284,7 +11301,7 @@ type Group { ): EpicBoardConnection """ - Find epics + Find epics. """ epics( """ @@ -10387,17 +11404,17 @@ type Group { epicsEnabled: Boolean """ - Full name of the namespace + Full name of the namespace. """ fullName: String! """ - Full path of the namespace + Full path of the namespace. """ fullPath: ID! """ - A membership of a user within this group + A membership of a user within this group. """ groupMembers( """ @@ -10437,17 +11454,17 @@ type Group { groupTimelogsEnabled: Boolean """ - ID of the namespace + ID of the namespace. """ id: ID! """ - Status of the temporary storage increase + Status of the temporary storage increase. """ isTemporaryStorageIncreaseEnabled: Boolean! """ - Issues for projects in this group + Issues for projects in this group. """ issues( """ @@ -10577,7 +11594,7 @@ type Group { ): IssueConnection """ - Find iterations + Find iterations. """ iterations( """ @@ -10645,17 +11662,17 @@ type Group { ): IterationConnection """ - A label available on this group + A label available on this group. """ label( """ - Title of the label + Title of the label. """ title: String! ): Label """ - Labels available on this group + Labels available on this group. """ labels( """ @@ -10674,28 +11691,43 @@ type Group { first: Int """ + Include labels from ancestor groups. + """ + includeAncestorGroups: Boolean = false + + """ + Include labels from descendant groups. + """ + includeDescendantGroups: Boolean = false + + """ Returns the last _n_ elements from the list. """ last: Int """ - A search term to find labels with + Include only group level labels. + """ + onlyGroupLabels: Boolean = false + + """ + A search term to find labels with. """ searchTerm: String ): LabelConnection """ - Indicates if Large File Storage (LFS) is enabled for namespace + Indicates if Large File Storage (LFS) is enabled for namespace. """ lfsEnabled: Boolean """ - Indicates if a group is disabled from getting mentioned + Indicates if a group is disabled from getting mentioned. """ mentionsDisabled: Boolean """ - Merge requests for projects in this group + Merge requests for projects in this group. """ mergeRequests( """ @@ -10780,7 +11812,7 @@ type Group { ): MergeRequestConnection """ - Milestones of the group + Milestones of the group. """ milestones( """ @@ -10853,32 +11885,32 @@ type Group { ): MilestoneConnection """ - Name of the namespace + Name of the namespace. """ name: String! """ - The package settings for the namespace + The package settings for the namespace. """ packageSettings: PackageSettings """ - Parent group + Parent group. """ parent: Group """ - Path of the namespace + Path of the namespace. """ path: String! """ - The permission level required to create projects in the group + The permission level required to create projects in the group. """ projectCreationLevel: String """ - Projects within this namespace + Projects within this namespace. """ projects( """ @@ -10923,52 +11955,52 @@ type Group { ): ProjectConnection! """ - Number of projects in the root namespace where the repository size exceeds the limit + Number of projects in the root namespace where the repository size exceeds the limit. """ repositorySizeExcessProjectCount: Int! """ - Indicates if users can request access to namespace + Indicates if users can request access to namespace. """ requestAccessEnabled: Boolean """ - Indicates if all users in this group are required to set up two-factor authentication + Indicates if all users in this group are required to set up two-factor authentication. """ requireTwoFactorAuthentication: Boolean """ - Aggregated storage statistics of the namespace. Only available for root namespaces + Aggregated storage statistics of the namespace. Only available for root namespaces. """ rootStorageStatistics: RootStorageStatistics """ - Indicates if sharing a project with another group within this group is prevented + Indicates if sharing a project with another group within this group is prevented. """ shareWithGroupLock: Boolean """ - Group statistics + Group statistics. """ stats: GroupStats """ - Total storage limit of the root namespace in bytes + Total storage limit of the root namespace in bytes. """ storageSizeLimit: Float """ - The permission level required to create subgroups within the group + The permission level required to create subgroups within the group. """ subgroupCreationLevel: String """ - Date until the temporary storage increase is active + Date until the temporary storage increase is active. """ temporaryStorageIncreaseEndsOn: Time """ - Time logged in issues by group members + Time logged in issues by group members. """ timelogs( """ @@ -11013,17 +12045,17 @@ type Group { ): TimelogConnection! """ - Total repository size of all projects in the root namespace in bytes + Total repository size of all projects in the root namespace in bytes. """ totalRepositorySize: Float """ - Total excess repository size of all projects in the root namespace in bytes + Total excess repository size of all projects in the root namespace in bytes. """ totalRepositorySizeExcess: Float """ - Time before two-factor authentication is enforced + Time before two-factor authentication is enforced. """ twoFactorGracePeriod: Int @@ -11033,12 +12065,12 @@ type Group { userPermissions: GroupPermissions! """ - Visibility of the namespace + Visibility of the namespace. """ visibility: String """ - Vulnerabilities reported on the projects in the group and its subgroups + Vulnerabilities reported on the projects in the group and its subgroups. """ vulnerabilities( """ @@ -11103,7 +12135,7 @@ type Group { ): VulnerabilityConnection """ - Number of vulnerabilities per day for the projects in the group and its subgroups + Number of vulnerabilities per day for the projects in the group and its subgroups. """ vulnerabilitiesCountByDay( """ @@ -11139,7 +12171,7 @@ type Group { """ Number of vulnerabilities per severity level, per day, for the projects in the - group and its subgroups Deprecated in 13.3: Use `vulnerabilitiesCountByDay`. + group and its subgroups. Deprecated in 13.3: Use `vulnerabilitiesCountByDay`. """ vulnerabilitiesCountByDayAndSeverity( """ @@ -11174,7 +12206,7 @@ type Group { ): VulnerabilitiesCountByDayAndSeverityConnection @deprecated(reason: "Use `vulnerabilitiesCountByDay`. Deprecated in 13.3.") """ - Represents vulnerable project counts for each grade + Represents vulnerable project counts for each grade. """ vulnerabilityGrades( """ @@ -11184,7 +12216,7 @@ type Group { ): [VulnerableProjectsByGrade!]! """ - Vulnerability scanners reported on the project vulnerabilties of the group and its subgroups + Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. """ vulnerabilityScanners( """ @@ -11209,7 +12241,7 @@ type Group { ): VulnerabilityScannerConnection """ - Counts for each vulnerability severity in the group and its subgroups + Counts for each vulnerability severity in the group and its subgroups. """ vulnerabilitySeveritiesCount( """ @@ -11239,13 +12271,13 @@ type Group { ): VulnerabilitySeveritiesCount """ - Web URL of the group + Web URL of the group. """ webUrl: String! } """ -Identifier of Group +Identifier of Group. """ scalar GroupID @@ -11254,42 +12286,42 @@ Represents a Group Membership """ type GroupMember implements MemberInterface { """ - GitLab::Access level + GitLab::Access level. """ accessLevel: AccessLevel """ - Date and time the membership was created + Date and time the membership was created. """ createdAt: Time """ - User that authorized membership + User that authorized membership. """ createdBy: User """ - Date and time the membership expires + Date and time the membership expires. """ expiresAt: Time """ - Group that a User is a member of + Group that a User is a member of. """ group: Group """ - ID of the member + ID of the member. """ id: ID! """ - Date and time the membership was last updated + Date and time the membership was last updated. """ updatedAt: Time """ - User that is associated with the member object + User that is associated with the member object. """ user: User! @@ -11383,7 +12415,7 @@ Contains statistics about a group """ type GroupStats { """ - Statistics related to releases within the group + Statistics related to releases within the group. """ releaseStats: GroupReleaseStats } @@ -11545,6 +12577,16 @@ input HttpIntegrationUpdateInput { The name of the integration. """ name: String + + """ + The custom mapping of GitLab alert attributes to fields from the payload_example. + """ + payloadAttributeMappings: [AlertManagementPayloadAlertFieldInput!] + + """ + The example of an alert payload. + """ + payloadExample: JsonString } """ @@ -11573,7 +12615,7 @@ An ISO 8601-encoded date scalar ISO8601Date """ -Identifier of IncidentManagement::OncallParticipant +Identifier of IncidentManagement::OncallParticipant. """ scalar IncidentManagementOncallParticipantID @@ -11627,6 +12669,41 @@ type IncidentManagementOncallRotation { ): OncallParticipantTypeConnection """ + Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. + """ + shifts( + """ + 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 + + """ + End of timeframe to include shifts for. Cannot exceed one month after start. + """ + endTime: Time! + + """ + Returns the first _n_ elements from the list. + """ + first: Int + + """ + Returns the last _n_ elements from the list. + """ + last: Int + + """ + Start of timeframe to include shifts for. + """ + startTime: Time! + ): IncidentManagementOncallShiftConnection + + """ Start date of the on-call rotation. """ startsAt: Time @@ -11668,7 +12745,7 @@ type IncidentManagementOncallRotationEdge { } """ -Identifier of IncidentManagement::OncallRotation +Identifier of IncidentManagement::OncallRotation. """ scalar IncidentManagementOncallRotationID @@ -11677,22 +12754,22 @@ Describes an incident management on-call schedule """ type IncidentManagementOncallSchedule { """ - Description of the on-call schedule + Description of the on-call schedule. """ description: String """ - Internal ID of the on-call schedule + Internal ID of the on-call schedule. """ iid: ID! """ - Name of the on-call schedule + Name of the on-call schedule. """ name: String! """ - On-call rotations for the on-call schedule + On-call rotations for the on-call schedule. """ rotations( """ @@ -11717,7 +12794,7 @@ type IncidentManagementOncallSchedule { ): IncidentManagementOncallRotationConnection! """ - Time zone of the on-call schedule + Time zone of the on-call schedule. """ timezone: String! } @@ -11757,9 +12834,64 @@ type IncidentManagementOncallScheduleEdge { node: IncidentManagementOncallSchedule } +""" +A block of time for which a participant is on-call. +""" +type IncidentManagementOncallShift { + """ + End time of the on-call shift. + """ + endsAt: Time + + """ + Participant assigned to the on-call shift. + """ + participant: OncallParticipantType + + """ + Start time of the on-call shift. + """ + startsAt: Time +} + +""" +The connection type for IncidentManagementOncallShift. +""" +type IncidentManagementOncallShiftConnection { + """ + A list of edges. + """ + edges: [IncidentManagementOncallShiftEdge] + + """ + A list of nodes. + """ + nodes: [IncidentManagementOncallShift] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type IncidentManagementOncallShiftEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: IncidentManagementOncallShift +} + type InstanceSecurityDashboard { """ - Projects selected in Instance Security Dashboard + Projects selected in Instance Security Dashboard. """ projects( """ @@ -11784,12 +12916,12 @@ type InstanceSecurityDashboard { ): ProjectConnection! """ - Represents vulnerable project counts for each grade + Represents vulnerable project counts for each grade. """ vulnerabilityGrades: [VulnerableProjectsByGrade!]! """ - Vulnerability scanners reported on the vulnerabilties from projects selected in Instance Security Dashboard + Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. """ vulnerabilityScanners( """ @@ -11814,7 +12946,7 @@ type InstanceSecurityDashboard { ): VulnerabilityScannerConnection """ - Counts for each vulnerability severity from projects selected in Instance Security Dashboard + Counts for each vulnerability severity from projects selected in Instance Security Dashboard. """ vulnerabilitySeveritiesCount( """ @@ -11849,17 +12981,17 @@ Represents a recorded measurement (object count) for the Admins """ type InstanceStatisticsMeasurement { """ - Object count + Object count. """ count: Int! """ - The type of objects being measured + The type of objects being measured. """ identifier: MeasurementIdentifier! """ - The time the measurement was recorded + The time the measurement was recorded. """ recordedAt: Time } @@ -11941,12 +13073,12 @@ enum IssuableState { type Issue implements CurrentUserTodos & Noteable { """ - Alert associated to this issue + Alert associated to this issue. """ alertManagementAlert: AlertManagementAlert """ - Assignees of the issue + Assignees of the issue. """ assignees( """ @@ -11971,7 +13103,7 @@ type Issue implements CurrentUserTodos & Noteable { ): UserConnection """ - User that created the issue + User that created the issue. """ author: User! @@ -11986,27 +13118,27 @@ type Issue implements CurrentUserTodos & Noteable { blockedByCount: Int """ - Timestamp of when the issue was closed + Timestamp of when the issue was closed. """ closedAt: Time """ - Indicates the issue is confidential + Indicates the issue is confidential. """ confidential: Boolean! """ - User specific email address for the issue + User specific email address for the issue. """ createNoteEmail: String """ - Timestamp of when the issue was created + Timestamp of when the issue was created. """ createdAt: Time! """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -12030,13 +13162,13 @@ type Issue implements CurrentUserTodos & Noteable { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! """ - Description of the issue + Description of the issue. """ description: String @@ -12046,17 +13178,17 @@ type Issue implements CurrentUserTodos & Noteable { descriptionHtml: String """ - Collection of design images associated with this issue + Collection of design images associated with this issue. """ designCollection: DesignCollection """ - Indicates discussion is locked on the issue + Indicates discussion is locked on the issue. """ discussionLocked: Boolean! """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -12081,17 +13213,17 @@ type Issue implements CurrentUserTodos & Noteable { ): DiscussionConnection! """ - Number of downvotes the issue has received + Number of downvotes the issue has received. """ downvotes: Int! """ - Due date of the issue + Due date of the issue. """ dueDate: Time """ - Indicates if a project has email notifications disabled: `true` if email notifications are disabled + Indicates if a project has email notifications disabled: `true` if email notifications are disabled. """ emailsDisabled: Boolean! @@ -12106,22 +13238,22 @@ type Issue implements CurrentUserTodos & Noteable { healthStatus: HealthStatus """ - Human-readable time estimate of the issue + Human-readable time estimate of the issue. """ humanTimeEstimate: String """ - Human-readable total time reported as spent on the issue + Human-readable total time reported as spent on the issue. """ humanTotalTimeSpent: String """ - ID of the issue + ID of the issue. """ id: ID! """ - Internal ID of the issue + Internal ID of the issue. """ iid: ID! @@ -12131,7 +13263,7 @@ type Issue implements CurrentUserTodos & Noteable { iteration: Iteration """ - Labels of the issue + Labels of the issue. """ labels( """ @@ -12161,22 +13293,22 @@ type Issue implements CurrentUserTodos & Noteable { metricImages: [MetricImage!] """ - Milestone of the issue + Milestone of the issue. """ milestone: Milestone """ - Indicates if issue got moved from other project + Indicates if issue got moved from other project. """ moved: Boolean """ - Updated Issue after it got moved to another project + Updated Issue after it got moved to another project. """ movedTo: Issue """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -12201,7 +13333,7 @@ type Issue implements CurrentUserTodos & Noteable { ): NoteConnection! """ - List of participants in the issue + List of participants in the issue. """ participants( """ @@ -12226,22 +13358,22 @@ type Issue implements CurrentUserTodos & Noteable { ): UserConnection """ - Internal reference of the issue. Returned in shortened format by default + Internal reference of the issue. Returned in shortened format by default. """ reference( """ - Boolean option specifying whether the reference should be returned in full + Boolean option specifying whether the reference should be returned in full. """ full: Boolean = false ): String! """ - Relative position of the issue (used for positioning in epic tree and issue boards) + Relative position of the issue (used for positioning in epic tree and issue boards). """ relativePosition: Int """ - Severity level of the incident + Severity level of the incident. """ severity: IssuableSeverity @@ -12251,7 +13383,7 @@ type Issue implements CurrentUserTodos & Noteable { slaDueAt: Time """ - State of the issue + State of the issue. """ state: IssueState! @@ -12261,22 +13393,22 @@ type Issue implements CurrentUserTodos & Noteable { statusPagePublishedIncident: Boolean """ - Indicates the currently logged in user is subscribed to the issue + Indicates the currently logged in user is subscribed to the issue. """ subscribed: Boolean! """ - Task completion status of the issue + Task completion status of the issue. """ taskCompletionStatus: TaskCompletionStatus! """ - Time estimate of the issue + Time estimate of the issue. """ timeEstimate: Int! """ - Title of the issue + Title of the issue. """ title: String! @@ -12286,37 +13418,37 @@ type Issue implements CurrentUserTodos & Noteable { titleHtml: String """ - Total time reported as spent on the issue + Total time reported as spent on the issue. """ totalTimeSpent: Int! """ - Type of the issue + Type of the issue. """ type: IssueType """ - Timestamp of when the issue was last updated + Timestamp of when the issue was last updated. """ updatedAt: Time! """ - User that last updated the issue + User that last updated the issue. """ updatedBy: User """ - Number of upvotes the issue has received + Number of upvotes the issue has received. """ upvotes: Int! """ - Number of user discussions in the issue + Number of user discussions in the issue. """ userDiscussionsCount: Int! """ - Number of user notes of the issue + Number of user notes of the issue. """ userNotesCount: Int! @@ -12326,12 +13458,12 @@ type Issue implements CurrentUserTodos & Noteable { userPermissions: IssuePermissions! """ - Web path of the issue + Web path of the issue. """ webPath: String! """ - Web URL of the issue + Web URL of the issue. """ webUrl: String! @@ -12346,7 +13478,7 @@ The connection type for Issue. """ type IssueConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -12366,7 +13498,7 @@ type IssueConnection { pageInfo: PageInfo! """ - Total weight of issues collection + Total weight of issues collection. """ weight: Int! } @@ -12387,7 +13519,7 @@ type IssueEdge { } """ -Identifier of Issue +Identifier of Issue. """ scalar IssueID @@ -13161,12 +14293,12 @@ Represents an iteration object """ type Iteration implements TimeboxReportInterface { """ - Timestamp of iteration creation + Timestamp of iteration creation. """ createdAt: Time! """ - Description of the iteration + Description of the iteration. """ description: String @@ -13176,62 +14308,62 @@ type Iteration implements TimeboxReportInterface { descriptionHtml: String """ - Timestamp of the iteration due date + Timestamp of the iteration due date. """ dueDate: Time """ - ID of the iteration + ID of the iteration. """ id: ID! """ - Internal ID of the iteration + Internal ID of the iteration. """ iid: ID! """ - Historically accurate report about the timebox + Historically accurate report about the timebox. """ report: TimeboxReport """ - Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts + Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. """ scopedPath: String """ - Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts + Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. """ scopedUrl: String """ - Timestamp of the iteration start date + Timestamp of the iteration start date. """ startDate: Time """ - State of the iteration + State of the iteration. """ state: IterationState! """ - Title of the iteration + Title of the iteration. """ title: String! """ - Timestamp of last iteration update + Timestamp of last iteration update. """ updatedAt: Time! """ - Web path of the iteration + Web path of the iteration. """ webPath: String! """ - Web URL of the iteration + Web URL of the iteration. """ webUrl: String! } @@ -13272,7 +14404,7 @@ type IterationEdge { } """ -Identifier of Iteration +Identifier of Iteration. """ scalar IterationID @@ -13314,37 +14446,37 @@ scalar JSON type JiraImport { """ - Timestamp of when the Jira import was created + Timestamp of when the Jira import was created. """ createdAt: Time """ - Count of issues that failed to import + Count of issues that failed to import. """ failedToImportCount: Int! """ - Count of issues that were successfully imported + Count of issues that were successfully imported. """ importedIssuesCount: Int! """ - Project key for the imported Jira project + Project key for the imported Jira project. """ jiraProjectKey: String! """ - Timestamp of when the Jira import was scheduled + Timestamp of when the Jira import was scheduled. """ scheduledAt: Time """ - User that started the Jira import + User that started the Jira import. """ scheduledBy: User """ - Total count of issues that were attempted to import + Total count of issues that were attempted to import. """ totalIssueCount: Int! } @@ -13476,17 +14608,17 @@ type JiraImportUsersPayload { type JiraProject { """ - Key of the Jira project + Key of the Jira project. """ key: String! """ - Name of the Jira project + Name of the Jira project. """ name: String """ - ID of the Jira project + ID of the Jira project. """ projectId: Int! } @@ -13528,12 +14660,12 @@ type JiraProjectEdge { type JiraService implements Service { """ - Indicates if the service is active + Indicates if the service is active. """ active: Boolean """ - List of all Jira projects fetched through Jira REST API + List of all Jira projects fetched through Jira REST API. """ projects( """ @@ -13563,51 +14695,51 @@ type JiraService implements Service { ): JiraProjectConnection """ - Class name of the service + Class name of the service. """ type: String } type JiraUser { """ - ID of the matched GitLab user + ID of the matched GitLab user. """ gitlabId: Int """ - Name of the matched GitLab user + Name of the matched GitLab user. """ gitlabName: String """ - Username of the matched GitLab user + Username of the matched GitLab user. """ gitlabUsername: String """ - Account ID of the Jira user + Account ID of the Jira user. """ jiraAccountId: String! """ - Display name of the Jira user + Display name of the Jira user. """ jiraDisplayName: String! """ - Email of the Jira user, returned only for users with public emails + Email of the Jira user, returned only for users with public emails. """ jiraEmail: String } input JiraUsersMappingInputType { """ - Id of the GitLab user + Id of the GitLab user. """ gitlabId: Int """ - Jira account ID of the user + Jira account ID of the user. """ jiraAccountId: String! } @@ -13649,12 +14781,12 @@ scalar JsonString type Label { """ - Background color of the label + Background color of the label. """ color: String! """ - Description of the label (Markdown rendered as HTML for caching) + Description of the label (Markdown rendered as HTML for caching). """ description: String @@ -13664,17 +14796,17 @@ type Label { descriptionHtml: String """ - Label ID + Label ID. """ id: ID! """ - Text color of the label + Text color of the label. """ textColor: String! """ - Content of the label + Content of the label. """ title: String! } @@ -13684,7 +14816,7 @@ The connection type for Label. """ type LabelConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -13718,7 +14850,7 @@ input LabelCreateInput { (e.g. #FFAABB) or one of the CSS color names in https://developer.mozilla.org/en-US/docs/Web/CSS/color_value#Color_keywords. """ - color: String = "#428BCA" + color: String = "#6699cc" """ Description of the label. @@ -13726,12 +14858,12 @@ input LabelCreateInput { description: String """ - The group full path the resource is associated with. + Full path of the group with which the resource is associated. """ groupPath: ID """ - The project full path the resource is associated with. + Full path of the project with which the resource is associated. """ projectPath: ID @@ -13777,12 +14909,12 @@ type LabelEdge { } """ -Identifier of Label +Identifier of Label. """ scalar LabelID """ -Identifier of List +Identifier of List. """ scalar ListID @@ -13887,37 +15019,37 @@ enum MeasurementIdentifier { interface MemberInterface { """ - GitLab::Access level + GitLab::Access level. """ accessLevel: AccessLevel """ - Date and time the membership was created + Date and time the membership was created. """ createdAt: Time """ - User that authorized membership + User that authorized membership. """ createdBy: User """ - Date and time the membership expires + Date and time the membership expires. """ expiresAt: Time """ - ID of the member + ID of the member. """ id: ID! """ - Date and time the membership was last updated + Date and time the membership was last updated. """ updatedAt: Time """ - User that is associated with the member object + User that is associated with the member object. """ user: User! } @@ -13959,17 +15091,17 @@ type MemberInterfaceEdge { type MergeRequest implements CurrentUserTodos & Noteable { """ - Indicates if members of the target project can push to the fork + Indicates if members of the target project can push to the fork. """ allowCollaboration: Boolean """ - Number of approvals left + Number of approvals left. """ approvalsLeft: Int """ - Number of approvals required + Number of approvals required. """ approvalsRequired: Int @@ -13979,7 +15111,7 @@ type MergeRequest implements CurrentUserTodos & Noteable { approved: Boolean! """ - Users who approved the merge request + Users who approved the merge request. """ approvedBy( """ @@ -14004,7 +15136,7 @@ type MergeRequest implements CurrentUserTodos & Noteable { ): UserConnection """ - Assignees of the merge request + Assignees of the merge request. """ assignees( """ @@ -14029,32 +15161,32 @@ type MergeRequest implements CurrentUserTodos & Noteable { ): UserConnection """ - User who created this merge request + User who created this merge request. """ author: User """ - Indicates if auto merge is enabled for the merge request + Indicates if auto merge is enabled for the merge request. """ autoMergeEnabled: Boolean! """ - Selected auto merge strategy + Selected auto merge strategy. """ autoMergeStrategy: String """ - Array of available auto merge strategies + Array of available auto merge strategies. """ availableAutoMergeStrategies: [String!] """ - Number of commits in the merge request + Number of commits in the merge request. """ commitCount: Int """ - Merge request commits excluding merge commits + Merge request commits excluding merge commits. """ commitsWithoutMergeCommits( """ @@ -14079,17 +15211,17 @@ type MergeRequest implements CurrentUserTodos & Noteable { ): CommitConnection """ - Indicates if the merge request has conflicts + Indicates if the merge request has conflicts. """ conflicts: Boolean! """ - Timestamp of when the merge request was created + Timestamp of when the merge request was created. """ createdAt: Time! """ - Todos for the current user + To-do items for the current user. """ currentUserTodos( """ @@ -14113,28 +15245,28 @@ type MergeRequest implements CurrentUserTodos & Noteable { last: Int """ - State of the todos + State of the to-do items. """ state: TodoStateEnum ): TodoConnection! """ - Default merge commit message of the merge request + Default merge commit message of the merge request. """ defaultMergeCommitMessage: String """ - Default merge commit message of the merge request with description + Default merge commit message of the merge request with description. """ defaultMergeCommitMessageWithDescription: String """ - Default squash commit message of the merge request + Default squash commit message of the merge request. """ defaultSquashCommitMessage: String """ - Description of the merge request (Markdown rendered as HTML for caching) + Description of the merge request (Markdown rendered as HTML for caching). """ description: String @@ -14144,37 +15276,37 @@ type MergeRequest implements CurrentUserTodos & Noteable { descriptionHtml: String """ - Diff head SHA of the merge request + Diff head SHA of the merge request. """ diffHeadSha: String """ - References of the base SHA, the head SHA, and the start SHA for this merge request + References of the base SHA, the head SHA, and the start SHA for this merge request. """ diffRefs: DiffRefs """ - Details about which files were changed in this merge request + Details about which files were changed in this merge request. """ diffStats( """ - A specific file-path + A specific file-path. """ path: String ): [DiffStats!] """ - Summary of which files were changed in this merge request + Summary of which files were changed in this merge request. """ diffStatsSummary: DiffStatsSummary """ - Indicates if comments on the merge request are locked to members only + Indicates if comments on the merge request are locked to members only. """ discussionLocked: Boolean! """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -14199,42 +15331,47 @@ type MergeRequest implements CurrentUserTodos & Noteable { ): DiscussionConnection! """ - Number of downvotes for the merge request + Number of downvotes for the merge request. """ downvotes: Int! """ - Indicates if the project settings will lead to source branch deletion after merge + Indicates if the project settings will lead to source branch deletion after merge. """ forceRemoveSourceBranch: Boolean """ - Indicates if the merge request has CI + Indicates if the merge request has CI. """ hasCi: Boolean! """ - The pipeline running on the branch HEAD of the merge request + Indicates if the source branch has any security reports. + """ + hasSecurityReports: Boolean! + + """ + The pipeline running on the branch HEAD of the merge request. """ headPipeline: Pipeline """ - ID of the merge request + ID of the merge request. """ id: ID! """ - Internal ID of the merge request + Internal ID of the merge request. """ iid: String! """ - Commit SHA of the merge request if merge is in progress + Commit SHA of the merge request if merge is in progress. """ inProgressMergeCommitSha: String """ - Labels of the merge request + Labels of the merge request. """ labels( """ @@ -14259,61 +15396,62 @@ type MergeRequest implements CurrentUserTodos & Noteable { ): LabelConnection """ - SHA of the merge request commit (set once merged) + SHA of the merge request commit (set once merged). """ mergeCommitSha: String """ - Error message due to a merge error + Error message due to a merge error. """ mergeError: String """ - Indicates if a merge is currently occurring + Indicates if a merge is currently occurring. """ mergeOngoing: Boolean! """ - Status of the merge request + Status of the merge request. """ mergeStatus: String """ + Number of merge requests in the merge train. """ mergeTrainsCount: Int """ - User who merged this merge request + User who merged this merge request. """ mergeUser: User """ - Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS) + Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). """ mergeWhenPipelineSucceeds: Boolean """ - Indicates if the merge request is mergeable + Indicates if the merge request is mergeable. """ mergeable: Boolean! """ - Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged + Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. """ mergeableDiscussionsState: Boolean """ - Timestamp of when the merge request was merged, null if not merged + Timestamp of when the merge request was merged, null if not merged. """ mergedAt: Time """ - The milestone of the merge request + The milestone of the merge request. """ milestone: Milestone """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -14404,31 +15542,31 @@ type MergeRequest implements CurrentUserTodos & Noteable { ): PipelineConnection """ - Alias for target_project + Alias for target_project. """ project: Project! """ - ID of the merge request project + ID of the merge request project. """ projectId: Int! """ - Rebase commit SHA of the merge request + Rebase commit SHA of the merge request. """ rebaseCommitSha: String """ - Indicates if there is a rebase currently in progress for the merge request + Indicates if there is a rebase currently in progress for the merge request. """ rebaseInProgress: Boolean! """ - Internal reference of the merge request. Returned in shortened format by default + Internal reference of the merge request. Returned in shortened format by default. """ reference( """ - Boolean option specifying whether the reference should be returned in full + Boolean option specifying whether the reference should be returned in full. """ full: Boolean = false ): String! @@ -14464,77 +15602,77 @@ type MergeRequest implements CurrentUserTodos & Noteable { securityAutoFix: Boolean """ - Indicates if the merge request will be rebased + Indicates if the merge request will be rebased. """ shouldBeRebased: Boolean! """ - Indicates if the source branch of the merge request will be deleted after merge + Indicates if the source branch of the merge request will be deleted after merge. """ shouldRemoveSourceBranch: Boolean """ - Source branch of the merge request + Source branch of the merge request. """ sourceBranch: String! """ - Indicates if the source branch of the merge request exists + Indicates if the source branch of the merge request exists. """ sourceBranchExists: Boolean! """ - Indicates if the source branch is protected + Indicates if the source branch is protected. """ sourceBranchProtected: Boolean! """ - Source project of the merge request + Source project of the merge request. """ sourceProject: Project """ - ID of the merge request source project + ID of the merge request source project. """ sourceProjectId: Int """ - Indicates if squash on merge is enabled + Indicates if squash on merge is enabled. """ squash: Boolean! """ - Indicates if squash on merge is enabled + Indicates if squash on merge is enabled. """ squashOnMerge: Boolean! """ - State of the merge request + State of the merge request. """ state: MergeRequestState! """ - Indicates if the currently logged in user is subscribed to this merge request + Indicates if the currently logged in user is subscribed to this merge request. """ subscribed: Boolean! """ - Target branch of the merge request + Target branch of the merge request. """ targetBranch: String! """ - Indicates if the target branch of the merge request exists + Indicates if the target branch of the merge request exists. """ targetBranchExists: Boolean! """ - Target project of the merge request + Target project of the merge request. """ targetProject: Project! """ - ID of the merge request target project + ID of the merge request target project. """ targetProjectId: Int! @@ -14544,12 +15682,12 @@ type MergeRequest implements CurrentUserTodos & Noteable { taskCompletionStatus: TaskCompletionStatus! """ - Time estimate of the merge request + Time estimate of the merge request. """ timeEstimate: Int! """ - Title of the merge request + Title of the merge request. """ title: String! @@ -14559,27 +15697,27 @@ type MergeRequest implements CurrentUserTodos & Noteable { titleHtml: String """ - Total time reported as spent on the merge request + Total time reported as spent on the merge request. """ totalTimeSpent: Int! """ - Timestamp of when the merge request was last updated + Timestamp of when the merge request was last updated. """ updatedAt: Time! """ - Number of upvotes for the merge request + Number of upvotes for the merge request. """ upvotes: Int! """ - Number of user discussions in the merge request + Number of user discussions in the merge request. """ userDiscussionsCount: Int """ - User notes count of the merge request + User notes count of the merge request. """ userNotesCount: Int @@ -14589,12 +15727,12 @@ type MergeRequest implements CurrentUserTodos & Noteable { userPermissions: MergeRequestPermissions! """ - Web URL of the merge request + Web URL of the merge request. """ webUrl: String """ - Indicates if the merge request is a work in progress (WIP) + Indicates if the merge request is a work in progress (WIP). """ workInProgress: Boolean! } @@ -14604,7 +15742,7 @@ The connection type for MergeRequest. """ type MergeRequestConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -14624,7 +15762,7 @@ type MergeRequestConnection { pageInfo: PageInfo! """ - Total sum of time to merge, in seconds, for the collection of merge requests + Total sum of time to merge, in seconds, for the collection of merge requests. """ totalTimeToMerge: Float } @@ -14639,12 +15777,12 @@ input MergeRequestCreateInput { clientMutationId: String """ - Description of the merge request (Markdown rendered as HTML for caching) + Description of the merge request (Markdown rendered as HTML for caching). """ description: String """ - Labels of the merge request + Labels of the merge request. """ labels: [String!] @@ -14654,17 +15792,17 @@ input MergeRequestCreateInput { projectPath: ID! """ - Source branch of the merge request + Source branch of the merge request. """ sourceBranch: String! """ - Target branch of the merge request + Target branch of the merge request. """ targetBranch: String! """ - Title of the merge request + Title of the merge request. """ title: String! } @@ -14714,7 +15852,7 @@ type MergeRequestDiffRegistry { lastSyncedAt: Time """ - ID of the Merge Request diff + ID of the Merge Request diff. """ mergeRequestDiffId: ID! @@ -14785,11 +15923,26 @@ type MergeRequestEdge { } """ -Identifier of MergeRequest +Identifier of MergeRequest. """ scalar MergeRequestID """ +New state to apply to a merge request. +""" +enum MergeRequestNewState { + """ + Close the merge request if it is open. + """ + CLOSED + + """ + Open the merge request if it is closed. + """ + OPEN +} + +""" Check permissions for the current user on a merge request """ type MergeRequestPermissions { @@ -14840,6 +15993,51 @@ type MergeRequestPermissions { } """ +Autogenerated input type of MergeRequestReviewerRereview +""" +input MergeRequestReviewerRereviewInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The IID of the merge request to mutate. + """ + iid: String! + + """ + The project the merge request to mutate is in. + """ + projectPath: ID! + + """ + The user ID for the user that has been requested for a new review. + """ + userId: UserID! +} + +""" +Autogenerated return type of MergeRequestReviewerRereview +""" +type MergeRequestReviewerRereviewPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + The merge request after mutation. + """ + mergeRequest: MergeRequest +} + +""" Autogenerated input type of MergeRequestSetAssignees """ input MergeRequestSetAssigneesInput { @@ -15211,6 +16409,10 @@ enum MergeRequestState { all closed locked + + """ + Merge Request has been merged + """ merged opened } @@ -15225,7 +16427,7 @@ input MergeRequestUpdateInput { clientMutationId: String """ - Description of the merge request (Markdown rendered as HTML for caching) + Description of the merge request (Markdown rendered as HTML for caching). """ description: String @@ -15240,12 +16442,17 @@ input MergeRequestUpdateInput { projectPath: ID! """ - Target branch of the merge request + The action to perform to change the state. + """ + state: MergeRequestNewState + + """ + Target branch of the merge request. """ targetBranch: String """ - Title of the merge request + Title of the merge request. """ title: String } @@ -15272,12 +16479,12 @@ type MergeRequestUpdatePayload { type Metadata { """ - Revision + Revision. """ revision: String! """ - Version + Version. """ version: String! } @@ -15287,34 +16494,34 @@ Represents a metric image upload """ type MetricImage { """ - File name of the metric image + File name of the metric image. """ fileName: String """ - File path of the metric image + File path of the metric image. """ filePath: String """ - ID of the metric upload + ID of the metric upload. """ id: ID! """ - Internal ID of the metric upload + Internal ID of the metric upload. """ iid: ID! """ - URL of the metric source + URL of the metric source. """ url: String! } type MetricsDashboard { """ - Annotations added to the dashboard + Annotations added to the dashboard. """ annotations( """ @@ -15349,39 +16556,39 @@ type MetricsDashboard { ): MetricsDashboardAnnotationConnection """ - Path to a file with the dashboard definition + Path to a file with the dashboard definition. """ path: String """ - Dashboard schema validation warnings + Dashboard schema validation warnings. """ schemaValidationWarnings: [String!] } type MetricsDashboardAnnotation { """ - Description of the annotation + Description of the annotation. """ description: String """ - Timestamp marking end of annotated time span + Timestamp marking end of annotated time span. """ endingAt: Time """ - ID of the annotation + ID of the annotation. """ id: ID! """ - ID of a dashboard panel to which the annotation should be scoped + ID of a dashboard panel to which the annotation should be scoped. """ panelId: String """ - Timestamp marking start of annotated time span + Timestamp marking start of annotated time span. """ startingAt: Time } @@ -15422,7 +16629,7 @@ type MetricsDashboardAnnotationEdge { } """ -Identifier of Metrics::Dashboard::Annotation +Identifier of Metrics::Dashboard::Annotation. """ scalar MetricsDashboardAnnotationID @@ -15431,72 +16638,72 @@ Represents a milestone """ type Milestone implements TimeboxReportInterface { """ - Timestamp of milestone creation + Timestamp of milestone creation. """ createdAt: Time! """ - Description of the milestone + Description of the milestone. """ description: String """ - Timestamp of the milestone due date + Timestamp of the milestone due date. """ dueDate: Time """ - Indicates if milestone is at group level + Indicates if milestone is at group level. """ groupMilestone: Boolean! """ - ID of the milestone + ID of the milestone. """ id: ID! """ - Indicates if milestone is at project level + Indicates if milestone is at project level. """ projectMilestone: Boolean! """ - Historically accurate report about the timebox + Historically accurate report about the timebox. """ report: TimeboxReport """ - Timestamp of the milestone start date + Timestamp of the milestone start date. """ startDate: Time """ - State of the milestone + State of the milestone. """ state: MilestoneStateEnum! """ - Milestone statistics + Milestone statistics. """ stats: MilestoneStats """ - Indicates if milestone is at subgroup level + Indicates if milestone is at subgroup level. """ subgroupMilestone: Boolean! """ - Title of the milestone + Title of the milestone. """ title: String! """ - Timestamp of last milestone update + Timestamp of last milestone update. """ updatedAt: Time! """ - Web path of the milestone + Web path of the milestone. """ webPath: String! } @@ -15537,12 +16744,22 @@ type MilestoneEdge { } """ -Identifier of Milestone +Identifier of Milestone. """ scalar MilestoneID +""" +Current state of milestone +""" enum MilestoneStateEnum { + """ + Milestone is currently active + """ active + + """ + Milestone is closed + """ closed } @@ -15551,12 +16768,12 @@ Contains statistics about a milestone """ type MilestoneStats { """ - Number of closed issues associated with the milestone + Number of closed issues associated with the milestone. """ closedIssuesCount: Int """ - Total number of issues associated with the milestone + Total number of issues associated with the milestone. """ totalIssuesCount: Int } @@ -15582,6 +16799,7 @@ type Mutation { adminSidekiqQueuesDeleteJobs(input: AdminSidekiqQueuesDeleteJobsInput!): AdminSidekiqQueuesDeleteJobsPayload alertSetAssignees(input: AlertSetAssigneesInput!): AlertSetAssigneesPayload alertTodoCreate(input: AlertTodoCreateInput!): AlertTodoCreatePayload + apiFuzzingCiConfigurationCreate(input: ApiFuzzingCiConfigurationCreateInput!): ApiFuzzingCiConfigurationCreatePayload awardEmojiAdd(input: AwardEmojiAddInput!): AwardEmojiAddPayload awardEmojiRemove(input: AwardEmojiRemoveInput!): AwardEmojiRemovePayload awardEmojiToggle(input: AwardEmojiToggleInput!): AwardEmojiTogglePayload @@ -15615,6 +16833,10 @@ type Mutation { createSnippet(input: CreateSnippetInput!): CreateSnippetPayload createTestCase(input: CreateTestCaseInput!): CreateTestCasePayload dastOnDemandScanCreate(input: DastOnDemandScanCreateInput!): DastOnDemandScanCreatePayload + dastProfileCreate(input: DastProfileCreateInput!): DastProfileCreatePayload + dastProfileDelete(input: DastProfileDeleteInput!): DastProfileDeletePayload + dastProfileRun(input: DastProfileRunInput!): DastProfileRunPayload + dastProfileUpdate(input: DastProfileUpdateInput!): DastProfileUpdatePayload dastScannerProfileCreate(input: DastScannerProfileCreateInput!): DastScannerProfileCreatePayload dastScannerProfileDelete(input: DastScannerProfileDeleteInput!): DastScannerProfileDeletePayload dastScannerProfileUpdate(input: DastScannerProfileUpdateInput!): DastScannerProfileUpdatePayload @@ -15623,6 +16845,7 @@ type Mutation { dastSiteProfileUpdate(input: DastSiteProfileUpdateInput!): DastSiteProfileUpdatePayload dastSiteTokenCreate(input: DastSiteTokenCreateInput!): DastSiteTokenCreatePayload dastSiteValidationCreate(input: DastSiteValidationCreateInput!): DastSiteValidationCreatePayload + dastSiteValidationRevoke(input: DastSiteValidationRevokeInput!): DastSiteValidationRevokePayload deleteAnnotation(input: DeleteAnnotationInput!): DeleteAnnotationPayload deleteDevopsAdoptionSegment(input: DeleteDevopsAdoptionSegmentInput!): DeleteDevopsAdoptionSegmentPayload designManagementDelete(input: DesignManagementDeleteInput!): DesignManagementDeletePayload @@ -15643,9 +16866,12 @@ type Mutation { dismissVulnerability(input: DismissVulnerabilityInput!): DismissVulnerabilityPayload @deprecated(reason: "Use vulnerabilityDismiss. Deprecated in 13.5.") environmentsCanaryIngressUpdate(input: EnvironmentsCanaryIngressUpdateInput!): EnvironmentsCanaryIngressUpdatePayload epicAddIssue(input: EpicAddIssueInput!): EpicAddIssuePayload + epicBoardCreate(input: EpicBoardCreateInput!): EpicBoardCreatePayload + epicBoardListCreate(input: EpicBoardListCreateInput!): EpicBoardListCreatePayload epicSetSubscription(input: EpicSetSubscriptionInput!): EpicSetSubscriptionPayload epicTreeReorder(input: EpicTreeReorderInput!): EpicTreeReorderPayload exportRequirements(input: ExportRequirementsInput!): ExportRequirementsPayload + gitlabSubscriptionActivate(input: GitlabSubscriptionActivateInput!): GitlabSubscriptionActivatePayload httpIntegrationCreate(input: HttpIntegrationCreateInput!): HttpIntegrationCreatePayload httpIntegrationDestroy(input: HttpIntegrationDestroyInput!): HttpIntegrationDestroyPayload httpIntegrationResetToken(input: HttpIntegrationResetTokenInput!): HttpIntegrationResetTokenPayload @@ -15666,6 +16892,7 @@ type Mutation { labelCreate(input: LabelCreateInput!): LabelCreatePayload markAsSpamSnippet(input: MarkAsSpamSnippetInput!): MarkAsSpamSnippetPayload mergeRequestCreate(input: MergeRequestCreateInput!): MergeRequestCreatePayload + mergeRequestReviewerRereview(input: MergeRequestReviewerRereviewInput!): MergeRequestReviewerRereviewPayload mergeRequestSetAssignees(input: MergeRequestSetAssigneesInput!): MergeRequestSetAssigneesPayload mergeRequestSetLabels(input: MergeRequestSetLabelsInput!): MergeRequestSetLabelsPayload mergeRequestSetLocked(input: MergeRequestSetLockedInput!): MergeRequestSetLockedPayload @@ -15679,6 +16906,7 @@ type Mutation { mergeRequestUpdate(input: MergeRequestUpdateInput!): MergeRequestUpdatePayload namespaceIncreaseStorageTemporarily(input: NamespaceIncreaseStorageTemporarilyInput!): NamespaceIncreaseStorageTemporarilyPayload oncallRotationCreate(input: OncallRotationCreateInput!): OncallRotationCreatePayload + oncallRotationDestroy(input: OncallRotationDestroyInput!): OncallRotationDestroyPayload oncallScheduleCreate(input: OncallScheduleCreateInput!): OncallScheduleCreatePayload oncallScheduleDestroy(input: OncallScheduleDestroyInput!): OncallScheduleDestroyPayload oncallScheduleUpdate(input: OncallScheduleUpdateInput!): OncallScheduleUpdatePayload @@ -15716,7 +16944,6 @@ type Mutation { updateBoardList(input: UpdateBoardListInput!): UpdateBoardListPayload updateComplianceFramework(input: UpdateComplianceFrameworkInput!): UpdateComplianceFrameworkPayload updateContainerExpirationPolicy(input: UpdateContainerExpirationPolicyInput!): UpdateContainerExpirationPolicyPayload - updateDevopsAdoptionSegment(input: UpdateDevopsAdoptionSegmentInput!): UpdateDevopsAdoptionSegmentPayload updateEpic(input: UpdateEpicInput!): UpdateEpicPayload """ @@ -15766,12 +16993,12 @@ enum MutationOperationMode { type Namespace { """ - Size limit for repositories in the namespace in bytes + Size limit for repositories in the namespace in bytes. """ actualRepositorySizeLimit: Float """ - Additional storage purchased for the root namespace in bytes + Additional storage purchased for the root namespace in bytes. """ additionalPurchasedStorageSize: Float @@ -15807,12 +17034,12 @@ type Namespace { ): ComplianceFrameworkConnection """ - Includes at least one project where the repository size exceeds the limit + Includes at least one project where the repository size exceeds the limit. """ containsLockedProjects: Boolean! """ - Description of the namespace + Description of the namespace. """ description: String @@ -15822,47 +17049,47 @@ type Namespace { descriptionHtml: String """ - Full name of the namespace + Full name of the namespace. """ fullName: String! """ - Full path of the namespace + Full path of the namespace. """ fullPath: ID! """ - ID of the namespace + ID of the namespace. """ id: ID! """ - Status of the temporary storage increase + Status of the temporary storage increase. """ isTemporaryStorageIncreaseEnabled: Boolean! """ - Indicates if Large File Storage (LFS) is enabled for namespace + Indicates if Large File Storage (LFS) is enabled for namespace. """ lfsEnabled: Boolean """ - Name of the namespace + Name of the namespace. """ name: String! """ - The package settings for the namespace + The package settings for the namespace. """ packageSettings: PackageSettings """ - Path of the namespace + Path of the namespace. """ path: String! """ - Projects within this namespace + Projects within this namespace. """ projects( """ @@ -15907,42 +17134,42 @@ type Namespace { ): ProjectConnection! """ - Number of projects in the root namespace where the repository size exceeds the limit + Number of projects in the root namespace where the repository size exceeds the limit. """ repositorySizeExcessProjectCount: Int! """ - Indicates if users can request access to namespace + Indicates if users can request access to namespace. """ requestAccessEnabled: Boolean """ - Aggregated storage statistics of the namespace. Only available for root namespaces + Aggregated storage statistics of the namespace. Only available for root namespaces. """ rootStorageStatistics: RootStorageStatistics """ - Total storage limit of the root namespace in bytes + Total storage limit of the root namespace in bytes. """ storageSizeLimit: Float """ - Date until the temporary storage increase is active + Date until the temporary storage increase is active. """ temporaryStorageIncreaseEndsOn: Time """ - Total repository size of all projects in the root namespace in bytes + Total repository size of all projects in the root namespace in bytes. """ totalRepositorySize: Float """ - Total excess repository size of all projects in the root namespace in bytes + Total excess repository size of all projects in the root namespace in bytes. """ totalRepositorySizeExcess: Float """ - Visibility of the namespace + Visibility of the namespace. """ visibility: String } @@ -15983,7 +17210,7 @@ type NamespaceEdge { } """ -Identifier of Namespace +Identifier of Namespace. """ scalar NamespaceID @@ -16039,59 +17266,59 @@ enum NamespaceProjectSort { input NegatedBoardIssueInput { """ - Filter by assignee username + Filter by assignee username. """ assigneeUsername: [String] """ - Filter by author username + Filter by author username. """ authorUsername: String """ - Filter by epic ID. Incompatible with epicWildcardId + Filter by epic ID. Incompatible with epicWildcardId. """ epicId: EpicID """ - Filter by iteration title + Filter by iteration title. """ iterationTitle: String """ - Filter by label name + Filter by label name. """ labelName: [String] """ - Filter by milestone title + Filter by milestone title. """ milestoneTitle: String """ - Filter by reaction emoji + Filter by reaction emoji. """ myReactionEmoji: String """ - Filter by release tag + Filter by release tag. """ releaseTag: String """ - Filter by weight + Filter by weight. """ weight: String } type Note implements ResolvableInterface { """ - User who wrote this note + User who wrote this note. """ author: User! """ - Content of the note + Content of the note. """ body: String! @@ -16101,72 +17328,72 @@ type Note implements ResolvableInterface { bodyHtml: String """ - Indicates if this note is confidential + Indicates if this note is confidential. """ confidential: Boolean """ - Timestamp of the note creation + Timestamp of the note creation. """ createdAt: Time! """ - The discussion this note is a part of + The discussion this note is a part of. """ discussion: Discussion """ - ID of the note + ID of the note. """ - id: ID! + id: NoteID! """ - The position of this note on a diff + The position of this note on a diff. """ position: DiffPosition """ - Project associated with the note + Project associated with the note. """ project: Project """ - Indicates if the object can be resolved + Indicates if the object can be resolved. """ resolvable: Boolean! """ - Indicates if the object is resolved + Indicates if the object is resolved. """ resolved: Boolean! """ - Timestamp of when the object was resolved + Timestamp of when the object was resolved. """ resolvedAt: Time """ - User who resolved the object + User who resolved the object. """ resolvedBy: User """ - Indicates whether this note was created by the system or by a user + Indicates whether this note was created by the system or by a user. """ system: Boolean! """ - Name of the icon corresponding to a system note + Name of the icon corresponding to a system note. """ systemNoteIconName: String """ - Timestamp of the note's last activity + Timestamp of the note's last activity. """ updatedAt: Time! """ - URL to view this Note in the Web UI + URL to view this Note in the Web UI. """ url: String @@ -16212,7 +17439,7 @@ type NoteEdge { } """ -Identifier of Note +Identifier of Note. """ scalar NoteID @@ -16250,7 +17477,7 @@ type NotePermissions { interface Noteable { """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -16275,7 +17502,7 @@ interface Noteable { ): DiscussionConnection! """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -16301,7 +17528,7 @@ interface Noteable { } """ -Identifier of Noteable +Identifier of Noteable. """ scalar NoteableID @@ -16441,6 +17668,51 @@ input OncallRotationDateInputType { } """ +Autogenerated input type of OncallRotationDestroy +""" +input OncallRotationDestroyInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the on-call rotation to remove. + """ + id: IncidentManagementOncallRotationID! + + """ + The project to remove the on-call schedule from. + """ + projectPath: ID! + + """ + The IID of the on-call schedule to the on-call rotation belongs to. + """ + scheduleIid: String! +} + +""" +Autogenerated return type of OncallRotationDestroy +""" +type OncallRotationDestroyPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + Errors encountered during execution of the mutation. + """ + errors: [String!]! + + """ + The on-call rotation. + """ + oncallRotation: IncidentManagementOncallRotation +} + +""" The rotation length of the on-call rotation """ input OncallRotationLengthInputType { @@ -16645,142 +17917,27 @@ Represents a package in the Package Registry """ type Package { """ - The created date. + Date of creation. """ createdAt: Time! """ - The ID of the package. - """ - id: ID! - - """ - The name of the package. - """ - name: String! - - """ - The type of the package. - """ - packageType: PackageTypeEnum! - - """ - Pipelines that built the package. - """ - pipelines( - """ - 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 - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PipelineConnection - - """ - Project where the package is stored. - """ - project: Project! - - """ - The package tags. - """ - tags( - """ - 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 - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PackageTagConnection - - """ - The updated date. - """ - updatedAt: Time! - - """ - The version of the package. - """ - version: String - - """ - The other versions of the package. - """ - versions( - """ - 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 - - """ - Returns the last _n_ elements from the list. - """ - last: Int - ): PackageConnection -} - -""" -Details of a Composer package -""" -type PackageComposerDetails { - """ - The Composer metadatum. - """ - composerMetadatum: PackageComposerMetadatumType! - - """ - The created date. + ID of the package. """ - createdAt: Time! + id: PackagesPackageID! """ - The ID of the package. + Package metadata. """ - id: ID! + metadata: PackageMetadata """ - The name of the package. + Name of the package. """ name: String! """ - The type of the package. + Package type. """ packageType: PackageTypeEnum! @@ -16815,7 +17972,7 @@ type PackageComposerDetails { project: Project! """ - The package tags. + Package tags. """ tags( """ @@ -16840,12 +17997,12 @@ type PackageComposerDetails { ): PackageTagConnection """ - The updated date. + Date of most recent update. """ updatedAt: Time! """ - The version of the package. + Version string. """ version: String @@ -16872,7 +18029,7 @@ type PackageComposerDetails { Returns the last _n_ elements from the list. """ last: Int - ): PackageConnection + ): PackageWithoutVersionsConnection } """ @@ -16901,21 +18058,6 @@ type PackageComposerJsonType { } """ -Composer metadatum -""" -type PackageComposerMetadatumType { - """ - Data of the Composer JSON file. - """ - composerJson: PackageComposerJsonType! - - """ - Target SHA of the package. - """ - targetSha: String! -} - -""" The connection type for Package. """ type PackageConnection { @@ -16975,7 +18117,7 @@ type PackageFileRegistry { lastSyncedAt: Time """ - ID of the PackageFile + ID of the PackageFile. """ packageFileId: ID! @@ -17031,6 +18173,11 @@ type PackageFileRegistryEdge { } """ +Represents metadata associated with a Package +""" +union PackageMetadata = ComposerMetadata + +""" Namespace-level Package Registry settings """ type PackageSettings { @@ -17138,7 +18285,7 @@ enum PackageTypeEnum { MAVEN """ - Packages from the NPM package manager + Packages from the npm package manager """ NPM @@ -17151,10 +18298,145 @@ enum PackageTypeEnum { Packages from the PyPI package manager """ PYPI + + """ + Packages from the Rubygems package manager + """ + RUBYGEMS +} + +""" +Represents a version of a package in the Package Registry +""" +type PackageWithoutVersions { + """ + Date of creation. + """ + createdAt: Time! + + """ + ID of the package. + """ + id: PackagesPackageID! + + """ + Package metadata. + """ + metadata: PackageMetadata + + """ + Name of the package. + """ + name: String! + + """ + Package type. + """ + packageType: PackageTypeEnum! + + """ + Pipelines that built the package. + """ + pipelines( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): PipelineConnection + + """ + Project where the package is stored. + """ + project: Project! + + """ + Package tags. + """ + tags( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): PackageTagConnection + + """ + Date of most recent update. + """ + updatedAt: Time! + + """ + Version string. + """ + version: String } """ -Identifier of Packages::Package +The connection type for PackageWithoutVersions. +""" +type PackageWithoutVersionsConnection { + """ + A list of edges. + """ + edges: [PackageWithoutVersionsEdge] + + """ + A list of nodes. + """ + nodes: [PackageWithoutVersions] + + """ + Information to aid in pagination. + """ + pageInfo: PageInfo! +} + +""" +An edge in a connection. +""" +type PackageWithoutVersionsEdge { + """ + A cursor for use in pagination. + """ + cursor: String! + + """ + The item at the end of the edge. + """ + node: PackageWithoutVersions +} + +""" +Identifier of Packages::Package. """ scalar PackagesPackageID @@ -17185,49 +18467,49 @@ type PageInfo { type Pipeline { """ - Indicates if the pipeline is active + Indicates if the pipeline is active. """ active: Boolean! """ - Base SHA of the source branch + Base SHA of the source branch. """ beforeSha: String """ - Specifies if a pipeline can be canceled + Specifies if a pipeline can be canceled. """ cancelable: Boolean! """ - Timestamp of the pipeline's commit + Timestamp of the pipeline's commit. """ committedAt: Time """ - Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, + Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, - BRIDGE_SOURCE, PARAMETER_SOURCE) + BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE) """ configSource: PipelineConfigSourceEnum """ - Coverage percentage + Coverage percentage. """ coverage: Float """ - Timestamp of the pipeline's creation + Timestamp of the pipeline's creation. """ createdAt: Time! """ - Detailed status of the pipeline + Detailed status of the pipeline. """ detailedStatus: DetailedStatus! """ - Pipelines this pipeline will trigger + Pipelines this pipeline will trigger. """ downstream( """ @@ -17252,27 +18534,27 @@ type Pipeline { ): PipelineConnection """ - Duration of the pipeline in seconds + Duration of the pipeline in seconds. """ duration: Int """ - Timestamp of the pipeline's completion + Timestamp of the pipeline's completion. """ finishedAt: Time """ - ID of the pipeline + ID of the pipeline. """ id: ID! """ - Internal ID of the pipeline + Internal ID of the pipeline. """ iid: String! """ - Jobs belonging to the pipeline + Jobs belonging to the pipeline. """ jobs( """ @@ -17302,37 +18584,37 @@ type Pipeline { ): CiJobConnection """ - Relative path to the pipeline's page + Relative path to the pipeline's page. """ path: String """ - Project the pipeline belongs to + Project the pipeline belongs to. """ project: Project """ - Specifies if a pipeline can be retried + Specifies if a pipeline can be retried. """ 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. """ securityReportSummary: SecurityReportSummary """ - SHA of the pipeline's commit + SHA of the pipeline's commit. """ sha: String! """ - Job where pipeline was triggered from + Job where pipeline was triggered from. """ sourceJob: CiJob """ - Stages of the pipeline + Stages of the pipeline. """ stages( """ @@ -17357,7 +18639,7 @@ type Pipeline { ): CiStageConnection """ - Timestamp when the pipeline was started + Timestamp when the pipeline was started. """ startedAt: Time @@ -17368,17 +18650,17 @@ type Pipeline { status: PipelineStatusEnum! """ - Timestamp of the pipeline's last activity + Timestamp of the pipeline's last activity. """ updatedAt: Time! """ - Pipeline that triggered the pipeline + Pipeline that triggered the pipeline. """ upstream: Pipeline """ - Pipeline user + Pipeline user. """ user: User @@ -17386,61 +18668,66 @@ type Pipeline { Permissions for the current user on the resource """ userPermissions: PipelinePermissions! + + """ + Indicates if a pipeline has warnings. + """ + warnings: Boolean! } type PipelineAnalytics { """ - Labels for the monthly pipeline count + Labels for the monthly pipeline count. """ monthPipelinesLabels: [String!] """ - Total monthly successful pipeline count + Total monthly successful pipeline count. """ monthPipelinesSuccessful: [Int!] """ - Total monthly pipeline count + Total monthly pipeline count. """ monthPipelinesTotals: [Int!] """ - Pipeline times labels + Pipeline times labels. """ pipelineTimesLabels: [String!] """ - Pipeline times + Pipeline times. """ pipelineTimesValues: [Int!] """ - Labels for the weekly pipeline count + Labels for the weekly pipeline count. """ weekPipelinesLabels: [String!] """ - Total weekly successful pipeline count + Total weekly successful pipeline count. """ weekPipelinesSuccessful: [Int!] """ - Total weekly pipeline count + Total weekly pipeline count. """ weekPipelinesTotals: [Int!] """ - Labels for the yearly pipeline count + Labels for the yearly pipeline count. """ yearPipelinesLabels: [String!] """ - Total yearly successful pipeline count + Total yearly successful pipeline count. """ yearPipelinesSuccessful: [Int!] """ - Total yearly pipeline count + Total yearly pipeline count. """ yearPipelinesTotals: [Int!] } @@ -17478,6 +18765,7 @@ type PipelineCancelPayload { enum PipelineConfigSourceEnum { AUTO_DEVOPS_SOURCE BRIDGE_SOURCE + COMPLIANCE_SOURCE EXTERNAL_PROJECT_SOURCE PARAMETER_SOURCE REMOTE_SOURCE @@ -17491,7 +18779,7 @@ The connection type for Pipeline. """ type PipelineConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -17624,12 +18912,12 @@ enum PipelineStatusEnum { type Project { """ - Size limit for the repository in bytes + Size limit for the repository in bytes. """ actualRepositorySizeLimit: Float """ - A single Alert Management alert of the project + A single Alert Management alert of the project. """ alertManagementAlert( """ @@ -17664,7 +18952,7 @@ type Project { ): AlertManagementAlert """ - Counts of alerts by status for the project + Counts of alerts by status for the project. """ alertManagementAlertStatusCounts( """ @@ -17679,7 +18967,7 @@ type Project { ): AlertManagementAlertStatusCountsType """ - Alert Management alerts of the project + Alert Management alerts of the project. """ alertManagementAlerts( """ @@ -17734,7 +19022,7 @@ type Project { ): AlertManagementAlertConnection """ - Integrations which can receive alerts for the project + Integrations which can receive alerts for the project. """ alertManagementIntegrations( """ @@ -17759,28 +19047,43 @@ type Project { ): AlertManagementIntegrationConnection """ + Extract alert fields from payload for custom mapping. + """ + alertManagementPayloadFields( + """ + Sample payload for extracting alert fields for custom mappings. + """ + payloadExample: String! + ): [AlertManagementPayloadAlertField!] + + """ If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge - requests of the project can also be merged with skipped jobs + requests of the project can also be merged with skipped jobs. """ allowMergeOnSkippedPipeline: Boolean """ - Indicates the archived status of the project + API fuzzing configuration for the project. Available only when feature flag `api_fuzzing_configuration_ui` is enabled. + """ + apiFuzzingCiConfiguration: ApiFuzzingCiConfiguration + + """ + Indicates the archived status of the project. """ archived: Boolean """ - Indicates if issues referenced by merge requests and commits within the default branch are closed automatically + Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. """ autocloseReferencedIssues: Boolean """ - URL to avatar image file of the project + URL to avatar image file of the project. """ avatarUrl: String """ - A single board of the project + A single board of the project. """ board( """ @@ -17790,7 +19093,7 @@ type Project { ): Board """ - Boards of the project + Boards of the project. """ boards( """ @@ -17820,12 +19123,12 @@ type Project { ): BoardConnection """ - CI/CD settings for the project + CI/CD settings for the project. """ ciCdSettings: ProjectCiCdSetting """ - Find a single cluster agent by name + Find a single cluster agent by name. """ clusterAgent( """ @@ -17835,7 +19138,7 @@ type Project { ): ClusterAgent """ - Cluster agents associated with the project + Cluster agents associated with the project. """ clusterAgents( """ @@ -17860,12 +19163,12 @@ type Project { ): ClusterAgentConnection """ - Code coverage summary associated with the project + Code coverage summary associated with the project. """ codeCoverageSummary: CodeCoverageSummary """ - Compliance frameworks associated with the project + Compliance frameworks associated with the project. """ complianceFrameworks( """ @@ -17890,17 +19193,17 @@ type Project { ): ComplianceFrameworkConnection """ - The container expiration policy of the project + The container expiration policy of the project. """ containerExpirationPolicy: ContainerExpirationPolicy """ - Indicates if the project stores Docker container images in a container registry + Indicates if the project stores Docker container images in a container registry. """ containerRegistryEnabled: Boolean """ - Container repositories of the project + Container repositories of the project. """ containerRepositories( """ @@ -17927,20 +19230,50 @@ type Project { Filter the container repositories by their name. """ name: String + + """ + Sort container repositories by this criteria. + """ + sort: ContainerRepositorySort = created_desc ): ContainerRepositoryConnection """ - Number of container repositories in the project + Number of container repositories in the project. """ containerRepositoriesCount: Int! """ - Timestamp of the project creation + Timestamp of the project creation. """ createdAt: Time """ - The DAST scanner profiles associated with the project + DAST Profiles associated with the project. Always returns no nodes if `dast_saved_scans` is disabled. + """ + dastProfiles( + """ + 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 + + """ + Returns the last _n_ elements from the list. + """ + last: Int + ): DastProfileConnection + + """ + The DAST scanner profiles associated with the project. """ dastScannerProfiles( """ @@ -17965,7 +19298,7 @@ type Project { ): DastScannerProfileConnection """ - DAST Site Profile associated with the project + DAST Site Profile associated with the project. """ dastSiteProfile( """ @@ -17975,7 +19308,7 @@ type Project { ): DastSiteProfile """ - DAST Site Profiles associated with the project + DAST Site Profiles associated with the project. """ dastSiteProfiles( """ @@ -18000,8 +19333,8 @@ type Project { ): DastSiteProfileConnection """ - DAST Site Validations associated with the project. Will always return no nodes - if `security_on_demand_scans_site_validation` is disabled + DAST Site Validations associated with the project. Always returns no nodes if + `security_on_demand_scans_site_validation` is disabled. """ dastSiteValidations( """ @@ -18031,7 +19364,7 @@ type Project { ): DastSiteValidationConnection """ - Short description of the project + Short description of the project. """ description: String @@ -18041,7 +19374,7 @@ type Project { descriptionHtml: String """ - A single environment of the project + A single environment of the project. """ environment( """ @@ -18061,7 +19394,7 @@ type Project { ): Environment """ - Environments of the project + Environments of the project. """ environments( """ @@ -18101,42 +19434,42 @@ type Project { ): EnvironmentConnection """ - Number of times the project has been forked + Number of times the project has been forked. """ forksCount: Int! """ - Full path of the project + Full path of the project. """ fullPath: ID! """ - Grafana integration details for the project + Grafana integration details for the project. """ grafanaIntegration: GrafanaIntegration """ - Group of the project + Group of the project. """ group: Group """ - URL to connect to the project via HTTPS + URL to connect to the project via HTTPS. """ httpUrlToRepo: String """ - ID of the project + ID of the project. """ id: ID! """ - Status of import background job of the project + Status of import background job of the project. """ importStatus: String """ - Incident Management On-call schedules of the project + Incident Management On-call schedules of the project. """ incidentManagementOncallSchedules( """ @@ -18161,7 +19494,7 @@ type Project { ): IncidentManagementOncallScheduleConnection """ - A single issue of the project + A single issue of the project. """ issue( """ @@ -18266,7 +19599,7 @@ type Project { ): Issue """ - Counts of issues by status for the project + Counts of issues by status for the project. """ issueStatusCounts( """ @@ -18351,7 +19684,7 @@ type Project { ): IssueStatusCountsType """ - Issues of the project + Issues of the project. """ issues( """ @@ -18481,7 +19814,7 @@ type Project { issuesEnabled: Boolean """ - Find iterations + Find iterations. """ iterations( """ @@ -18549,12 +19882,12 @@ type Project { ): IterationConnection """ - Status of Jira import background job of the project + Status of Jira import background job of the project. """ jiraImportStatus: String """ - Jira imports into the project + Jira imports into the project. """ jiraImports( """ @@ -18579,22 +19912,22 @@ type Project { ): JiraImportConnection """ - Indicates if CI/CD pipeline jobs are enabled for the current user + Indicates if CI/CD pipeline jobs are enabled for the current user. """ jobsEnabled: Boolean """ - A label available on this project + A label available on this project. """ label( """ - Title of the label + Title of the label. """ title: String! ): Label """ - Labels available on this project + Labels available on this project. """ labels( """ @@ -18613,28 +19946,33 @@ type Project { first: Int """ + Include labels from ancestor groups. + """ + includeAncestorGroups: Boolean = false + + """ Returns the last _n_ elements from the list. """ last: Int """ - A search term to find labels with + A search term to find labels with. """ searchTerm: String ): LabelConnection """ - Timestamp of the project last activity + Timestamp of the project last activity. """ lastActivityAt: Time """ - Indicates if the project has Large File Storage (LFS) enabled + Indicates if the project has Large File Storage (LFS) enabled. """ lfsEnabled: Boolean """ - A single merge request of the project + A single merge request of the project. """ mergeRequest( """ @@ -18644,7 +19982,7 @@ type Project { ): MergeRequest """ - Merge requests of the project + Merge requests of the project. """ mergeRequests( """ @@ -18741,7 +20079,7 @@ type Project { mergeRequestsFfOnlyEnabled: Boolean """ - Milestones of the project + Milestones of the project. """ milestones( """ @@ -18814,37 +20152,37 @@ type Project { ): MilestoneConnection """ - Name of the project (without namespace) + Name of the project (without namespace). """ name: String! """ - Full name of the project with its namespace + Full name of the project with its namespace. """ nameWithNamespace: String! """ - Namespace of the project + Namespace of the project. """ namespace: Namespace """ - Indicates if merge requests of the project can only be merged when all the discussions are resolved + Indicates if merge requests of the project can only be merged when all the discussions are resolved. """ onlyAllowMergeIfAllDiscussionsAreResolved: Boolean """ - Indicates if merge requests of the project can only be merged with successful jobs + Indicates if merge requests of the project can only be merged with successful jobs. """ onlyAllowMergeIfPipelineSucceeds: Boolean """ - Number of open issues for the project + Number of open issues for the project. """ openIssuesCount: Int """ - Packages of the project + Packages of the project. """ packages( """ @@ -18869,12 +20207,12 @@ type Project { ): PackageConnection """ - Path of the project + Path of the project. """ path: String! """ - Build pipeline of the project + Build pipeline of the project. """ pipeline( """ @@ -18884,12 +20222,12 @@ type Project { ): Pipeline """ - Pipeline analytics + Pipeline analytics. """ pipelineAnalytics: PipelineAnalytics """ - Build pipelines of the project + Build pipelines of the project. """ pipelines( """ @@ -18930,12 +20268,12 @@ type Project { """ Indicates if a link to create or view a merge request should display after a - push to Git repositories of the project from the command line + push to Git repositories of the project from the command line. """ printingMergeRequestLinkEnabled: Boolean """ - Members of the project + Members of the project. """ projectMembers( """ @@ -18970,12 +20308,12 @@ type Project { ): MemberInterfaceConnection """ - Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts + Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. """ publicJobs: Boolean """ - A single release of the project + A single release of the project. """ release( """ @@ -18985,7 +20323,7 @@ type Project { ): Release """ - Releases of the project + Releases of the project. """ releases( """ @@ -19015,27 +20353,27 @@ type Project { ): ReleaseConnection """ - Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project + Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project. """ removeSourceBranchAfterMerge: Boolean """ - Git repository of the project + Git repository of the project. """ repository: Repository """ - Size of repository that exceeds the limit in bytes + Size of repository that exceeds the limit in bytes. """ repositorySizeExcess: Float """ - Indicates if users can request member access to the project + Indicates if users can request member access to the project. """ requestAccessEnabled: Boolean """ - Find a single requirement + Find a single requirement. """ requirement( """ @@ -19054,6 +20392,11 @@ type Project { iids: [ID!] """ + The state of latest requirement test report. + """ + lastTestReportState: TestReportState + + """ Search query for requirement title. """ search: String @@ -19070,12 +20413,12 @@ type Project { ): Requirement """ - Number of requirements for the project by their state + Number of requirements for the project by their state. """ requirementStatesCount: RequirementStatesCount """ - Find requirements + Find requirements. """ requirements( """ @@ -19114,6 +20457,11 @@ type Project { last: Int """ + The state of latest requirement test report. + """ + lastTestReportState: TestReportState + + """ Search query for requirement title. """ search: String @@ -19130,22 +20478,22 @@ type Project { ): RequirementConnection """ - SAST CI configuration for the project + SAST CI configuration for the project. """ sastCiConfiguration: SastCiConfiguration """ - Path to project's security dashboard + Path to project's security dashboard. """ securityDashboardPath: String """ - Information about security analyzers used in the project + Information about security analyzers used in the project. """ securityScanners: SecurityScanners """ - Detailed version of a Sentry error on the project + Detailed version of a Sentry error on the project. """ sentryDetailedError( """ @@ -19155,7 +20503,7 @@ type Project { ): SentryDetailedError """ - Paginated collection of Sentry errors on the project + Paginated collection of Sentry errors on the project. """ sentryErrors: SentryErrorCollection @@ -19170,7 +20518,7 @@ type Project { serviceDeskEnabled: Boolean """ - Project services + Project services. """ services( """ @@ -19205,12 +20553,12 @@ type Project { ): ServiceConnection """ - Indicates if shared runners are enabled for the project + Indicates if shared runners are enabled for the project. """ sharedRunnersEnabled: Boolean """ - Snippets of the project + Snippets of the project. """ snippets( """ @@ -19250,37 +20598,47 @@ type Project { snippetsEnabled: Boolean """ - Indicates if squash readonly is enabled + Indicates if `squashReadOnly` is enabled. """ squashReadOnly: Boolean! """ - URL to connect to the project via SSH + URL to connect to the project via SSH. """ sshUrlToRepo: String """ - Number of times the project has been starred + Number of times the project has been starred. """ starCount: Int! """ - Statistics of the project + Statistics of the project. """ statistics: ProjectStatistics """ - The commit message used to apply merge request suggestions + The commit message used to apply merge request suggestions. """ suggestionCommitMessage: String """ - List of project topics (not Git tags) + List of project topics (not Git tags). """ tagList: String """ - Terraform states associated with the project + Find a single Terraform state by name. + """ + terraformState( + """ + Name of the Terraform state. + """ + name: String! + ): TerraformState + + """ + Terraform states associated with the project. """ terraformStates( """ @@ -19310,12 +20668,12 @@ type Project { userPermissions: ProjectPermissions! """ - Visibility of the project + Visibility of the project. """ visibility: String """ - Vulnerabilities reported on the project + Vulnerabilities reported on the project. """ vulnerabilities( """ @@ -19380,7 +20738,7 @@ type Project { ): VulnerabilityConnection """ - Number of vulnerabilities per day for the project + Number of vulnerabilities per day for the project. """ vulnerabilitiesCountByDay( """ @@ -19415,7 +20773,7 @@ type Project { ): VulnerabilitiesCountByDayConnection """ - Vulnerability scanners reported on the project vulnerabilties + Vulnerability scanners reported on the project vulnerabilities. """ vulnerabilityScanners( """ @@ -19440,7 +20798,7 @@ type Project { ): VulnerabilityScannerConnection """ - Counts for each vulnerability severity in the project + Counts for each vulnerability severity in the project. """ vulnerabilitySeveritiesCount( """ @@ -19470,7 +20828,7 @@ type Project { ): VulnerabilitySeveritiesCount """ - Web URL of the project + Web URL of the project. """ webUrl: String @@ -19538,7 +20896,7 @@ type ProjectEdge { } """ -Identifier of Project +Identifier of Project. """ scalar ProjectID @@ -19547,42 +20905,42 @@ Represents a Project Membership """ type ProjectMember implements MemberInterface { """ - GitLab::Access level + GitLab::Access level. """ accessLevel: AccessLevel """ - Date and time the membership was created + Date and time the membership was created. """ createdAt: Time """ - User that authorized membership + User that authorized membership. """ createdBy: User """ - Date and time the membership expires + Date and time the membership expires. """ expiresAt: Time """ - ID of the member + ID of the member. """ id: ID! """ - Project that User is a member of + Project that User is a member of. """ project: Project """ - Date and time the membership was last updated + Date and time the membership was last updated. """ updatedAt: Time """ - User that is associated with the member object + User that is associated with the member object. """ user: User! @@ -19866,47 +21224,47 @@ type ProjectPermissions { type ProjectStatistics { """ - Build artifacts size of the project in bytes + Build artifacts size of the project in bytes. """ buildArtifactsSize: Float! """ - Commit count of the project + Commit count of the project. """ commitCount: Float! """ - Large File Storage (LFS) object size of the project in bytes + Large File Storage (LFS) object size of the project in bytes. """ lfsObjectsSize: Float! """ - Packages size of the project in bytes + Packages size of the project in bytes. """ packagesSize: Float! """ - Repository size of the project in bytes + Repository size of the project in bytes. """ repositorySize: Float! """ - Snippets size of the project in bytes + Snippets size of the project in bytes. """ snippetsSize: Float """ - Storage size of the project in bytes + Storage size of the project in bytes. """ storageSize: Float! """ - Uploads size of the project in bytes + Uploads size of the project in bytes. """ uploadsSize: Float """ - Wiki size of the project in bytes + Wiki size of the project in bytes. """ wikiSize: Float } @@ -19916,12 +21274,12 @@ The alert condition for Prometheus """ type PrometheusAlert { """ - The human-readable text of the alert condition + The human-readable text of the alert condition. """ humanizedText: String! """ - ID of the alert condition + ID of the alert condition. """ id: ID! } @@ -20052,7 +21410,7 @@ type PrometheusIntegrationUpdatePayload { } """ -Identifier of PrometheusService +Identifier of PrometheusService. """ scalar PrometheusServiceID @@ -20108,6 +21466,11 @@ type PromoteToEpicPayload { type Query { """ + CI related settings that apply to the entire instance. + """ + ciApplicationSettings: CiApplicationSettings + + """ Get linted and processed contents of a CI config. Should not be requested more than once per request. """ ciConfig( @@ -20128,27 +21491,27 @@ type Query { ): CiConfig """ - Find a container repository + Find a container repository. """ containerRepository( """ - The global ID of the container repository + The global ID of the container repository. """ id: ContainerRepositoryID! ): ContainerRepositoryDetails """ - Get information about current user + Get information about current user. """ currentUser: User """ - Fields related to design management + Fields related to design management. """ designManagement: DesignManagement! """ - Get configured DevOps adoption segments on the instance + Get configured DevOps adoption segments on the instance. """ devopsAdoptionSegments( """ @@ -20173,7 +21536,7 @@ type Query { ): DevopsAdoptionSegmentConnection """ - Text to echo back + Text to echo back. """ echo( """ @@ -20183,7 +21546,7 @@ type Query { ): String! """ - Find a Geo node + Find a Geo node. """ geoNode( """ @@ -20193,7 +21556,7 @@ type Query { ): GeoNode """ - Find a group + Find a group. """ group( """ @@ -20203,12 +21566,12 @@ type Query { ): Group """ - Fields related to Instance Security Dashboard + Fields related to Instance Security Dashboard. """ instanceSecurityDashboard: InstanceSecurityDashboard """ - Get statistics on the instance + Get statistics on the instance. """ instanceStatisticsMeasurements( """ @@ -20248,42 +21611,42 @@ type Query { ): InstanceStatisticsMeasurementConnection """ - Find an issue + Find an issue. """ issue( """ - The global ID of the Issue + The global ID of the Issue. """ id: IssueID! ): Issue """ - Find an iteration + Find an iteration. """ iteration( """ - Find an iteration by its ID + Find an iteration by its ID. """ id: IterationID! ): Iteration """ - Metadata about GitLab + Metadata about GitLab. """ metadata: Metadata """ - Find a milestone + Find a milestone. """ milestone( """ - Find a milestone by its ID + Find a milestone by its ID. """ id: MilestoneID! ): Milestone """ - Find a namespace + Find a namespace. """ namespace( """ @@ -20293,17 +21656,17 @@ type Query { ): Namespace """ - Find a composer package + Find a package. """ - packageComposerDetails( + package( """ The global ID of the package. """ id: PackagesPackageID! - ): PackageComposerDetails + ): Package """ - Find a project + Find a project. """ project( """ @@ -20313,7 +21676,7 @@ type Query { ): Project """ - Find projects visible to the current user + Find projects visible to the current user. """ projects( """ @@ -20363,7 +21726,7 @@ type Query { ): ProjectConnection """ - Supported runner platforms + Supported runner platforms. """ runnerPlatforms( """ @@ -20388,7 +21751,7 @@ type Query { ): RunnerPlatformConnection """ - Get runner setup instructions + Get runner setup instructions. """ runnerSetup( """ @@ -20413,7 +21776,7 @@ type Query { ): RunnerSetup """ - Find Snippets visible to the current user + Find Snippets visible to the current user. """ snippets( """ @@ -20468,7 +21831,7 @@ type Query { ): SnippetConnection """ - Find a user + Find a user. """ user( """ @@ -20483,7 +21846,7 @@ type Query { ): User """ - Find users + Find users. """ users( """ @@ -20533,7 +21896,7 @@ type Query { ): UserConnection """ - Vulnerabilities reported on projects on the current user's instance security dashboard + Vulnerabilities reported on projects on the current user's instance security dashboard. """ vulnerabilities( """ @@ -20598,7 +21961,7 @@ type Query { ): VulnerabilityConnection """ - Number of vulnerabilities per day for the projects on the current user's instance security dashboard + Number of vulnerabilities per day for the projects on the current user's instance security dashboard. """ vulnerabilitiesCountByDay( """ @@ -20634,7 +21997,7 @@ type Query { """ Number of vulnerabilities per severity level, per day, for the projects on the - current user's instance security dashboard Deprecated in 13.3: Use + current user's instance security dashboard. Deprecated in 13.3: Use `vulnerabilitiesCountByDay`. """ vulnerabilitiesCountByDayAndSeverity( @@ -20670,11 +22033,11 @@ type Query { ): VulnerabilitiesCountByDayAndSeverityConnection @deprecated(reason: "Use `vulnerabilitiesCountByDay`. Deprecated in 13.3.") """ - Find a vulnerability + Find a vulnerability. """ vulnerability( """ - The Global ID of the Vulnerability + The Global ID of the Vulnerability. """ id: VulnerabilityID! ): Vulnerability @@ -20710,27 +22073,27 @@ Represents a release """ type Release { """ - Assets of the release + Assets of the release. """ assets: ReleaseAssets """ - User that created the release + User that created the release. """ author: User """ - The commit associated with the release + The commit associated with the release. """ commit: Commit """ - Timestamp of when the release was created + Timestamp of when the release was created. """ createdAt: Time """ - Description (also known as "release notes") of the release + Description (also known as "release notes") of the release. """ description: String @@ -20740,7 +22103,7 @@ type Release { descriptionHtml: String """ - Evidence for the release + Evidence for the release. """ evidences( """ @@ -20765,12 +22128,12 @@ type Release { ): ReleaseEvidenceConnection """ - Links of the release + Links of the release. """ links: ReleaseLinks """ - Milestones associated to the release + Milestones associated to the release. """ milestones( """ @@ -20795,27 +22158,27 @@ type Release { ): MilestoneConnection """ - Name of the release + Name of the release. """ name: String """ - Timestamp of when the release was released + Timestamp of when the release was released. """ releasedAt: Time """ - Name of the tag associated with the release + Name of the tag associated with the release. """ tagName: String """ - Relative web path to the tag associated with the release + Relative web path to the tag associated with the release. """ tagPath: String """ - Indicates the release is an upcoming release + Indicates the release is an upcoming release. """ upcomingRelease: Boolean } @@ -20825,32 +22188,32 @@ Represents an asset link associated with a release """ type ReleaseAssetLink { """ - Direct asset URL of the link + Direct asset URL of the link. """ directAssetUrl: String """ - Indicates the link points to an external resource + Indicates the link points to an external resource. """ external: Boolean """ - ID of the link + ID of the link. """ id: ID! """ - Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other` + Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`. """ linkType: ReleaseAssetLinkType """ - Name of the link + Name of the link. """ name: String """ - URL of the link + URL of the link. """ url: String } @@ -20895,22 +22258,22 @@ Fields that are available when modifying a release asset link """ input ReleaseAssetLinkInput { """ - Relative path for a direct asset link + Relative path for a direct asset link. """ directAssetPath: String """ - The type of the asset link + The type of the asset link. """ linkType: ReleaseAssetLinkType = OTHER """ - Name of the asset link + Name of the asset link. """ name: String! """ - URL of the asset link + URL of the asset link. """ url: String! } @@ -20945,12 +22308,12 @@ A container for all assets associated with a release """ type ReleaseAssets { """ - Number of assets of the release + Number of assets of the release. """ count: Int """ - Asset links of the release + Asset links of the release. """ links( """ @@ -20975,7 +22338,7 @@ type ReleaseAssets { ): ReleaseAssetLinkConnection """ - Sources of the release + Sources of the release. """ sources( """ @@ -21005,7 +22368,7 @@ Fields that are available when modifying release assets """ input ReleaseAssetsInput { """ - A list of asset links to associate to the release + A list of asset links to associate to the release. """ links: [ReleaseAssetLinkInput!] } @@ -21015,7 +22378,7 @@ The connection type for Release. """ type ReleaseConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -21165,22 +22528,22 @@ Evidence for a release """ type ReleaseEvidence { """ - Timestamp when the evidence was collected + Timestamp when the evidence was collected. """ collectedAt: Time """ - URL from where the evidence can be downloaded + URL from where the evidence can be downloaded. """ filepath: String """ - ID of the evidence + ID of the evidence. """ id: ID! """ - SHA1 ID of the evidence hash + SHA1 ID of the evidence hash. """ sha: String } @@ -21222,37 +22585,37 @@ type ReleaseEvidenceEdge { type ReleaseLinks { """ - HTTP URL of the issues page, filtered by this release and `state=closed` + HTTP URL of the issues page, filtered by this release and `state=closed`. """ closedIssuesUrl: String """ - HTTP URL of the merge request page , filtered by this release and `state=closed` + HTTP URL of the merge request page , filtered by this release and `state=closed`. """ closedMergeRequestsUrl: String """ - HTTP URL of the release's edit page + HTTP URL of the release's edit page. """ editUrl: String """ - HTTP URL of the merge request page , filtered by this release and `state=merged` + HTTP URL of the merge request page , filtered by this release and `state=merged`. """ mergedMergeRequestsUrl: String """ - HTTP URL of the issues page, filtered by this release and `state=open` + HTTP URL of the issues page, filtered by this release and `state=open`. """ openedIssuesUrl: String """ - HTTP URL of the merge request page, filtered by this release and `state=open` + HTTP URL of the merge request page, filtered by this release and `state=open`. """ openedMergeRequestsUrl: String """ - HTTP URL of the release + HTTP URL of the release. """ selfUrl: String } @@ -21287,12 +22650,12 @@ Represents the source code attached to a release in a particular format """ type ReleaseSource { """ - Format of the source + Format of the source. """ format: String """ - Download URL of the source + Download URL of the source. """ url: String } @@ -21407,7 +22770,7 @@ input RemoveAwardEmojiInput { clientMutationId: String """ - The emoji name + The emoji name. """ name: String! } @@ -21477,7 +22840,7 @@ input RepositionImageDiffNoteInput { id: DiffNoteID! """ - The position of this note on a diff + The position of this note on a diff. """ position: UpdateDiffImagePositionInput! } @@ -21504,22 +22867,22 @@ type RepositionImageDiffNotePayload { type Repository { """ - Indicates repository has no visible content + Indicates repository has no visible content. """ empty: Boolean! """ - Indicates a corresponding Git repository exists on disk + Indicates a corresponding Git repository exists on disk. """ exists: Boolean! """ - Default branch of the repository + Default branch of the repository. """ rootRef: String """ - Tree of the repository + Tree of the repository. """ tree( """ @@ -21544,17 +22907,17 @@ Represents a requirement """ type Requirement { """ - Author of the requirement + Author of the requirement. """ author: User! """ - Timestamp of when the requirement was created + Timestamp of when the requirement was created. """ createdAt: Time! """ - Description of the requirement + Description of the requirement. """ description: String @@ -21564,37 +22927,37 @@ type Requirement { descriptionHtml: String """ - ID of the requirement + ID of the requirement. """ id: ID! """ - Internal ID of the requirement + Internal ID of the requirement. """ iid: ID! """ - Indicates if latest test report was created by user + Indicates if latest test report was created by user. """ lastTestReportManuallyCreated: Boolean """ - Latest requirement test report state + Latest requirement test report state. """ lastTestReportState: TestReportState """ - Project to which the requirement belongs + Project to which the requirement belongs. """ project: Project! """ - State of the requirement + State of the requirement. """ state: RequirementState! """ - Test reports of the requirement + Test reports of the requirement. """ testReports( """ @@ -21624,7 +22987,7 @@ type Requirement { ): TestReportConnection """ - Title of the requirement + Title of the requirement. """ title: String @@ -21634,7 +22997,7 @@ type Requirement { titleHtml: String """ - Timestamp of when the requirement was last updated + Timestamp of when the requirement was last updated. """ updatedAt: Time! @@ -21722,34 +23085,34 @@ Counts of requirements by their state """ type RequirementStatesCount { """ - Number of archived requirements + Number of archived requirements. """ archived: Int """ - Number of opened requirements + Number of opened requirements. """ opened: Int } interface ResolvableInterface { """ - Indicates if the object can be resolved + Indicates if the object can be resolved. """ resolvable: Boolean! """ - Indicates if the object is resolved + Indicates if the object is resolved. """ resolved: Boolean! """ - Timestamp of when the object was resolved + Timestamp of when the object was resolved. """ resolvedAt: Time """ - User who resolved the object + User who resolved the object. """ resolvedBy: User } @@ -21791,47 +23154,47 @@ type RevertVulnerabilityToDetectedPayload { type RootStorageStatistics { """ - The CI artifacts size in bytes + The CI artifacts size in bytes. """ buildArtifactsSize: Float! """ - The LFS objects size in bytes + The LFS objects size in bytes. """ lfsObjectsSize: Float! """ - The packages size in bytes + The packages size in bytes. """ packagesSize: Float! """ - The CI pipeline artifacts size in bytes + The CI pipeline artifacts size in bytes. """ pipelineArtifactsSize: Float! """ - The Git repository size in bytes + The Git repository size in bytes. """ repositorySize: Float! """ - The snippets size in bytes + The snippets size in bytes. """ snippetsSize: Float! """ - The total storage in bytes + The total storage in bytes. """ storageSize: Float! """ - The uploads size in bytes + The uploads size in bytes. """ uploadsSize: Float! """ - The wiki size in bytes + The wiki size in bytes. """ wikiSize: Float! } @@ -21888,12 +23251,12 @@ type RunDASTScanPayload { type RunnerArchitecture { """ - Download location for the runner for the platform architecture + Download location for the runner for the platform architecture. """ downloadLocation: String! """ - Name of the runner platform architecture + Name of the runner platform architecture. """ name: String! } @@ -21935,7 +23298,7 @@ type RunnerArchitectureEdge { type RunnerPlatform { """ - Runner architectures supported for the platform + Runner architectures supported for the platform. """ architectures( """ @@ -21960,12 +23323,12 @@ type RunnerPlatform { ): RunnerArchitectureConnection """ - Human readable name of the runner platform + Human readable name of the runner platform. """ humanReadableName: String! """ - Name slug of the runner platform + Name slug of the runner platform. """ name: String! } @@ -22007,12 +23370,12 @@ type RunnerPlatformEdge { type RunnerSetup { """ - Instructions for installing the runner on the specified architecture + Instructions for installing the runner on the specified architecture. """ installInstructions: String! """ - Instructions for registering the runner + Instructions for registering the runner. """ registerInstructions: String } @@ -22102,27 +23465,27 @@ Represents an analyzer entity in SAST CI configuration """ type SastCiConfigurationAnalyzersEntity { """ - Analyzer description that is displayed on the form + Analyzer description that is displayed on the form. """ description: String """ - Indicates whether an analyzer is enabled + Indicates whether an analyzer is enabled. """ enabled: Boolean """ - Analyzer label used in the config UI + Analyzer label used in the config UI. """ label: String """ - Name of the analyzer + Name of the analyzer. """ name: String """ - List of supported variables + List of supported variables. """ variables( """ @@ -22187,17 +23550,17 @@ Represents the analyzers entity in SAST CI configuration """ input SastCiConfigurationAnalyzersEntityInput { """ - State of the analyzer + State of the analyzer. """ enabled: Boolean! """ - Name of analyzer + Name of analyzer. """ name: String! """ - List of variables for the analyzer + List of variables for the analyzer. """ variables: [SastCiConfigurationEntityInput!] } @@ -22307,17 +23670,17 @@ Represents an entity in SAST CI configuration """ input SastCiConfigurationEntityInput { """ - Default value that is used if value is empty + Default value that is used if value is empty. """ defaultValue: String! """ - CI keyword of entity + CI keyword of entity. """ field: String! """ - Current value of the entity + Current value of the entity. """ value: String! } @@ -22327,17 +23690,17 @@ Represents a CI configuration of SAST """ input SastCiConfigurationInput { """ - List of analyzers and related variables for the SAST configuration + List of analyzers and related variables for the SAST configuration. """ analyzers: [SastCiConfigurationAnalyzersEntityInput!] """ - List of global entities related to SAST configuration + List of global entities related to SAST configuration. """ global: [SastCiConfigurationEntityInput!] """ - List of pipeline entities related to SAST configuration + List of pipeline entities related to SAST configuration. """ pipeline: [SastCiConfigurationEntityInput!] } @@ -22406,12 +23769,12 @@ Represents a resource scanned by a security scan """ type ScannedResource { """ - The HTTP request method used to access the URL + The HTTP request method used to access the URL. """ requestMethod: String """ - The URL scanned by the scanner + The URL scanned by the scanner. """ url: String } @@ -22456,37 +23819,37 @@ Represents summary of a security report """ type SecurityReportSummary { """ - Aggregated counts for the api_fuzzing scan + Aggregated counts for the `api_fuzzing` scan """ apiFuzzing: SecurityReportSummarySection """ - Aggregated counts for the container_scanning scan + Aggregated counts for the `container_scanning` scan """ containerScanning: SecurityReportSummarySection """ - Aggregated counts for the coverage_fuzzing scan + Aggregated counts for the `coverage_fuzzing` scan """ coverageFuzzing: SecurityReportSummarySection """ - Aggregated counts for the dast scan + Aggregated counts for the `dast` scan """ dast: SecurityReportSummarySection """ - Aggregated counts for the dependency_scanning scan + Aggregated counts for the `dependency_scanning` scan """ dependencyScanning: SecurityReportSummarySection """ - Aggregated counts for the sast scan + Aggregated counts for the `sast` scan """ sast: SecurityReportSummarySection """ - Aggregated counts for the secret_detection scan + Aggregated counts for the `secret_detection` scan """ secretDetection: SecurityReportSummarySection } @@ -22496,7 +23859,7 @@ Represents a section of a summary of a security report """ type SecurityReportSummarySection { """ - A list of the first 20 scanned resources + A list of the first 20 scanned resources. """ scannedResources( """ @@ -22521,17 +23884,17 @@ type SecurityReportSummarySection { ): ScannedResourceConnection """ - Total number of scanned resources + Total number of scanned resources. """ scannedResourcesCount: Int """ - Path to download all the scanned resources in CSV format + Path to download all the scanned resources in CSV format. """ scannedResourcesCsvPath: String """ - Total number of vulnerabilities + Total number of vulnerabilities. """ vulnerabilitiesCount: Int } @@ -22611,142 +23974,142 @@ A Sentry error """ type SentryDetailedError { """ - Count of occurrences + Count of occurrences. """ count: Int! """ - Culprit of the error + Culprit of the error. """ culprit: String! """ - External Base URL of the Sentry Instance + External Base URL of the Sentry Instance. """ externalBaseUrl: String! """ - External URL of the error + External URL of the error. """ externalUrl: String! """ - Commit the error was first seen + Commit the error was first seen. """ firstReleaseLastCommit: String """ - Release short version the error was first seen + Release short version the error was first seen. """ firstReleaseShortVersion: String """ - Release version the error was first seen + Release version the error was first seen. """ firstReleaseVersion: String """ - Timestamp when the error was first seen + Timestamp when the error was first seen. """ firstSeen: Time! """ - Last 24hr stats of the error + Last 24hr stats of the error. """ frequency: [SentryErrorFrequency!]! """ - GitLab commit SHA attributed to the Error based on the release version + GitLab commit SHA attributed to the Error based on the release version. """ gitlabCommit: String """ - Path to the GitLab page for the GitLab commit attributed to the error + Path to the GitLab page for the GitLab commit attributed to the error. """ gitlabCommitPath: String """ - URL of GitLab Issue + URL of GitLab Issue. """ gitlabIssuePath: String """ - ID (global ID) of the error + ID (global ID) of the error. """ id: ID! """ - Commit the error was last seen + Commit the error was last seen. """ lastReleaseLastCommit: String """ - Release short version the error was last seen + Release short version the error was last seen. """ lastReleaseShortVersion: String """ - Release version the error was last seen + Release version the error was last seen. """ lastReleaseVersion: String """ - Timestamp when the error was last seen + Timestamp when the error was last seen. """ lastSeen: Time! """ - Sentry metadata message of the error + Sentry metadata message of the error. """ message: String """ - ID (Sentry ID) of the error + ID (Sentry ID) of the error. """ sentryId: String! """ - ID of the project (Sentry project) + ID of the project (Sentry project). """ sentryProjectId: ID! """ - Name of the project affected by the error + Name of the project affected by the error. """ sentryProjectName: String! """ - Slug of the project affected by the error + Slug of the project affected by the error. """ sentryProjectSlug: String! """ - Short ID (Sentry ID) of the error + Short ID (Sentry ID) of the error. """ shortId: String! """ - Status of the error + Status of the error. """ status: SentryErrorStatus! """ - Tags associated with the Sentry Error + Tags associated with the Sentry Error. """ tags: SentryErrorTags! """ - Title of the error + Title of the error. """ title: String! """ - Type of the error + Type of the error. """ type: String! """ - Count of users affected by the error + Count of users affected by the error. """ userCount: Int! } @@ -22756,87 +24119,87 @@ A Sentry error. A simplified version of SentryDetailedError """ type SentryError { """ - Count of occurrences + Count of occurrences. """ count: Int! """ - Culprit of the error + Culprit of the error. """ culprit: String! """ - External URL of the error + External URL of the error. """ externalUrl: String! """ - Timestamp when the error was first seen + Timestamp when the error was first seen. """ firstSeen: Time! """ - Last 24hr stats of the error + Last 24hr stats of the error. """ frequency: [SentryErrorFrequency!]! """ - ID (global ID) of the error + ID (global ID) of the error. """ id: ID! """ - Timestamp when the error was last seen + Timestamp when the error was last seen. """ lastSeen: Time! """ - Sentry metadata message of the error + Sentry metadata message of the error. """ message: String """ - ID (Sentry ID) of the error + ID (Sentry ID) of the error. """ sentryId: String! """ - ID of the project (Sentry project) + ID of the project (Sentry project). """ sentryProjectId: ID! """ - Name of the project affected by the error + Name of the project affected by the error. """ sentryProjectName: String! """ - Slug of the project affected by the error + Slug of the project affected by the error. """ sentryProjectSlug: String! """ - Short ID (Sentry ID) of the error + Short ID (Sentry ID) of the error. """ shortId: String! """ - Status of the error + Status of the error. """ status: SentryErrorStatus! """ - Title of the error + Title of the error. """ title: String! """ - Type of the error + Type of the error. """ type: String! """ - Count of users affected by the error + Count of users affected by the error. """ userCount: Int! } @@ -22846,7 +24209,7 @@ An object containing a collection of Sentry errors, and a detailed error """ type SentryErrorCollection { """ - Detailed version of a Sentry error on the project + Detailed version of a Sentry error on the project. """ detailedError( """ @@ -22856,7 +24219,7 @@ type SentryErrorCollection { ): SentryDetailedError """ - Stack Trace of Sentry Error + Stack Trace of Sentry Error. """ errorStackTrace( """ @@ -22866,7 +24229,7 @@ type SentryErrorCollection { ): SentryErrorStackTrace """ - Collection of Sentry Errors + Collection of Sentry Errors. """ errors( """ @@ -22901,7 +24264,7 @@ type SentryErrorCollection { ): SentryErrorConnection """ - External URL for Sentry + External URL for Sentry. """ externalUrl: String } @@ -22943,12 +24306,12 @@ type SentryErrorEdge { type SentryErrorFrequency { """ - Count of errors received since the previously recorded time + Count of errors received since the previously recorded time. """ count: Int! """ - Time the error frequency stats were recorded + Time the error frequency stats were recorded. """ time: Time! } @@ -22958,17 +24321,17 @@ An object containing a stack trace entry for a Sentry error """ type SentryErrorStackTrace { """ - Time the stack trace was received by Sentry + Time the stack trace was received by Sentry. """ dateReceived: String! """ - ID of the Sentry error + ID of the Sentry error. """ issueId: String! """ - Stack trace entries for the Sentry error + Stack trace entries for the Sentry error. """ stackTraceEntries: [SentryErrorStackTraceEntry!]! } @@ -22978,12 +24341,12 @@ An object context for a Sentry error stack trace """ type SentryErrorStackTraceContext { """ - Code number of the context + Code number of the context. """ code: String! """ - Line number of the context + Line number of the context. """ line: Int! } @@ -22993,27 +24356,27 @@ An object containing a stack trace entry for a Sentry error """ type SentryErrorStackTraceEntry { """ - Function in which the Sentry error occurred + Function in which the Sentry error occurred. """ col: String """ - File in which the Sentry error occurred + File in which the Sentry error occurred. """ fileName: String """ - Function in which the Sentry error occurred + Function in which the Sentry error occurred. """ function: String """ - Function in which the Sentry error occurred + Function in which the Sentry error occurred. """ line: String """ - Context of the Sentry error + Context of the Sentry error. """ traceContext: [SentryErrorStackTraceContext!] } @@ -23048,24 +24411,24 @@ State of a Sentry error """ type SentryErrorTags { """ - Severity level of the Sentry Error + Severity level of the Sentry Error. """ level: String """ - Logger of the Sentry Error + Logger of the Sentry Error. """ logger: String } interface Service { """ - Indicates if the service is active + Indicates if the service is active. """ active: Boolean """ - Class name of the service + Class name of the service. """ type: String } @@ -23106,41 +24469,184 @@ type ServiceEdge { } enum ServiceType { + """ + AsanaService type + """ ASANA_SERVICE + + """ + AssemblaService type + """ ASSEMBLA_SERVICE + + """ + BambooService type + """ BAMBOO_SERVICE + + """ + BugzillaService type + """ BUGZILLA_SERVICE + + """ + BuildkiteService type + """ BUILDKITE_SERVICE + + """ + CampfireService type + """ CAMPFIRE_SERVICE + + """ + ConfluenceService type + """ CONFLUENCE_SERVICE + + """ + CustomIssueTrackerService type + """ CUSTOM_ISSUE_TRACKER_SERVICE + + """ + DatadogService type + """ DATADOG_SERVICE + + """ + DiscordService type + """ DISCORD_SERVICE + + """ + DroneCiService type + """ DRONE_CI_SERVICE + + """ + EmailsOnPushService type + """ EMAILS_ON_PUSH_SERVICE + + """ + EwmService type + """ EWM_SERVICE + + """ + ExternalWikiService type + """ EXTERNAL_WIKI_SERVICE + + """ + FlowdockService type + """ FLOWDOCK_SERVICE + + """ + GithubService type + """ GITHUB_SERVICE + + """ + HangoutsChatService type + """ HANGOUTS_CHAT_SERVICE + + """ + HipchatService type + """ HIPCHAT_SERVICE + + """ + IrkerService type + """ IRKER_SERVICE + + """ + JenkinsService type + """ JENKINS_SERVICE + + """ + JiraService type + """ JIRA_SERVICE + + """ + MattermostService type + """ MATTERMOST_SERVICE + + """ + MattermostSlashCommandsService type + """ MATTERMOST_SLASH_COMMANDS_SERVICE + + """ + MicrosoftTeamsService type + """ MICROSOFT_TEAMS_SERVICE + + """ + PackagistService type + """ PACKAGIST_SERVICE + + """ + PipelinesEmailService type + """ PIPELINES_EMAIL_SERVICE + + """ + PivotaltrackerService type + """ PIVOTALTRACKER_SERVICE + + """ + PrometheusService type + """ PROMETHEUS_SERVICE + + """ + PushoverService type + """ PUSHOVER_SERVICE + + """ + RedmineService type + """ REDMINE_SERVICE + + """ + SlackService type + """ SLACK_SERVICE + + """ + SlackSlashCommandsService type + """ SLACK_SLASH_COMMANDS_SERVICE + + """ + TeamcityService type + """ TEAMCITY_SERVICE + + """ + UnifyCircuitService type + """ UNIFY_CIRCUIT_SERVICE + + """ + WebexTeamsService type + """ WEBEX_TEAMS_SERVICE + + """ + YoutrackService type + """ YOUTRACK_SERVICE } @@ -23149,17 +24655,17 @@ Represents a snippet entry """ type Snippet implements Noteable { """ - The owner of the snippet + The owner of the snippet. """ author: User """ - Snippet blob Deprecated in 13.3: Use `blobs`. + Snippet blob. Deprecated in 13.3: Use `blobs`. """ blob: SnippetBlob! @deprecated(reason: "Use `blobs`. Deprecated in 13.3.") """ - Snippet blobs + Snippet blobs. """ blobs( """ @@ -23189,12 +24695,12 @@ type Snippet implements Noteable { ): SnippetBlobConnection """ - Timestamp this snippet was created + Timestamp this snippet was created. """ createdAt: Time! """ - Description of the snippet + Description of the snippet. """ description: String @@ -23204,7 +24710,7 @@ type Snippet implements Noteable { descriptionHtml: String """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -23229,22 +24735,22 @@ type Snippet implements Noteable { ): DiscussionConnection! """ - File Name of the snippet + File Name of the snippet. """ fileName: String """ - HTTP URL to the snippet repository + HTTP URL to the snippet repository. """ httpUrlToRepo: String """ - ID of the snippet + ID of the snippet. """ id: SnippetID! """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -23269,27 +24775,27 @@ type Snippet implements Noteable { ): NoteConnection! """ - The project the snippet is associated with + The project the snippet is associated with. """ project: Project """ - Raw URL of the snippet + Raw URL of the snippet. """ rawUrl: String! """ - SSH URL to the snippet repository + SSH URL to the snippet repository. """ sshUrlToRepo: String """ - Title of the snippet + Title of the snippet. """ title: String! """ - Timestamp this snippet was updated + Timestamp this snippet was updated. """ updatedAt: Time! @@ -23299,12 +24805,12 @@ type Snippet implements Noteable { userPermissions: SnippetPermissions! """ - Visibility Level of the snippet + Visibility Level of the snippet. """ visibilityLevel: VisibilityLevelsEnum! """ - Web URL of the snippet + Web URL of the snippet. """ webUrl: String! } @@ -23314,62 +24820,62 @@ Represents the snippet blob """ type SnippetBlob { """ - Shows whether the blob is binary + Shows whether the blob is binary. """ binary: Boolean! """ - Blob external storage + Blob external storage. """ externalStorage: String """ - Blob mode + Blob mode. """ mode: String """ - Blob name + Blob name. """ name: String """ - Blob path + Blob path. """ path: String """ - Blob plain highlighted data + Blob plain highlighted data. """ plainData: String """ - Blob raw content endpoint path + Blob raw content endpoint path. """ rawPath: String! """ - Shows whether the blob is rendered as text + Shows whether the blob is rendered as text. """ renderedAsText: Boolean! """ - Blob highlighted data + Blob highlighted data. """ richData: String """ - Blob content rich viewer + Blob content rich viewer. """ richViewer: SnippetBlobViewer """ - Blob content simple viewer + Blob content simple viewer. """ simpleViewer: SnippetBlobViewer! """ - Blob size + Blob size. """ size: Int! } @@ -23389,22 +24895,22 @@ Represents an action to perform over a snippet file """ input SnippetBlobActionInputType { """ - Type of input action + Type of input action. """ action: SnippetBlobActionEnum! """ - Snippet file content + Snippet file content. """ content: String """ - Path of the snippet file + Path of the snippet file. """ filePath: String! """ - Previous path of the snippet file + Previous path of the snippet file. """ previousPath: String } @@ -23449,37 +24955,37 @@ Represents how the blob content should be displayed """ type SnippetBlobViewer { """ - Shows whether the blob should be displayed collapsed + Shows whether the blob should be displayed collapsed. """ collapsed: Boolean! """ - Content file type + Content file type. """ fileType: String! """ - Shows whether the blob content is loaded async + Shows whether the blob content is loaded asynchronously. """ loadAsync: Boolean! """ - Loading partial name + Loading partial name. """ loadingPartialName: String! """ - Error rendering the blob content + Error rendering the blob content. """ renderError: String """ - Shows whether the blob too large to be displayed + Shows whether the blob too large to be displayed. """ tooLarge: Boolean! """ - Type of blob viewer + Type of blob viewer. """ type: BlobViewersType! } @@ -23520,7 +25026,7 @@ type SnippetEdge { } """ -Identifier of Snippet +Identifier of Snippet. """ scalar SnippetID @@ -23591,7 +25097,7 @@ type SnippetRepositoryRegistry { retryCount: Int """ - ID of the Snippet Repository + ID of the Snippet Repository. """ snippetRepositoryId: ID! @@ -23683,69 +25189,69 @@ enum Sort { type StatusAction { """ - Title for the button, for example: Retry this job + Title for the button, for example: Retry this job. """ buttonTitle: String """ - Icon used in the action button + Icon used in the action button. """ icon: String """ - Method for the action, for example: :post + Method for the action, for example: :post. """ method: String """ - Path for the action + Path for the action. """ path: String """ - Title for the action, for example: Retry + Title for the action, for example: Retry. """ title: String } type Submodule implements Entry { """ - Flat path of the entry + Flat path of the entry. """ flatPath: String! """ - ID of the entry + ID of the entry. """ id: ID! """ - Name of the entry + Name of the entry. """ name: String! """ - Path of the entry + Path of the entry. """ path: String! """ - Last commit sha for the entry + Last commit SHA for the entry. """ sha: String! """ - Tree URL for the sub-module + Tree URL for the sub-module. """ treeUrl: String """ - Type of tree entry + Type of tree entry. """ type: EntryType! """ - Web URL for the sub-module + Web URL for the sub-module. """ webUrl: String } @@ -23790,49 +25296,49 @@ Completion status of tasks """ type TaskCompletionStatus { """ - Number of completed tasks + Number of completed tasks. """ completedCount: Int! """ - Number of total tasks + Number of total tasks. """ count: Int! } type TerraformState { """ - Timestamp the Terraform state was created + Timestamp the Terraform state was created. """ createdAt: Time! """ - ID of the Terraform state + ID of the Terraform state. """ id: ID! """ - The latest version of the Terraform state + The latest version of the Terraform state. """ latestVersion: TerraformStateVersion """ - Timestamp the Terraform state was locked + Timestamp the Terraform state was locked. """ lockedAt: Time """ - The user currently holding a lock on the Terraform state + The user currently holding a lock on the Terraform state. """ lockedByUser: User """ - Name of the Terraform state + Name of the Terraform state. """ name: String! """ - Timestamp the Terraform state was updated + Timestamp the Terraform state was updated. """ updatedAt: Time! } @@ -23842,7 +25348,7 @@ The connection type for TerraformState. """ type TerraformStateConnection { """ - Total count of collection + Total count of collection. """ count: Int! @@ -23908,7 +25414,7 @@ type TerraformStateEdge { } """ -Identifier of Terraform::State +Identifier of Terraform::State. """ scalar TerraformStateID @@ -23974,37 +25480,37 @@ type TerraformStateUnlockPayload { type TerraformStateVersion { """ - Timestamp the version was created + Timestamp the version was created. """ createdAt: Time! """ - The user that created this version + The user that created this version. """ createdByUser: User """ - URL for downloading the version's JSON file + URL for downloading the version's JSON file. """ downloadPath: String """ - ID of the Terraform state version + ID of the Terraform state version. """ id: ID! """ - The job that created this version + The job that created this version. """ job: CiJob """ - Serial number of the version + Serial number of the version. """ serial: Int """ - Timestamp the version was updated + Timestamp the version was updated. """ updatedAt: Time! } @@ -24049,7 +25555,7 @@ type TerraformStateVersionRegistry { state: RegistryState """ - ID of the terraform state version + ID of the terraform state version. """ terraformStateVersionId: ID! } @@ -24094,22 +25600,22 @@ Represents a requirement test report """ type TestReport { """ - Author of the test report + Author of the test report. """ author: User """ - Timestamp of when the test report was created + Timestamp of when the test report was created. """ createdAt: Time! """ - ID of the test report + ID of the test report. """ id: ID! """ - State of the test report + State of the test report. """ state: TestReportState! } @@ -24167,17 +25673,17 @@ Represents the time report stats for timeboxes """ type TimeReportStats { """ - Completed issues metrics + Completed issues metrics. """ complete: TimeboxMetrics """ - Incomplete issues metrics + Incomplete issues metrics. """ incomplete: TimeboxMetrics """ - Total issues metrics + Total issues metrics. """ total: TimeboxMetrics } @@ -24187,12 +25693,12 @@ Represents measured stats metrics for timeboxes """ type TimeboxMetrics { """ - The count metric + The count metric. """ count: Int! """ - The weight metric + The weight metric. """ weight: Int! } @@ -24202,19 +25708,19 @@ Represents a historically accurate report about the timebox """ type TimeboxReport { """ - Daily scope and completed totals for burnup charts + Daily scope and completed totals for burnup charts. """ burnupTimeSeries: [BurnupChartDailyTotals!] """ - Represents the time report stats for the timebox + Represents the time report stats for the timebox. """ stats: TimeReportStats } interface TimeboxReportInterface { """ - Historically accurate report about the timebox + Historically accurate report about the timebox. """ report: TimeboxReport } @@ -24224,39 +25730,39 @@ A time-frame defined as a closed inclusive range of two dates """ input Timeframe { """ - The end of the range + The end of the range. """ end: Date! """ - The start of the range + The start of the range. """ start: Date! } type Timelog { """ - The issue that logged time was added to + The issue that logged time was added to. """ issue: Issue """ - The note where the quick action to add the logged time was executed + The note where the quick action to add the logged time was executed. """ note: Note """ - Timestamp of when the time tracked was spent at + Timestamp of when the time tracked was spent at. """ spentAt: Time """ - The time spent displayed in seconds + The time spent displayed in seconds. """ timeSpent: Int! """ - The user that logged the time + The user that logged the time. """ user: User! } @@ -24297,51 +25803,51 @@ type TimelogEdge { } """ -Representing a todo entry +Representing a to-do entry """ type Todo { """ - Action of the todo + Action of the to-do item. """ action: TodoActionEnum! """ - The author of this todo + The author of this to-do item. """ author: User! """ - Body of the todo + Body of the to-do item. """ body: String! """ - Timestamp this todo was created + Timestamp this to-do item was created. """ createdAt: Time! """ - Group this todo is associated with + Group this to-do item is associated with. """ group: Group """ - ID of the todo + ID of the to-do item. """ id: ID! """ - The project this todo is associated with + The project this to-do item is associated with. """ project: Project """ - State of the todo + State of the to-do item. """ state: TodoStateEnum! """ - Target type of the todo + Target type of the to-do item. """ targetType: TodoTargetEnum! } @@ -24406,7 +25912,7 @@ type TodoCreatePayload { errors: [String!]! """ - The to-do created. + The to-do item created. """ todo: Todo } @@ -24427,7 +25933,7 @@ type TodoEdge { } """ -Identifier of Todo +Identifier of Todo. """ scalar TodoID @@ -24441,7 +25947,7 @@ input TodoMarkDoneInput { clientMutationId: String """ - The global ID of the todo to mark as done. + The global ID of the to-do item to mark as done. """ id: TodoID! } @@ -24461,7 +25967,7 @@ type TodoMarkDonePayload { errors: [String!]! """ - The requested todo. + The requested to-do item. """ todo: Todo! } @@ -24476,7 +25982,7 @@ input TodoRestoreInput { clientMutationId: String """ - The global ID of the todo to restore. + The global ID of the to-do item to restore. """ id: TodoID! } @@ -24491,7 +25997,7 @@ input TodoRestoreManyInput { clientMutationId: String """ - The global IDs of the todos to restore (a maximum of 50 is supported at once). + The global IDs of the to-do items to restore (a maximum of 50 is supported at once). """ ids: [TodoID!]! } @@ -24511,14 +26017,14 @@ type TodoRestoreManyPayload { errors: [String!]! """ - Updated todos. + Updated to-do items. """ todos: [Todo!]! """ - The IDs of the updated todo items. Deprecated in 13.2: Use todos. + The IDs of the updated to-do items. Deprecated in 13.2: Use to-do items. """ - updatedIds: [TodoID!]! @deprecated(reason: "Use todos. Deprecated in 13.2.") + updatedIds: [TodoID!]! @deprecated(reason: "Use to-do items. Deprecated in 13.2.") } """ @@ -24536,7 +26042,7 @@ type TodoRestorePayload { errors: [String!]! """ - The requested todo. + The requested to-do item. """ todo: Todo! } @@ -24579,7 +26085,7 @@ enum TodoTargetEnum { } """ -Identifier of Todoable +Identifier of Todoable. """ scalar TodoableID @@ -24608,14 +26114,14 @@ type TodosMarkAllDonePayload { errors: [String!]! """ - Updated todos. + Updated to-do items. """ todos: [Todo!]! """ - Ids of the updated todos. Deprecated in 13.2: Use todos. + IDs of the updated to-do items. Deprecated in 13.2: Use to-do items. """ - updatedIds: [TodoID!]! @deprecated(reason: "Use todos. Deprecated in 13.2.") + updatedIds: [TodoID!]! @deprecated(reason: "Use to-do items. Deprecated in 13.2.") } """ @@ -24633,7 +26139,7 @@ input ToggleAwardEmojiInput { clientMutationId: String """ - The emoji name + The emoji name. """ name: String! } @@ -24665,7 +26171,7 @@ type ToggleAwardEmojiPayload { type Tree { """ - Blobs of the tree + Blobs of the tree. """ blobs( """ @@ -24690,12 +26196,12 @@ type Tree { ): BlobConnection! """ - Last commit for the tree + Last commit for the tree. """ lastCommit: Commit """ - Sub-modules of the tree + Sub-modules of the tree. """ submodules( """ @@ -24720,7 +26226,7 @@ type Tree { ): SubmoduleConnection! """ - Trees of the tree + Trees of the tree. """ trees( """ @@ -24750,42 +26256,42 @@ Represents a directory """ type TreeEntry implements Entry { """ - Flat path of the entry + Flat path of the entry. """ flatPath: String! """ - ID of the entry + ID of the entry. """ id: ID! """ - Name of the entry + Name of the entry. """ name: String! """ - Path of the entry + Path of the entry. """ path: String! """ - Last commit sha for the entry + Last commit SHA for the entry. """ sha: String! """ - Type of tree entry + Type of tree entry. """ type: EntryType! """ - Web path for the tree entry (directory) + Web path for the tree entry (directory). """ webPath: String """ - Web URL for the tree entry (directory) + Web URL for the tree entry (directory). """ webUrl: String } @@ -24885,7 +26391,7 @@ type UpdateAlertStatusPayload { issue: Issue """ - The todo after mutation. + The to-do item after mutation. """ todo: Todo } @@ -24950,12 +26456,12 @@ input UpdateBoardInput { clientMutationId: String """ - Whether or not backlog list is hidden + Whether or not backlog list is hidden. """ hideBacklogList: Boolean """ - Whether or not closed list is hidden + Whether or not closed list is hidden. """ hideClosedList: Boolean @@ -24975,7 +26481,7 @@ input UpdateBoardInput { labelIds: [LabelID!] """ - Labels of the issue + Labels of the issue. """ labels: [String!] @@ -25105,7 +26611,7 @@ Autogenerated input type of UpdateContainerExpirationPolicy """ input UpdateContainerExpirationPolicyInput { """ - This container expiration policy schedule + This container expiration policy schedule. """ cadence: ContainerExpirationPolicyCadenceEnum @@ -25115,27 +26621,27 @@ input UpdateContainerExpirationPolicyInput { clientMutationId: String """ - Indicates whether this container expiration policy is enabled + Indicates whether this container expiration policy is enabled. """ enabled: Boolean """ - Number of tags to retain + Number of tags to retain. """ keepN: ContainerExpirationPolicyKeepEnum """ - Tags with names matching this regex pattern will expire + Tags with names matching this regex pattern will expire. """ nameRegex: UntrustedRegexp """ - Tags with names matching this regex pattern will be preserved + Tags with names matching this regex pattern will be preserved. """ nameRegexKeep: UntrustedRegexp """ - Tags older that this will expire + Tags older that this will expire. """ olderThan: ContainerExpirationPolicyOlderThanEnum @@ -25165,69 +26671,24 @@ type UpdateContainerExpirationPolicyPayload { errors: [String!]! } -""" -Autogenerated input type of UpdateDevopsAdoptionSegment -""" -input UpdateDevopsAdoptionSegmentInput { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - The array of group IDs to set for the segment. - """ - groupIds: [GroupID!] - - """ - ID of the segment. - """ - id: AnalyticsDevopsAdoptionSegmentID! - - """ - Name of the segment. - """ - name: String! -} - -""" -Autogenerated return type of UpdateDevopsAdoptionSegment -""" -type UpdateDevopsAdoptionSegmentPayload { - """ - A unique identifier for the client performing the mutation. - """ - clientMutationId: String - - """ - Errors encountered during execution of the mutation. - """ - errors: [String!]! - - """ - The segment after mutation. - """ - segment: DevopsAdoptionSegment -} - input UpdateDiffImagePositionInput { """ - Total height of the image + Total height of the image. """ height: Int """ - Total width of the image + Total width of the image. """ width: Int """ - X position of the note + X position of the note. """ x: Int """ - Y position of the note + Y position of the note. """ y: Int } @@ -25327,7 +26788,7 @@ Autogenerated input type of UpdateImageDiffNote """ input UpdateImageDiffNoteInput { """ - Content of the note + Content of the note. """ body: String @@ -25342,7 +26803,7 @@ input UpdateImageDiffNoteInput { id: NoteID! """ - The position of this note on a diff + The position of this note on a diff. """ position: UpdateDiffImagePositionInput } @@ -25382,17 +26843,17 @@ input UpdateIssueInput { clientMutationId: String """ - Indicates the issue is confidential + Indicates the issue is confidential. """ confidential: Boolean """ - Description of the issue + Description of the issue. """ description: String """ - Due date of the issue + Due date of the issue. """ dueDate: ISO8601Date @@ -25412,7 +26873,7 @@ input UpdateIssueInput { iid: String! """ - Indicates discussion is locked on the issue + Indicates discussion is locked on the issue. """ locked: Boolean @@ -25437,7 +26898,7 @@ input UpdateIssueInput { stateEvent: IssueStateEvent """ - Title of the issue + Title of the issue. """ title: String @@ -25578,7 +27039,7 @@ Autogenerated input type of UpdateNote """ input UpdateNoteInput { """ - Content of the note + Content of the note. """ body: String @@ -25688,6 +27149,13 @@ input UpdateSnippetInput { blobActions: [SnippetBlobActionInputType!] """ + A valid CAPTCHA response value obtained by using the provided captchaSiteKey + with a CAPTCHA API to present a challenge to be solved on the client. Required + to resubmit if the previous operation returned "NeedsCaptchaResponse: true". + """ + captchaResponse: String + + """ A unique identifier for the client performing the mutation. """ clientMutationId: String @@ -25703,6 +27171,13 @@ input UpdateSnippetInput { id: SnippetID! """ + The spam log ID which must be passed along with a valid CAPTCHA response for + the operation to be completed. Required to resubmit if the previous operation + returned "NeedsCaptchaResponse: true". + """ + spamLogId: Int + + """ Title of the snippet. """ title: String @@ -25718,6 +27193,13 @@ Autogenerated return type of UpdateSnippet """ type UpdateSnippetPayload { """ + The CAPTCHA site key which must be used to render a challenge for the user to + solve to obtain a valid captchaResponse value. Included only when an operation + was not completed because "NeedsCaptchaResponse" is true. + """ + captchaSiteKey: String + + """ A unique identifier for the client performing the mutation. """ clientMutationId: String @@ -25728,21 +27210,38 @@ type UpdateSnippetPayload { errors: [String!]! """ + Indicates whether the operation was detected as possible spam and not + completed. If CAPTCHA is enabled, the request must be resubmitted with a valid + CAPTCHA response and spam_log_id included for the operation to be completed. + Included only when an operation was not completed because + "NeedsCaptchaResponse" is true. + """ + needsCaptchaResponse: Boolean + + """ The snippet after mutation. """ snippet: Snippet """ - Indicates whether the operation returns a record detected as spam. + Indicates whether the operation was detected as definite spam. There is no + option to resubmit the request with a CAPTCHA response. """ spam: Boolean + + """ + The spam log ID which must be passed along with a valid CAPTCHA response for + an operation to be completed. Included only when an operation was not + completed because "NeedsCaptchaResponse" is true. + """ + spamLogId: Int } scalar Upload type User { """ - Merge Requests assigned to the user + Merge Requests assigned to the user. """ assignedMergeRequests( """ @@ -25832,7 +27331,7 @@ type User { ): MergeRequestConnection """ - Merge Requests authored by the user + Merge Requests authored by the user. """ authoredMergeRequests( """ @@ -25922,22 +27421,27 @@ type User { ): MergeRequestConnection """ - URL of the user's avatar + URL of the user's avatar. """ avatarUrl: String """ - User email Deprecated in 13.7: Use public_email. + Indicates if the user is a bot. + """ + bot: Boolean! + + """ + User email. Deprecated in 13.7: Use public_email. """ email: String @deprecated(reason: "Use public_email. Deprecated in 13.7.") """ - Group count for the user Available only when feature flag `user_group_counts` is enabled. + Group count for the user. Available only when feature flag `user_group_counts` is enabled. """ groupCount: Int """ - Group memberships of the user + Group memberships of the user. """ groupMemberships( """ @@ -25962,7 +27466,7 @@ type User { ): GroupMemberConnection """ - ID of the user + ID of the user. """ id: ID! @@ -25972,12 +27476,12 @@ type User { location: String """ - Human-readable name of the user + Human-readable name of the user. """ name: String! """ - Project memberships of the user + Project memberships of the user. """ projectMemberships( """ @@ -26002,12 +27506,12 @@ type User { ): ProjectMemberConnection """ - User's public email + User's public email. """ publicEmail: String """ - Merge Requests assigned to the user for review + Merge Requests assigned to the user for review. """ reviewRequestedMergeRequests( """ @@ -26097,7 +27601,7 @@ type User { ): MergeRequestConnection """ - Snippets authored by the user + Snippets authored by the user. """ snippets( """ @@ -26137,7 +27641,7 @@ type User { ): SnippetConnection """ - Projects starred by the user + Projects starred by the user. """ starredProjects( """ @@ -26167,17 +27671,17 @@ type User { ): ProjectConnection """ - State of the user + State of the user. """ state: UserState! """ - User status + User status. """ status: UserStatus """ - Todos of the user + To-do items of the user. """ todos( """ @@ -26237,17 +27741,17 @@ type User { userPermissions: UserPermissions! """ - Username of the user. Unique within this instance of GitLab + Username of the user. Unique within this instance of GitLab. """ username: String! """ - Web path of the user + Web path of the user. """ webPath: String! """ - Web URL of the user + Web URL of the user. """ webUrl: String! } @@ -26288,7 +27792,7 @@ type UserEdge { } """ -Identifier of User +Identifier of User. """ scalar UserID @@ -26321,17 +27825,17 @@ enum UserState { type UserStatus { """ - User availability status + User availability status. """ availability: AvailabilityEnum! """ - String representation of emoji + String representation of emoji. """ emoji: String """ - User status message + User status message. """ message: String @@ -26363,7 +27867,7 @@ type VulnerabilitiesCountByDay { critical: Int! """ - Date for the count + Date for the count. """ date: ISO8601Date! @@ -26388,7 +27892,7 @@ type VulnerabilitiesCountByDay { medium: Int! """ - Total number of vulnerabilities on a particular day + Total number of vulnerabilities on a particular day. """ total: Int! @@ -26403,17 +27907,17 @@ Represents the number of vulnerabilities for a particular severity on a particul """ type VulnerabilitiesCountByDayAndSeverity { """ - Number of vulnerabilities + Number of vulnerabilities. """ count: Int """ - Date for the count + Date for the count. """ day: ISO8601Date """ - Severity of the counted vulnerabilities + Severity of the counted vulnerabilities. """ severity: VulnerabilitySeverity } @@ -26489,7 +27993,7 @@ type VulnerabilitiesCountByDayEdge { } """ -Identifier of Vulnerabilities::ExternalIssueLink +Identifier of Vulnerabilities::ExternalIssueLink. """ scalar VulnerabilitiesExternalIssueLinkID @@ -26498,7 +28002,7 @@ Represents a vulnerability """ type Vulnerability implements Noteable { """ - Timestamp of when the vulnerability state was changed to confirmed + Timestamp of when the vulnerability state was changed to confirmed. """ confirmedAt: Time @@ -26508,17 +28012,22 @@ type Vulnerability implements Noteable { confirmedBy: User """ - Description of the vulnerability + Description of the vulnerability. """ description: String """ - Timestamp of when the vulnerability was first detected + Details of the vulnerability. + """ + details: [VulnerabilityDetail!]! + + """ + Timestamp of when the vulnerability was first detected. """ detectedAt: Time! """ - All discussions on this noteable + All discussions on this noteable. """ discussions( """ @@ -26543,7 +28052,7 @@ type Vulnerability implements Noteable { ): DiscussionConnection! """ - Timestamp of when the vulnerability state was changed to dismissed + Timestamp of when the vulnerability state was changed to dismissed. """ dismissedAt: Time @@ -26553,7 +28062,7 @@ type Vulnerability implements Noteable { dismissedBy: User """ - List of external issue links related to the vulnerability + List of external issue links related to the vulnerability. """ externalIssueLinks( """ @@ -26583,7 +28092,7 @@ type Vulnerability implements Noteable { hasSolutions: Boolean """ - GraphQL ID of the vulnerability + GraphQL ID of the vulnerability. """ id: ID! @@ -26593,7 +28102,7 @@ type Vulnerability implements Noteable { identifiers: [VulnerabilityIdentifier!]! """ - List of issue links related to the vulnerability + List of issue links related to the vulnerability. """ issueLinks( """ @@ -26623,7 +28132,7 @@ type Vulnerability implements Noteable { ): VulnerabilityIssueLinkConnection! """ - Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability + Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. """ location: VulnerabilityLocation @@ -26633,7 +28142,7 @@ type Vulnerability implements Noteable { mergeRequest: MergeRequest """ - All notes on this noteable + All notes on this noteable. """ notes( """ @@ -26663,7 +28172,7 @@ type Vulnerability implements Noteable { primaryIdentifier: VulnerabilityIdentifier """ - The project on which the vulnerability was found + The project on which the vulnerability was found. """ project: Project @@ -26675,7 +28184,7 @@ type Vulnerability implements Noteable { reportType: VulnerabilityReportType """ - Timestamp of when the vulnerability state was changed to resolved + Timestamp of when the vulnerability state was changed to resolved. """ resolvedAt: Time @@ -26685,7 +28194,7 @@ type Vulnerability implements Noteable { resolvedBy: User """ - Indicates whether the vulnerability is fixed on the default branch or not + Indicates whether the vulnerability is fixed on the default branch or not. """ resolvedOnDefaultBranch: Boolean! @@ -26705,12 +28214,12 @@ type Vulnerability implements Noteable { state: VulnerabilityState """ - Title of the vulnerability + Title of the vulnerability. """ title: String """ - Number of user notes attached to the vulnerability + Number of user notes attached to the vulnerability. """ userNotesCount: Int! @@ -26720,7 +28229,7 @@ type Vulnerability implements Noteable { userPermissions: VulnerabilityPermissions! """ - URL to the vulnerability's details page + URL to the vulnerability's details page. """ vulnerabilityPath: String } @@ -26781,6 +28290,366 @@ type VulnerabilityConnection { } """ +Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type +""" +union VulnerabilityDetail = VulnerabilityDetailBase | VulnerabilityDetailBoolean | VulnerabilityDetailCode | VulnerabilityDetailCommit | VulnerabilityDetailDiff | VulnerabilityDetailFileLocation | VulnerabilityDetailInt | VulnerabilityDetailList | VulnerabilityDetailMarkdown | VulnerabilityDetailModuleLocation | VulnerabilityDetailTable | VulnerabilityDetailText | VulnerabilityDetailUrl + +""" +Represents the vulnerability details base +""" +type VulnerabilityDetailBase { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! +} + +""" +Represents the vulnerability details boolean value +""" +type VulnerabilityDetailBoolean { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! + + """ + Value of the field. + """ + value: Boolean! +} + +""" +Represents the vulnerability details code field +""" +type VulnerabilityDetailCode { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Language of the code. + """ + lang: String + + """ + Name of the field. + """ + name: String! + + """ + Source code. + """ + value: String! +} + +""" +Represents the vulnerability details commit field +""" +type VulnerabilityDetailCommit { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! + + """ + The commit SHA value. + """ + value: String! +} + +""" +Represents the vulnerability details diff field +""" +type VulnerabilityDetailDiff { + """ + Value of the field after the change. + """ + after: String! + + """ + Value of the field before the change. + """ + before: String! + + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! +} + +""" +Represents the vulnerability details location within a file in the project +""" +type VulnerabilityDetailFileLocation { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + File name. + """ + fileName: String! + + """ + End line number of the file location. + """ + lineEnd: Int! + + """ + Start line number of the file location. + """ + lineStart: Int! + + """ + Name of the field. + """ + name: String! +} + +""" +Represents the vulnerability details integer value +""" +type VulnerabilityDetailInt { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! + + """ + Value of the field. + """ + value: Int! +} + +""" +Represents the vulnerability details list value +""" +type VulnerabilityDetailList { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + List of details. + """ + items: [VulnerabilityDetail!]! + + """ + Name of the field. + """ + name: String! +} + +""" +Represents the vulnerability details Markdown field +""" +type VulnerabilityDetailMarkdown { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! + + """ + Value of the Markdown field. + """ + value: String! +} + +""" +Represents the vulnerability details location within a file in the project +""" +type VulnerabilityDetailModuleLocation { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Module name. + """ + moduleName: String! + + """ + Name of the field. + """ + name: String! + + """ + Offset of the module location. + """ + offset: Int! +} + +""" +Represents the vulnerability details table value +""" +type VulnerabilityDetailTable { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Table headers. + """ + headers: [VulnerabilityDetail!]! + + """ + Name of the field. + """ + name: String! + + """ + Table rows. + """ + rows: [VulnerabilityDetail!]! +} + +""" +Represents the vulnerability details text field +""" +type VulnerabilityDetailText { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Name of the field. + """ + name: String! + + """ + Value of the text field. + """ + value: String! +} + +""" +Represents the vulnerability details URL field +""" +type VulnerabilityDetailUrl { + """ + Description of the field. + """ + description: String! + + """ + Name of the field. + """ + fieldName: String + + """ + Href of the URL. + """ + href: String! + + """ + Name of the field. + """ + name: String! + + """ + Text of the URL. + """ + text: String +} + +""" Autogenerated input type of VulnerabilityDismiss """ input VulnerabilityDismissInput { @@ -26875,17 +28744,17 @@ Represents an external issue link of a vulnerability """ type VulnerabilityExternalIssueLink { """ - The external issue attached to the issue link + The external issue attached to the issue link. """ externalIssue: ExternalIssue """ - GraphQL ID of the external issue link + GraphQL ID of the external issue link. """ id: VulnerabilitiesExternalIssueLinkID! """ - Type of the external issue link + Type of the external issue link. """ linkType: VulnerabilityExternalIssueLinkType! } @@ -27032,7 +28901,7 @@ enum VulnerabilityGrade { } """ -Identifier of Vulnerability +Identifier of Vulnerability. """ scalar VulnerabilityID @@ -27041,22 +28910,22 @@ Represents a vulnerability identifier """ type VulnerabilityIdentifier { """ - External ID of the vulnerability identifier + External ID of the vulnerability identifier. """ externalId: String """ - External type of the vulnerability identifier + External type of the vulnerability identifier. """ externalType: String """ - Name of the vulnerability identifier + Name of the vulnerability identifier. """ name: String """ - URL of the vulnerability identifier + URL of the vulnerability identifier. """ url: String } @@ -27066,17 +28935,17 @@ Represents an issue link of a vulnerability """ type VulnerabilityIssueLink { """ - GraphQL ID of the vulnerability + GraphQL ID of the vulnerability. """ id: ID! """ - The issue attached to issue link + The issue attached to issue link. """ issue: Issue! """ - Type of the issue link + Type of the issue link. """ linkType: VulnerabilityIssueLinkType! } @@ -27134,17 +29003,17 @@ Represents the location of a vulnerability found by a container security scan """ type VulnerabilityLocationContainerScanning { """ - Dependency containing the vulnerability + Dependency containing the vulnerability. """ dependency: VulnerableDependency """ - Name of the vulnerable container image + Name of the vulnerable container image. """ image: String """ - Operating system that runs on the vulnerable container image + Operating system that runs on the vulnerable container image. """ operatingSystem: String } @@ -27154,27 +29023,32 @@ Represents the location of a vulnerability found by a Coverage Fuzzing scan """ type VulnerabilityLocationCoverageFuzzing { """ - Number of the last relevant line in the vulnerable file + Blob path to the vulnerable file. + """ + blobPath: String + + """ + Number of the last relevant line in the vulnerable file. """ endLine: String """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String """ - Number of the first relevant line in the vulnerable file + Number of the first relevant line in the vulnerable file. """ startLine: String """ - Class containing the vulnerability + Class containing the vulnerability. """ vulnerableClass: String """ - Method containing the vulnerability + Method containing the vulnerability. """ vulnerableMethod: String } @@ -27184,22 +29058,22 @@ Represents the location of a vulnerability found by a DAST scan """ type VulnerabilityLocationDast { """ - Domain name of the vulnerable request + Domain name of the vulnerable request. """ hostname: String """ - Query parameter for the URL on which the vulnerability occurred + Query parameter for the URL on which the vulnerability occurred. """ param: String """ - URL path and query string of the vulnerable request + URL path and query string of the vulnerable request. """ path: String """ - HTTP method of the vulnerable request + HTTP method of the vulnerable request. """ requestMethod: String } @@ -27209,12 +29083,17 @@ Represents the location of a vulnerability found by a dependency security scan """ type VulnerabilityLocationDependencyScanning { """ - Dependency containing the vulnerability + Blob path to the vulnerable file. + """ + blobPath: String + + """ + Dependency containing the vulnerability. """ dependency: VulnerableDependency """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String } @@ -27224,27 +29103,32 @@ Represents the location of a vulnerability found by a SAST scan """ type VulnerabilityLocationSast { """ - Number of the last relevant line in the vulnerable file + Blob path to the vulnerable file. + """ + blobPath: String + + """ + Number of the last relevant line in the vulnerable file. """ endLine: String """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String """ - Number of the first relevant line in the vulnerable file + Number of the first relevant line in the vulnerable file. """ startLine: String """ - Class containing the vulnerability + Class containing the vulnerability. """ vulnerableClass: String """ - Method containing the vulnerability + Method containing the vulnerability. """ vulnerableMethod: String } @@ -27254,27 +29138,32 @@ Represents the location of a vulnerability found by a secret detection scan """ type VulnerabilityLocationSecretDetection { """ - Number of the last relevant line in the vulnerable file + Blob path to the vulnerable file. + """ + blobPath: String + + """ + Number of the last relevant line in the vulnerable file. """ endLine: String """ - Path to the vulnerable file + Path to the vulnerable file. """ file: String """ - Number of the first relevant line in the vulnerable file + Number of the first relevant line in the vulnerable file. """ startLine: String """ - Class containing the vulnerability + Class containing the vulnerability. """ vulnerableClass: String """ - Method containing the vulnerability + Method containing the vulnerability. """ vulnerableMethod: String } @@ -27417,22 +29306,22 @@ Represents a vulnerability scanner """ type VulnerabilityScanner { """ - External ID of the vulnerability scanner + External ID of the vulnerability scanner. """ externalId: String """ - Name of the vulnerability scanner + Name of the vulnerability scanner. """ name: String """ - Type of the vulnerability report + Type of the vulnerability report. """ reportType: VulnerabilityReportType """ - Vendor of the vulnerability scanner + Vendor of the vulnerability scanner. """ vendor: String } @@ -27589,12 +29478,12 @@ Represents a vulnerable dependency. Used in vulnerability location data """ type VulnerableDependency { """ - The package associated with the vulnerable dependency + The package associated with the vulnerable dependency. """ package: VulnerablePackage """ - The version of the vulnerable dependency + The version of the vulnerable dependency. """ version: String } @@ -27604,7 +29493,7 @@ Represents a vulnerable package. Used in vulnerability dependency data """ type VulnerablePackage { """ - The name of the vulnerable package + The name of the vulnerable package. """ name: String } @@ -27614,17 +29503,17 @@ Represents vulnerability letter grades with associated projects """ type VulnerableProjectsByGrade { """ - Number of projects within this grade + Number of projects within this grade. """ count: Int! """ - Grade based on the highest severity vulnerability present + Grade based on the highest severity vulnerability present. """ grade: VulnerabilityGrade! """ - Projects within this grade + Projects within this grade. """ projects( """ diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 138530abb17..492682d2e54 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -16,7 +16,7 @@ "fields": [ { "name": "integerValue", - "description": "Integer representation of access level", + "description": "Integer representation of access level.", "args": [ ], @@ -30,7 +30,7 @@ }, { "name": "stringValue", - "description": "String representation of access level", + "description": "String representation of access level.", "args": [ ], @@ -119,7 +119,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "type": { "kind": "NON_NULL", "name": null, @@ -504,7 +504,7 @@ "fields": [ { "name": "assignees", - "description": "Assignees of the alert", + "description": "Assignees of the alert.", "args": [ { "name": "after", @@ -557,7 +557,7 @@ }, { "name": "createdAt", - "description": "Timestamp the alert was created", + "description": "Timestamp the alert was created.", "args": [ ], @@ -571,7 +571,7 @@ }, { "name": "description", - "description": "Description of the alert", + "description": "Description of the alert.", "args": [ ], @@ -585,7 +585,7 @@ }, { "name": "details", - "description": "Alert details", + "description": "Alert details.", "args": [ ], @@ -599,7 +599,7 @@ }, { "name": "detailsUrl", - "description": "The URL of the alert detail page", + "description": "The URL of the alert detail page.", "args": [ ], @@ -617,7 +617,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -674,7 +674,7 @@ }, { "name": "endedAt", - "description": "Timestamp the alert ended", + "description": "Timestamp the alert ended.", "args": [ ], @@ -688,7 +688,7 @@ }, { "name": "environment", - "description": "Environment for the alert", + "description": "Environment for the alert.", "args": [ ], @@ -702,7 +702,7 @@ }, { "name": "eventCount", - "description": "Number of events of this alert", + "description": "Number of events of this alert.", "args": [ ], @@ -716,7 +716,7 @@ }, { "name": "hosts", - "description": "List of hosts the alert came from", + "description": "List of hosts the alert came from.", "args": [ ], @@ -738,7 +738,7 @@ }, { "name": "iid", - "description": "Internal ID of the alert", + "description": "Internal ID of the alert.", "args": [ ], @@ -756,7 +756,7 @@ }, { "name": "issueIid", - "description": "Internal ID of the GitLab issue attached to the alert", + "description": "Internal ID of the GitLab issue attached to the alert.", "args": [ ], @@ -770,7 +770,7 @@ }, { "name": "metricsDashboardUrl", - "description": "URL for metrics embed for the alert", + "description": "URL for metrics embed for the alert.", "args": [ ], @@ -784,7 +784,7 @@ }, { "name": "monitoringTool", - "description": "Monitoring tool the alert came from", + "description": "Monitoring tool the alert came from.", "args": [ ], @@ -798,7 +798,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -855,7 +855,7 @@ }, { "name": "prometheusAlert", - "description": "The alert condition for Prometheus", + "description": "The alert condition for Prometheus.", "args": [ ], @@ -869,7 +869,7 @@ }, { "name": "runbook", - "description": "Runbook for the alert as defined in alert details", + "description": "Runbook for the alert as defined in alert details.", "args": [ ], @@ -883,7 +883,7 @@ }, { "name": "service", - "description": "Service the alert came from", + "description": "Service the alert came from.", "args": [ ], @@ -897,7 +897,7 @@ }, { "name": "severity", - "description": "Severity of the alert", + "description": "Severity of the alert.", "args": [ ], @@ -911,7 +911,7 @@ }, { "name": "startedAt", - "description": "Timestamp the alert was raised", + "description": "Timestamp the alert was raised.", "args": [ ], @@ -925,7 +925,7 @@ }, { "name": "status", - "description": "Status of the alert", + "description": "Status of the alert.", "args": [ ], @@ -939,7 +939,7 @@ }, { "name": "title", - "description": "Title of the alert", + "description": "Title of the alert.", "args": [ ], @@ -953,7 +953,7 @@ }, { "name": "todos", - "description": "Todos of the current user for the alert", + "description": "To-do items of the current user for the alert.", "args": [ { "name": "action", @@ -1114,7 +1114,7 @@ }, { "name": "updatedAt", - "description": "Timestamp the alert was last updated", + "description": "Timestamp the alert was last updated.", "args": [ ], @@ -1414,7 +1414,7 @@ }, { "name": "all", - "description": "Total number of alerts for the project", + "description": "Total number of alerts for the project.", "args": [ ], @@ -1442,7 +1442,7 @@ }, { "name": "open", - "description": "Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project", + "description": "Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project.", "args": [ ], @@ -1520,7 +1520,7 @@ "fields": [ { "name": "active", - "description": "Whether the endpoint is currently accepting alerts", + "description": "Whether the endpoint is currently accepting alerts.", "args": [ ], @@ -1534,7 +1534,7 @@ }, { "name": "apiUrl", - "description": "URL at which Prometheus metrics can be queried to populate the metrics dashboard", + "description": "URL at which Prometheus metrics can be queried to populate the metrics dashboard.", "args": [ ], @@ -1548,7 +1548,7 @@ }, { "name": "id", - "description": "ID of the integration", + "description": "ID of the integration.", "args": [ ], @@ -1566,7 +1566,7 @@ }, { "name": "name", - "description": "Name of the integration", + "description": "Name of the integration.", "args": [ ], @@ -1580,7 +1580,7 @@ }, { "name": "token", - "description": "Token used to authenticate alert notification requests", + "description": "Token used to authenticate alert notification requests.", "args": [ ], @@ -1594,7 +1594,7 @@ }, { "name": "type", - "description": "Type of integration", + "description": "Type of integration.", "args": [ ], @@ -1612,7 +1612,7 @@ }, { "name": "url", - "description": "Endpoint which accepts alert notifications", + "description": "Endpoint which accepts alert notifications.", "args": [ ], @@ -1639,7 +1639,7 @@ { "kind": "SCALAR", "name": "AlertManagementHttpIntegrationID", - "description": "Identifier of AlertManagement::HttpIntegration", + "description": "Identifier of AlertManagement::HttpIntegration.", "fields": null, "inputFields": null, "interfaces": null, @@ -1653,7 +1653,7 @@ "fields": [ { "name": "active", - "description": "Whether the endpoint is currently accepting alerts", + "description": "Whether the endpoint is currently accepting alerts.", "args": [ ], @@ -1667,7 +1667,7 @@ }, { "name": "apiUrl", - "description": "URL at which Prometheus metrics can be queried to populate the metrics dashboard", + "description": "URL at which Prometheus metrics can be queried to populate the metrics dashboard.", "args": [ ], @@ -1681,7 +1681,7 @@ }, { "name": "id", - "description": "ID of the integration", + "description": "ID of the integration.", "args": [ ], @@ -1699,7 +1699,7 @@ }, { "name": "name", - "description": "Name of the integration", + "description": "Name of the integration.", "args": [ ], @@ -1713,7 +1713,7 @@ }, { "name": "token", - "description": "Token used to authenticate alert notification requests", + "description": "Token used to authenticate alert notification requests.", "args": [ ], @@ -1727,7 +1727,7 @@ }, { "name": "type", - "description": "Type of integration", + "description": "Type of integration.", "args": [ ], @@ -1745,7 +1745,7 @@ }, { "name": "url", - "description": "Endpoint which accepts alert notifications", + "description": "Endpoint which accepts alert notifications.", "args": [ ], @@ -1910,6 +1910,69 @@ "possibleTypes": null }, { + "kind": "OBJECT", + "name": "AlertManagementPayloadAlertField", + "description": "Parsed field from an alert used for custom mappings", + "fields": [ + { + "name": "label", + "description": "Human-readable label of the payload path.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path", + "description": "Path to value inside payload JSON.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Type of the parsed value.", + "args": [ + + ], + "type": { + "kind": "ENUM", + "name": "AlertManagementPayloadAlertFieldType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "INPUT_OBJECT", "name": "AlertManagementPayloadAlertFieldInput", "description": "Field that are available while modifying the custom mapping attributes for an HTTP integration", @@ -2087,7 +2150,7 @@ "fields": [ { "name": "active", - "description": "Whether the endpoint is currently accepting alerts", + "description": "Whether the endpoint is currently accepting alerts.", "args": [ ], @@ -2101,7 +2164,7 @@ }, { "name": "apiUrl", - "description": "URL at which Prometheus metrics can be queried to populate the metrics dashboard", + "description": "URL at which Prometheus metrics can be queried to populate the metrics dashboard.", "args": [ ], @@ -2115,7 +2178,7 @@ }, { "name": "id", - "description": "ID of the integration", + "description": "ID of the integration.", "args": [ ], @@ -2133,7 +2196,7 @@ }, { "name": "name", - "description": "Name of the integration", + "description": "Name of the integration.", "args": [ ], @@ -2147,7 +2210,7 @@ }, { "name": "token", - "description": "Token used to authenticate alert notification requests", + "description": "Token used to authenticate alert notification requests.", "args": [ ], @@ -2161,7 +2224,7 @@ }, { "name": "type", - "description": "Type of integration", + "description": "Type of integration.", "args": [ ], @@ -2179,7 +2242,7 @@ }, { "name": "url", - "description": "Endpoint which accepts alert notifications", + "description": "Endpoint which accepts alert notifications.", "args": [ ], @@ -2441,7 +2504,7 @@ }, { "name": "todo", - "description": "The todo after mutation.", + "description": "The to-do item after mutation.", "args": [ ], @@ -2585,7 +2648,7 @@ }, { "name": "todo", - "description": "The todo after mutation.", + "description": "The to-do item after mutation.", "args": [ ], @@ -2608,10 +2671,333 @@ { "kind": "SCALAR", "name": "AnalyticsDevopsAdoptionSegmentID", - "description": "Identifier of Analytics::DevopsAdoption::Segment", + "description": "Identifier of Analytics::DevopsAdoption::Segment.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApiFuzzingCiConfiguration", + "description": "Data associated with configuring API fuzzing scans in GitLab CI", + "fields": [ + { + "name": "scanModes", + "description": "All available scan modes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ApiFuzzingScanMode", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scanProfiles", + "description": "All default scan profiles.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ApiFuzzingScanProfile", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApiFuzzingCiConfigurationCreateInput", + "description": "Autogenerated input type of ApiFuzzingCiConfigurationCreate", + "fields": null, + "inputFields": [ + { + "name": "projectPath", + "description": "Full path of the project.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "apiSpecificationFile", + "description": "File path or URL to the file that defines the API surface for scanning. Must be in the format specified by the `scanMode` argument.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "authPassword", + "description": "CI variable containing the password for authenticating with the target API.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "authUsername", + "description": "CI variable containing the username for authenticating with the target API.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scanMode", + "description": "The mode for API fuzzing scans.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ApiFuzzingScanMode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "scanProfile", + "description": "Name of a default profile to use for scanning. Ex: Quick-10.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "target", + "description": "URL for the target of API fuzzing scans.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "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": "ApiFuzzingCiConfigurationCreatePayload", + "description": "Autogenerated return type of ApiFuzzingCiConfigurationCreate", + "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": "configurationYaml", + "description": "A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Errors encountered during execution of the mutation.", + "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": "gitlabCiYamlEditPath", + "description": "The location at which the project's `.gitlab-ci.yml` file can be edited in the browser.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ApiFuzzingScanMode", + "description": "All possible ways to specify the API surface for an API fuzzing scan", "fields": null, "inputFields": null, "interfaces": null, + "enumValues": [ + { + "name": "HAR", + "description": "The API surface is specified by a HAR file.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPENAPI", + "description": "The API surface is specified by a OPENAPI file.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ApiFuzzingScanProfile", + "description": "An API Fuzzing scan profile.", + "fields": [ + { + "name": "description", + "description": "A short description of the profile.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The unique name of the profile.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "yaml", + "description": "A syntax highlit HTML representation of the YAML.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], "enumValues": null, "possibleTypes": null }, @@ -2645,7 +3031,7 @@ "fields": [ { "name": "description", - "description": "The emoji description", + "description": "The emoji description.", "args": [ ], @@ -2663,7 +3049,7 @@ }, { "name": "emoji", - "description": "The emoji as an icon", + "description": "The emoji as an icon.", "args": [ ], @@ -2681,7 +3067,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "args": [ ], @@ -2699,7 +3085,7 @@ }, { "name": "unicode", - "description": "The emoji in unicode", + "description": "The emoji in Unicode.", "args": [ ], @@ -2717,7 +3103,7 @@ }, { "name": "unicodeVersion", - "description": "The unicode version for this emoji", + "description": "The Unicode version for this emoji.", "args": [ ], @@ -2735,7 +3121,7 @@ }, { "name": "user", - "description": "The user who awarded the emoji", + "description": "The user who awarded the emoji.", "args": [ ], @@ -2781,7 +3167,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "type": { "kind": "NON_NULL", "name": null, @@ -2876,6 +3262,118 @@ "possibleTypes": null }, { + "kind": "OBJECT", + "name": "AwardEmojiConnection", + "description": "The connection type for AwardEmoji.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AwardEmojiEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AwardEmoji", + "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": "AwardEmojiEdge", + "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": "AwardEmoji", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "INPUT_OBJECT", "name": "AwardEmojiRemoveInput", "description": "Autogenerated input type of AwardEmojiRemove", @@ -2897,7 +3395,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "type": { "kind": "NON_NULL", "name": null, @@ -3013,7 +3511,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "type": { "kind": "NON_NULL", "name": null, @@ -3128,7 +3626,7 @@ { "kind": "SCALAR", "name": "AwardableID", - "description": "Identifier of Awardable", + "description": "Identifier of Awardable.", "fields": null, "inputFields": null, "interfaces": null, @@ -3142,7 +3640,7 @@ "fields": [ { "name": "active", - "description": "Indicates if the service is active", + "description": "Indicates if the service is active.", "args": [ ], @@ -3156,7 +3654,7 @@ }, { "name": "type", - "description": "Class name of the service", + "description": "Class name of the service.", "args": [ ], @@ -3197,7 +3695,7 @@ "fields": [ { "name": "flatPath", - "description": "Flat path of the entry", + "description": "Flat path of the entry.", "args": [ ], @@ -3215,7 +3713,7 @@ }, { "name": "id", - "description": "ID of the entry", + "description": "ID of the entry.", "args": [ ], @@ -3233,7 +3731,7 @@ }, { "name": "lfsOid", - "description": "LFS ID of the blob", + "description": "LFS ID of the blob.", "args": [ ], @@ -3247,7 +3745,7 @@ }, { "name": "mode", - "description": "Blob mode in numeric format", + "description": "Blob mode in numeric format.", "args": [ ], @@ -3261,7 +3759,7 @@ }, { "name": "name", - "description": "Name of the entry", + "description": "Name of the entry.", "args": [ ], @@ -3279,7 +3777,7 @@ }, { "name": "path", - "description": "Path of the entry", + "description": "Path of the entry.", "args": [ ], @@ -3297,7 +3795,7 @@ }, { "name": "sha", - "description": "Last commit sha for the entry", + "description": "Last commit SHA for the entry.", "args": [ ], @@ -3315,7 +3813,7 @@ }, { "name": "type", - "description": "Type of tree entry", + "description": "Type of tree entry.", "args": [ ], @@ -3333,7 +3831,7 @@ }, { "name": "webPath", - "description": "Web path of the blob", + "description": "Web path of the blob.", "args": [ ], @@ -3347,7 +3845,7 @@ }, { "name": "webUrl", - "description": "Web URL of the blob", + "description": "Web URL of the blob.", "args": [ ], @@ -3519,7 +4017,7 @@ "fields": [ { "name": "assignee", - "description": "The board assignee", + "description": "The board assignee.", "args": [ ], @@ -3533,7 +4031,7 @@ }, { "name": "epics", - "description": "Epics associated with board issues", + "description": "Epics associated with board issues.", "args": [ { "name": "issueFilters", @@ -3596,7 +4094,7 @@ }, { "name": "hideBacklogList", - "description": "Whether or not backlog list is hidden", + "description": "Whether or not backlog list is hidden.", "args": [ ], @@ -3610,7 +4108,7 @@ }, { "name": "hideClosedList", - "description": "Whether or not closed list is hidden", + "description": "Whether or not closed list is hidden.", "args": [ ], @@ -3624,7 +4122,7 @@ }, { "name": "id", - "description": "ID (global ID) of the board", + "description": "ID (global ID) of the board.", "args": [ ], @@ -3656,7 +4154,7 @@ }, { "name": "labels", - "description": "Labels of the board", + "description": "Labels of the board.", "args": [ { "name": "after", @@ -3709,7 +4207,7 @@ }, { "name": "lists", - "description": "Lists of the board", + "description": "Lists of the board.", "args": [ { "name": "id", @@ -3782,7 +4280,7 @@ }, { "name": "milestone", - "description": "The board milestone", + "description": "The board milestone.", "args": [ ], @@ -3796,7 +4294,7 @@ }, { "name": "name", - "description": "Name of the board", + "description": "Name of the board.", "args": [ ], @@ -3846,7 +4344,7 @@ }, { "name": "weight", - "description": "Weight of the board", + "description": "Weight of the board.", "args": [ ], @@ -3985,7 +4483,7 @@ "fields": [ { "name": "author", - "description": "Author of the epic", + "description": "Author of the epic.", "args": [ ], @@ -4002,8 +4500,61 @@ "deprecationReason": null }, { + "name": "awardEmoji", + "description": "A list of award emojis associated with the epic.", + "args": [ + { + "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": "AwardEmojiConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "children", - "description": "Children (sub-epics) of the epic", + "description": "Children (sub-epics) of the epic.", "args": [ { "name": "startDate", @@ -4212,7 +4763,7 @@ }, { "name": "closedAt", - "description": "Timestamp of when the epic was closed", + "description": "Timestamp of when the epic was closed.", "args": [ ], @@ -4226,7 +4777,7 @@ }, { "name": "confidential", - "description": "Indicates if the epic is confidential", + "description": "Indicates if the epic is confidential.", "args": [ ], @@ -4240,7 +4791,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the epic was created", + "description": "Timestamp of when the epic was created.", "args": [ ], @@ -4254,7 +4805,7 @@ }, { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -4298,7 +4849,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -4321,7 +4872,7 @@ }, { "name": "descendantCounts", - "description": "Number of open and closed descendant epics and issues", + "description": "Number of open and closed descendant epics and issues.", "args": [ ], @@ -4335,7 +4886,7 @@ }, { "name": "descendantWeightSum", - "description": "Total weight of open and closed issues in the epic and its descendants", + "description": "Total weight of open and closed issues in the epic and its descendants.", "args": [ ], @@ -4349,7 +4900,7 @@ }, { "name": "description", - "description": "Description of the epic", + "description": "Description of the epic.", "args": [ ], @@ -4363,7 +4914,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -4420,7 +4971,7 @@ }, { "name": "downvotes", - "description": "Number of downvotes the epic has received", + "description": "Number of downvotes the epic has received.", "args": [ ], @@ -4438,7 +4989,7 @@ }, { "name": "dueDate", - "description": "Due date of the epic", + "description": "Due date of the epic.", "args": [ ], @@ -4452,7 +5003,7 @@ }, { "name": "dueDateFixed", - "description": "Fixed due date of the epic", + "description": "Fixed due date of the epic.", "args": [ ], @@ -4466,7 +5017,7 @@ }, { "name": "dueDateFromMilestones", - "description": "Inherited due date of the epic from milestones", + "description": "Inherited due date of the epic from milestones.", "args": [ ], @@ -4480,7 +5031,7 @@ }, { "name": "dueDateIsFixed", - "description": "Indicates if the due date has been manually set", + "description": "Indicates if the due date has been manually set.", "args": [ ], @@ -4493,8 +5044,61 @@ "deprecationReason": null }, { + "name": "events", + "description": "A list of events associated with the object.", + "args": [ + { + "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": "EventConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "group", - "description": "Group to which the epic belongs", + "description": "Group to which the epic belongs.", "args": [ ], @@ -4512,7 +5116,7 @@ }, { "name": "hasChildren", - "description": "Indicates if the epic has children", + "description": "Indicates if the epic has children.", "args": [ ], @@ -4530,7 +5134,7 @@ }, { "name": "hasIssues", - "description": "Indicates if the epic has direct issues", + "description": "Indicates if the epic has direct issues.", "args": [ ], @@ -4548,7 +5152,7 @@ }, { "name": "hasParent", - "description": "Indicates if the epic has a parent epic", + "description": "Indicates if the epic has a parent epic.", "args": [ ], @@ -4566,7 +5170,7 @@ }, { "name": "healthStatus", - "description": "Current health status of the epic", + "description": "Current health status of the epic.", "args": [ ], @@ -4580,7 +5184,7 @@ }, { "name": "id", - "description": "ID of the epic", + "description": "ID of the epic.", "args": [ ], @@ -4598,7 +5202,7 @@ }, { "name": "iid", - "description": "Internal ID of the epic", + "description": "Internal ID of the epic.", "args": [ ], @@ -4616,7 +5220,7 @@ }, { "name": "issues", - "description": "A list of issues associated with the epic", + "description": "A list of issues associated with the epic.", "args": [ { "name": "after", @@ -4669,7 +5273,7 @@ }, { "name": "labels", - "description": "Labels assigned to the epic", + "description": "Labels assigned to the epic.", "args": [ { "name": "after", @@ -4722,7 +5326,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -4779,7 +5383,7 @@ }, { "name": "parent", - "description": "Parent epic of the epic", + "description": "Parent epic of the epic.", "args": [ ], @@ -4793,7 +5397,7 @@ }, { "name": "participants", - "description": "List of participants for the epic", + "description": "List of participants for the epic.", "args": [ { "name": "after", @@ -4846,11 +5450,11 @@ }, { "name": "reference", - "description": "Internal reference of the epic. Returned in shortened format by default", + "description": "Internal reference of the epic. Returned in shortened format by default.", "args": [ { "name": "full", - "description": "Indicates if the reference should be returned in full", + "description": "Indicates if the reference should be returned in full.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -4873,7 +5477,7 @@ }, { "name": "relationPath", - "description": "URI path of the epic-issue relationship", + "description": "URI path of the epic-issue relationship.", "args": [ ], @@ -4887,7 +5491,7 @@ }, { "name": "relativePosition", - "description": "The relative position of the epic in the epic tree", + "description": "The relative position of the epic in the epic tree.", "args": [ ], @@ -4901,7 +5505,7 @@ }, { "name": "startDate", - "description": "Start date of the epic", + "description": "Start date of the epic.", "args": [ ], @@ -4915,7 +5519,7 @@ }, { "name": "startDateFixed", - "description": "Fixed start date of the epic", + "description": "Fixed start date of the epic.", "args": [ ], @@ -4929,7 +5533,7 @@ }, { "name": "startDateFromMilestones", - "description": "Inherited start date of the epic from milestones", + "description": "Inherited start date of the epic from milestones.", "args": [ ], @@ -4943,7 +5547,7 @@ }, { "name": "startDateIsFixed", - "description": "Indicates if the start date has been manually set", + "description": "Indicates if the start date has been manually set.", "args": [ ], @@ -4957,7 +5561,7 @@ }, { "name": "state", - "description": "State of the epic", + "description": "State of the epic.", "args": [ ], @@ -4975,7 +5579,7 @@ }, { "name": "subscribed", - "description": "Indicates the currently logged in user is subscribed to the epic", + "description": "Indicates the currently logged in user is subscribed to the epic.", "args": [ ], @@ -4993,7 +5597,7 @@ }, { "name": "title", - "description": "Title of the epic", + "description": "Title of the epic.", "args": [ ], @@ -5007,7 +5611,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the epic was updated", + "description": "Timestamp of when the epic was updated.", "args": [ ], @@ -5021,7 +5625,7 @@ }, { "name": "upvotes", - "description": "Number of upvotes the epic has received", + "description": "Number of upvotes the epic has received.", "args": [ ], @@ -5039,7 +5643,7 @@ }, { "name": "userDiscussionsCount", - "description": "Number of user discussions in the epic", + "description": "Number of user discussions in the epic.", "args": [ ], @@ -5057,7 +5661,7 @@ }, { "name": "userNotesCount", - "description": "Number of user notes of the epic", + "description": "Number of user notes of the epic.", "args": [ ], @@ -5093,7 +5697,7 @@ }, { "name": "userPreferences", - "description": "User preferences for the epic on the issue board", + "description": "User preferences for the epic on the issue board.", "args": [ ], @@ -5107,7 +5711,7 @@ }, { "name": "webPath", - "description": "Web path of the epic", + "description": "Web path of the epic.", "args": [ ], @@ -5125,7 +5729,7 @@ }, { "name": "webUrl", - "description": "Web URL of the epic", + "description": "Web URL of the epic.", "args": [ ], @@ -5153,6 +5757,11 @@ "kind": "INTERFACE", "name": "CurrentUserTodos", "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Eventable", + "ofType": null } ], "enumValues": null, @@ -5277,7 +5886,7 @@ "fields": [ { "name": "collapsed", - "description": "Indicates epic should be displayed as collapsed", + "description": "Indicates epic should be displayed as collapsed.", "args": [ ], @@ -5304,7 +5913,7 @@ { "kind": "SCALAR", "name": "BoardID", - "description": "Identifier of Board", + "description": "Identifier of Board.", "fields": null, "inputFields": null, "interfaces": null, @@ -5319,7 +5928,7 @@ "inputFields": [ { "name": "labelName", - "description": "Filter by label name", + "description": "Filter by label name.", "type": { "kind": "LIST", "name": null, @@ -5333,7 +5942,7 @@ }, { "name": "milestoneTitle", - "description": "Filter by milestone title", + "description": "Filter by milestone title.", "type": { "kind": "SCALAR", "name": "String", @@ -5343,7 +5952,7 @@ }, { "name": "assigneeUsername", - "description": "Filter by assignee username", + "description": "Filter by assignee username.", "type": { "kind": "LIST", "name": null, @@ -5357,7 +5966,7 @@ }, { "name": "authorUsername", - "description": "Filter by author username", + "description": "Filter by author username.", "type": { "kind": "SCALAR", "name": "String", @@ -5367,7 +5976,7 @@ }, { "name": "releaseTag", - "description": "Filter by release tag", + "description": "Filter by release tag.", "type": { "kind": "SCALAR", "name": "String", @@ -5377,7 +5986,7 @@ }, { "name": "myReactionEmoji", - "description": "Filter by reaction emoji", + "description": "Filter by reaction emoji.", "type": { "kind": "SCALAR", "name": "String", @@ -5387,7 +5996,7 @@ }, { "name": "epicId", - "description": "Filter by epic ID. Incompatible with epicWildcardId", + "description": "Filter by epic ID. Incompatible with epicWildcardId.", "type": { "kind": "SCALAR", "name": "EpicID", @@ -5397,7 +6006,7 @@ }, { "name": "iterationTitle", - "description": "Filter by iteration title", + "description": "Filter by iteration title.", "type": { "kind": "SCALAR", "name": "String", @@ -5407,7 +6016,7 @@ }, { "name": "weight", - "description": "Filter by weight", + "description": "Filter by weight.", "type": { "kind": "SCALAR", "name": "String", @@ -5417,7 +6026,7 @@ }, { "name": "not", - "description": "List of negated params. Warning: this argument is experimental and a subject to change in future", + "description": "List of negated params. Warning: this argument is experimental and a subject to change in future.", "type": { "kind": "INPUT_OBJECT", "name": "NegatedBoardIssueInput", @@ -5427,7 +6036,7 @@ }, { "name": "search", - "description": "Search query for issue title or description", + "description": "Search query for issue title or description.", "type": { "kind": "SCALAR", "name": "String", @@ -5437,7 +6046,7 @@ }, { "name": "epicWildcardId", - "description": "Filter by epic ID wildcard. Incompatible with epicId", + "description": "Filter by epic ID wildcard. Incompatible with epicId.", "type": { "kind": "ENUM", "name": "EpicWildcardId", @@ -5447,7 +6056,7 @@ }, { "name": "iterationWildcardId", - "description": "Filter by iteration ID wildcard", + "description": "Filter by iteration ID wildcard.", "type": { "kind": "ENUM", "name": "IterationWildcardId", @@ -5467,7 +6076,7 @@ "fields": [ { "name": "assignee", - "description": "Assignee in the list", + "description": "Assignee in the list.", "args": [ ], @@ -5481,7 +6090,7 @@ }, { "name": "collapsed", - "description": "Indicates if list is collapsed for this user", + "description": "Indicates if list is collapsed for this user.", "args": [ ], @@ -5495,7 +6104,7 @@ }, { "name": "id", - "description": "ID (global ID) of the list", + "description": "ID (global ID) of the list.", "args": [ ], @@ -5513,7 +6122,7 @@ }, { "name": "issues", - "description": "Board issues", + "description": "Board issues.", "args": [ { "name": "filters", @@ -5576,7 +6185,7 @@ }, { "name": "issuesCount", - "description": "Count of issues in the list", + "description": "Count of issues in the list.", "args": [ ], @@ -5590,7 +6199,7 @@ }, { "name": "iteration", - "description": "Iteration of the list", + "description": "Iteration of the list.", "args": [ ], @@ -5604,7 +6213,7 @@ }, { "name": "label", - "description": "Label of the list", + "description": "Label of the list.", "args": [ ], @@ -5618,7 +6227,7 @@ }, { "name": "limitMetric", - "description": "The current limit metric for the list", + "description": "The current limit metric for the list.", "args": [ ], @@ -5632,7 +6241,7 @@ }, { "name": "listType", - "description": "Type of the list", + "description": "Type of the list.", "args": [ ], @@ -5650,7 +6259,7 @@ }, { "name": "maxIssueCount", - "description": "Maximum number of issues in the list", + "description": "Maximum number of issues in the list.", "args": [ ], @@ -5664,7 +6273,7 @@ }, { "name": "maxIssueWeight", - "description": "Maximum weight of issues in the list", + "description": "Maximum weight of issues in the list.", "args": [ ], @@ -5678,7 +6287,7 @@ }, { "name": "milestone", - "description": "Milestone of the list", + "description": "Milestone of the list.", "args": [ ], @@ -5692,7 +6301,7 @@ }, { "name": "position", - "description": "Position of list within the board", + "description": "Position of list within the board.", "args": [ ], @@ -5706,7 +6315,7 @@ }, { "name": "title", - "description": "Title of the list", + "description": "Title of the list.", "args": [ ], @@ -5724,7 +6333,7 @@ }, { "name": "totalWeight", - "description": "Total weight of all issues in the list", + "description": "Total weight of all issues in the list.", "args": [ ], @@ -5818,20 +6427,6 @@ "fields": null, "inputFields": [ { - "name": "boardId", - "description": "Global ID of the issue board to mutate.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "BoardID", - "ofType": null - } - }, - "defaultValue": null - }, - { "name": "backlog", "description": "Create the backlog list.", "type": { @@ -5852,6 +6447,20 @@ "defaultValue": null }, { + "name": "boardId", + "description": "Global ID of the issue board to mutate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "BoardID", + "ofType": null + } + }, + "defaultValue": null + }, + { "name": "milestoneId", "description": "Global ID of an existing milestone.", "type": { @@ -5943,7 +6552,7 @@ }, { "name": "list", - "description": "List of the issue board.", + "description": "Issue list in the issue board.", "args": [ ], @@ -6143,7 +6752,7 @@ { "kind": "SCALAR", "name": "BoardsEpicBoardID", - "description": "Identifier of Boards::EpicBoard", + "description": "Identifier of Boards::EpicBoard.", "fields": null, "inputFields": null, "interfaces": null, @@ -6153,7 +6762,7 @@ { "kind": "SCALAR", "name": "BoardsEpicListID", - "description": "Identifier of Boards::EpicList", + "description": "Identifier of Boards::EpicList.", "fields": null, "inputFields": null, "interfaces": null, @@ -6177,7 +6786,7 @@ "fields": [ { "name": "commit", - "description": "Commit for the branch", + "description": "Commit for the branch.", "args": [ ], @@ -6191,7 +6800,7 @@ }, { "name": "name", - "description": "Name of the branch", + "description": "Name of the branch.", "args": [ ], @@ -6222,7 +6831,7 @@ "fields": [ { "name": "completedCount", - "description": "Number of closed issues as of this day", + "description": "Number of closed issues as of this day.", "args": [ ], @@ -6240,7 +6849,7 @@ }, { "name": "completedWeight", - "description": "Total weight of closed issues as of this day", + "description": "Total weight of closed issues as of this day.", "args": [ ], @@ -6258,7 +6867,7 @@ }, { "name": "date", - "description": "Date for burnup totals", + "description": "Date for burnup totals.", "args": [ ], @@ -6276,7 +6885,7 @@ }, { "name": "scopeCount", - "description": "Number of issues as of this day", + "description": "Number of issues as of this day.", "args": [ ], @@ -6294,7 +6903,7 @@ }, { "name": "scopeWeight", - "description": "Total weight of issues as of this day", + "description": "Total weight of issues as of this day.", "args": [ ], @@ -6320,6 +6929,33 @@ }, { "kind": "OBJECT", + "name": "CiApplicationSettings", + "description": null, + "fields": [ + { + "name": "keepLatestArtifact", + "description": "Whether to keep the latest jobs artifacts.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "CiBuildNeed", "description": null, "fields": [ @@ -6562,7 +7198,7 @@ "fields": [ { "name": "errors", - "description": "Linting errors", + "description": "Linting errors.", "args": [ ], @@ -6584,7 +7220,7 @@ }, { "name": "mergedYaml", - "description": "Merged CI config YAML", + "description": "Merged CI configuration YAML.", "args": [ ], @@ -6598,7 +7234,7 @@ }, { "name": "stages", - "description": "Stages of the pipeline", + "description": "Stages of the pipeline.", "args": [ { "name": "after", @@ -6651,7 +7287,7 @@ }, { "name": "status", - "description": "Status of linting, can be either valid or invalid", + "description": "Status of linting, can be either valid or invalid.", "args": [ ], @@ -6678,7 +7314,7 @@ "fields": [ { "name": "jobs", - "description": "Jobs in group", + "description": "Jobs in group.", "args": [ { "name": "after", @@ -6731,7 +7367,7 @@ }, { "name": "name", - "description": "Name of the job group", + "description": "Name of the job group.", "args": [ ], @@ -6745,7 +7381,7 @@ }, { "name": "size", - "description": "Size of the job group", + "description": "Size of the job group.", "args": [ ], @@ -7297,7 +7933,7 @@ "fields": [ { "name": "name", - "description": "Name of the need", + "description": "Name of the need.", "args": [ ], @@ -7436,7 +8072,7 @@ "fields": [ { "name": "groups", - "description": "Groups of jobs for the stage", + "description": "Groups of jobs for the stage.", "args": [ { "name": "after", @@ -7489,7 +8125,7 @@ }, { "name": "name", - "description": "Name of the stage", + "description": "Name of the stage.", "args": [ ], @@ -7651,7 +8287,7 @@ "fields": [ { "name": "detailedStatus", - "description": "Detailed status of the group", + "description": "Detailed status of the group.", "args": [ ], @@ -7665,7 +8301,7 @@ }, { "name": "jobs", - "description": "Jobs in group", + "description": "Jobs in group.", "args": [ { "name": "after", @@ -7718,7 +8354,7 @@ }, { "name": "name", - "description": "Name of the job group", + "description": "Name of the job group.", "args": [ ], @@ -7732,7 +8368,7 @@ }, { "name": "size", - "description": "Size of the group", + "description": "Size of the group.", "args": [ ], @@ -7871,7 +8507,7 @@ "fields": [ { "name": "artifacts", - "description": "Artifacts generated by the job", + "description": "Artifacts generated by the job.", "args": [ { "name": "after", @@ -7924,7 +8560,7 @@ }, { "name": "detailedStatus", - "description": "Detailed status of the job", + "description": "Detailed status of the job.", "args": [ ], @@ -7938,7 +8574,7 @@ }, { "name": "name", - "description": "Name of the job", + "description": "Name of the job.", "args": [ ], @@ -7952,7 +8588,7 @@ }, { "name": "needs", - "description": "References to builds that must complete before the jobs run", + "description": "References to builds that must complete before the jobs run.", "args": [ { "name": "after", @@ -8005,7 +8641,7 @@ }, { "name": "pipeline", - "description": "Pipeline the job belongs to", + "description": "Pipeline the job belongs to.", "args": [ ], @@ -8019,7 +8655,7 @@ }, { "name": "scheduledAt", - "description": "Schedule for the build", + "description": "Schedule for the build.", "args": [ ], @@ -8046,7 +8682,7 @@ "fields": [ { "name": "downloadPath", - "description": "URL for downloading the artifact's file", + "description": "URL for downloading the artifact's file.", "args": [ ], @@ -8060,7 +8696,7 @@ }, { "name": "fileType", - "description": "File type of the artifact", + "description": "File type of the artifact.", "args": [ ], @@ -8307,7 +8943,7 @@ { "kind": "SCALAR", "name": "CiPipelineID", - "description": "Identifier of Ci::Pipeline", + "description": "Identifier of Ci::Pipeline.", "fields": null, "inputFields": null, "interfaces": null, @@ -8321,7 +8957,7 @@ "fields": [ { "name": "detailedStatus", - "description": "Detailed status of the stage", + "description": "Detailed status of the stage.", "args": [ ], @@ -8335,7 +8971,7 @@ }, { "name": "groups", - "description": "Group of jobs for the stage", + "description": "Group of jobs for the stage.", "args": [ { "name": "after", @@ -8388,7 +9024,7 @@ }, { "name": "name", - "description": "Name of the stage", + "description": "Name of the stage.", "args": [ ], @@ -8527,7 +9163,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp the cluster agent was created", + "description": "Timestamp the cluster agent was created.", "args": [ ], @@ -8540,8 +9176,22 @@ "deprecationReason": null }, { + "name": "createdByUser", + "description": "User object, containing information about the person who created the agent.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "User", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "id", - "description": "ID of the cluster agent", + "description": "ID of the cluster agent.", "args": [ ], @@ -8559,7 +9209,7 @@ }, { "name": "name", - "description": "Name of the cluster agent", + "description": "Name of the cluster agent.", "args": [ ], @@ -8573,7 +9223,7 @@ }, { "name": "project", - "description": "The project this cluster agent is associated with", + "description": "The project this cluster agent is associated with.", "args": [ ], @@ -8587,7 +9237,7 @@ }, { "name": "tokens", - "description": "Tokens associated with the cluster agent", + "description": "Tokens associated with the cluster agent.", "args": [ { "name": "after", @@ -8640,7 +9290,7 @@ }, { "name": "updatedAt", - "description": "Timestamp the cluster agent was updated", + "description": "Timestamp the cluster agent was updated.", "args": [ ], @@ -8667,7 +9317,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -8885,7 +9535,7 @@ "fields": [ { "name": "clusterAgent", - "description": "Cluster agent this token is associated with", + "description": "Cluster agent this token is associated with.", "args": [ ], @@ -8899,7 +9549,7 @@ }, { "name": "createdAt", - "description": "Timestamp the token was created", + "description": "Timestamp the token was created.", "args": [ ], @@ -8912,8 +9562,22 @@ "deprecationReason": null }, { + "name": "createdByUser", + "description": "The user who created the token.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "User", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "id", - "description": "Global ID of the token", + "description": "Global ID of the token.", "args": [ ], @@ -8944,7 +9608,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -9274,7 +9938,7 @@ { "kind": "SCALAR", "name": "ClustersAgentID", - "description": "Identifier of Clusters::Agent", + "description": "Identifier of Clusters::Agent.", "fields": null, "inputFields": null, "interfaces": null, @@ -9284,7 +9948,7 @@ { "kind": "SCALAR", "name": "ClustersAgentTokenID", - "description": "Identifier of Clusters::AgentToken", + "description": "Identifier of Clusters::AgentToken.", "fields": null, "inputFields": null, "interfaces": null, @@ -9294,7 +9958,7 @@ { "kind": "SCALAR", "name": "ClustersClusterID", - "description": "Identifier of Clusters::Cluster", + "description": "Identifier of Clusters::Cluster.", "fields": null, "inputFields": null, "interfaces": null, @@ -9548,7 +10212,7 @@ "fields": [ { "name": "author", - "description": "Author of the commit", + "description": "Author of the commit.", "args": [ ], @@ -9562,7 +10226,7 @@ }, { "name": "authorGravatar", - "description": "Commit authors gravatar", + "description": "Commit authors gravatar.", "args": [ ], @@ -9576,7 +10240,7 @@ }, { "name": "authorName", - "description": "Commit authors name", + "description": "Commit authors name.", "args": [ ], @@ -9590,7 +10254,7 @@ }, { "name": "authoredDate", - "description": "Timestamp of when the commit was authored", + "description": "Timestamp of when the commit was authored.", "args": [ ], @@ -9604,7 +10268,7 @@ }, { "name": "description", - "description": "Description of the commit message", + "description": "Description of the commit message.", "args": [ ], @@ -9632,7 +10296,7 @@ }, { "name": "id", - "description": "ID (global ID) of the commit", + "description": "ID (global ID) of the commit.", "args": [ ], @@ -9650,7 +10314,7 @@ }, { "name": "message", - "description": "Raw commit message", + "description": "Raw commit message.", "args": [ ], @@ -9664,7 +10328,7 @@ }, { "name": "pipelines", - "description": "Pipelines of the commit ordered latest first", + "description": "Pipelines of the commit ordered latest first.", "args": [ { "name": "status", @@ -9747,7 +10411,7 @@ }, { "name": "sha", - "description": "SHA1 ID of the commit", + "description": "SHA1 ID of the commit.", "args": [ ], @@ -9765,7 +10429,7 @@ }, { "name": "shortId", - "description": "Short SHA1 ID of the commit", + "description": "Short SHA1 ID of the commit.", "args": [ ], @@ -9783,7 +10447,7 @@ }, { "name": "signatureHtml", - "description": "Rendered HTML of the commit signature", + "description": "Rendered HTML of the commit signature.", "args": [ ], @@ -9797,7 +10461,7 @@ }, { "name": "title", - "description": "Title of the commit message", + "description": "Title of the commit message.", "args": [ ], @@ -9825,7 +10489,7 @@ }, { "name": "webPath", - "description": "Web path of the commit", + "description": "Web path of the commit.", "args": [ ], @@ -9843,7 +10507,7 @@ }, { "name": "webUrl", - "description": "Web URL of the commit", + "description": "Web URL of the commit.", "args": [ ], @@ -9875,7 +10539,7 @@ "inputFields": [ { "name": "action", - "description": "The action to perform, create, delete, move, update, chmod", + "description": "The action to perform, create, delete, move, update, chmod.", "type": { "kind": "NON_NULL", "name": null, @@ -9889,7 +10553,7 @@ }, { "name": "filePath", - "description": "Full path to the file", + "description": "Full path to the file.", "type": { "kind": "NON_NULL", "name": null, @@ -9903,7 +10567,7 @@ }, { "name": "content", - "description": "Content of the file", + "description": "Content of the file.", "type": { "kind": "SCALAR", "name": "String", @@ -9913,7 +10577,7 @@ }, { "name": "previousPath", - "description": "Original full path to the file being moved", + "description": "Original full path to the file being moved.", "type": { "kind": "SCALAR", "name": "String", @@ -9923,7 +10587,7 @@ }, { "name": "lastCommitId", - "description": "Last known file commit ID", + "description": "Last known file commit ID.", "type": { "kind": "SCALAR", "name": "String", @@ -9933,7 +10597,7 @@ }, { "name": "executeFilemode", - "description": "Enables/disables the execute flag on the file", + "description": "Enables/disables the execute flag on the file.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -9943,7 +10607,7 @@ }, { "name": "encoding", - "description": "Encoding of the file. Default is text", + "description": "Encoding of the file. Default is text.", "type": { "kind": "ENUM", "name": "CommitEncoding", @@ -10110,7 +10774,7 @@ }, { "name": "message", - "description": "Raw commit message", + "description": "Raw commit message.", "type": { "kind": "NON_NULL", "name": null, @@ -10301,7 +10965,7 @@ "fields": [ { "name": "color", - "description": "Hexadecimal representation of compliance framework's label color", + "description": "Hexadecimal representation of compliance framework's label color.", "args": [ ], @@ -10319,7 +10983,7 @@ }, { "name": "description", - "description": "Description of the compliance framework", + "description": "Description of the compliance framework.", "args": [ ], @@ -10337,7 +11001,7 @@ }, { "name": "id", - "description": "Compliance framework ID", + "description": "Compliance framework ID.", "args": [ ], @@ -10355,7 +11019,7 @@ }, { "name": "name", - "description": "Name of the compliance framework", + "description": "Name of the compliance framework.", "args": [ ], @@ -10370,6 +11034,20 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "pipelineConfigurationFullPath", + "description": "Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -10526,6 +11204,16 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "pipelineConfigurationFullPath", + "description": "Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -10535,7 +11223,7 @@ { "kind": "SCALAR", "name": "ComplianceManagementFrameworkID", - "description": "Identifier of ComplianceManagement::Framework", + "description": "Identifier of ComplianceManagement::Framework.", "fields": null, "inputFields": null, "interfaces": null, @@ -10543,6 +11231,55 @@ "possibleTypes": null }, { + "kind": "OBJECT", + "name": "ComposerMetadata", + "description": "Composer metadata", + "fields": [ + { + "name": "composerJson", + "description": "Data of the Composer JSON file.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PackageComposerJsonType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSha", + "description": "Target SHA of the package.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "INPUT_OBJECT", "name": "ConfigureSastInput", "description": "Autogenerated input type of ConfigureSast", @@ -10683,7 +11420,7 @@ "fields": [ { "name": "cadence", - "description": "This container expiration policy schedule", + "description": "This container expiration policy schedule.", "args": [ ], @@ -10701,7 +11438,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the container expiration policy was created", + "description": "Timestamp of when the container expiration policy was created.", "args": [ ], @@ -10719,7 +11456,7 @@ }, { "name": "enabled", - "description": "Indicates whether this container expiration policy is enabled", + "description": "Indicates whether this container expiration policy is enabled.", "args": [ ], @@ -10737,7 +11474,7 @@ }, { "name": "keepN", - "description": "Number of tags to retain", + "description": "Number of tags to retain.", "args": [ ], @@ -10751,7 +11488,7 @@ }, { "name": "nameRegex", - "description": "Tags with names matching this regex pattern will expire", + "description": "Tags with names matching this regex pattern will expire.", "args": [ ], @@ -10765,7 +11502,7 @@ }, { "name": "nameRegexKeep", - "description": "Tags with names matching this regex pattern will be preserved", + "description": "Tags with names matching this regex pattern will be preserved.", "args": [ ], @@ -10779,7 +11516,7 @@ }, { "name": "nextRunAt", - "description": "Next time that this container expiration policy will get executed", + "description": "Next time that this container expiration policy will get executed.", "args": [ ], @@ -10793,7 +11530,7 @@ }, { "name": "olderThan", - "description": "Tags older that this will expire", + "description": "Tags older that this will expire.", "args": [ ], @@ -10807,7 +11544,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the container expiration policy was updated", + "description": "Timestamp of when the container expiration policy was updated.", "args": [ ], @@ -11097,7 +11834,7 @@ }, { "name": "project", - "description": "Project of the container registry", + "description": "Project of the container registry.", "args": [ ], @@ -11416,7 +12153,7 @@ }, { "name": "project", - "description": "Project of the container registry", + "description": "Project of the container registry.", "args": [ ], @@ -11448,7 +12185,7 @@ }, { "name": "tags", - "description": "Tags of the container repository", + "description": "Tags of the container repository.", "args": [ { "name": "after", @@ -11591,7 +12328,7 @@ { "kind": "SCALAR", "name": "ContainerRepositoryID", - "description": "Identifier of ContainerRepository", + "description": "Identifier of ContainerRepository.", "fields": null, "inputFields": null, "interfaces": null, @@ -11600,6 +12337,77 @@ }, { "kind": "ENUM", + "name": "ContainerRepositorySort", + "description": "Values for sorting container repositories", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "updated_desc", + "description": "Updated at descending order", + "isDeprecated": true, + "deprecationReason": "Use UPDATED_DESC. Deprecated in 13.5." + }, + { + "name": "updated_asc", + "description": "Updated at ascending order", + "isDeprecated": true, + "deprecationReason": "Use UPDATED_ASC. Deprecated in 13.5." + }, + { + "name": "created_desc", + "description": "Created at descending order", + "isDeprecated": true, + "deprecationReason": "Use CREATED_DESC. Deprecated in 13.5." + }, + { + "name": "created_asc", + "description": "Created at ascending order", + "isDeprecated": true, + "deprecationReason": "Use CREATED_ASC. Deprecated in 13.5." + }, + { + "name": "UPDATED_DESC", + "description": "Updated at descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_ASC", + "description": "Updated at ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_DESC", + "description": "Created at descending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_ASC", + "description": "Created at ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME_ASC", + "description": "Name by ascending order", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME_DESC", + "description": "Name by descending order", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", "name": "ContainerRepositoryStatus", "description": "Status of a container repository", "fields": null, @@ -12012,7 +12820,7 @@ }, { "name": "todo", - "description": "The todo after mutation.", + "description": "The to-do item after mutation.", "args": [ ], @@ -12200,7 +13008,7 @@ "inputFields": [ { "name": "projectPath", - "description": "The project full path the resource is associated with.", + "description": "Full path of the project with which the resource is associated.", "type": { "kind": "SCALAR", "name": "ID", @@ -12210,7 +13018,7 @@ }, { "name": "groupPath", - "description": "The group full path the resource is associated with.", + "description": "Full path of the group with which the resource is associated.", "type": { "kind": "SCALAR", "name": "ID", @@ -12230,7 +13038,7 @@ }, { "name": "hideBacklogList", - "description": "Whether or not backlog list is hidden", + "description": "Whether or not backlog list is hidden.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -12240,7 +13048,7 @@ }, { "name": "hideClosedList", - "description": "Whether or not closed list is hidden", + "description": "Whether or not closed list is hidden.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -12290,7 +13098,7 @@ }, { "name": "labels", - "description": "Labels of the issue", + "description": "Labels of the issue.", "type": { "kind": "LIST", "name": null, @@ -12905,38 +13713,20 @@ "fields": null, "inputFields": [ { - "name": "name", - "description": "Name of the segment.", + "name": "namespaceId", + "description": "Namespace ID to set for the segment.", "type": { "kind": "NON_NULL", "name": null, "ofType": { "kind": "SCALAR", - "name": "String", + "name": "NamespaceID", "ofType": null } }, "defaultValue": null }, { - "name": "groupIds", - "description": "The array of group IDs to set for the segment.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "GroupID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "type": { @@ -13040,7 +13830,7 @@ }, { "name": "body", - "description": "Content of the note", + "description": "Content of the note.", "type": { "kind": "NON_NULL", "name": null, @@ -13064,7 +13854,7 @@ }, { "name": "position", - "description": "The position of this note on a diff", + "description": "The position of this note on a diff.", "type": { "kind": "NON_NULL", "name": null, @@ -13388,7 +14178,7 @@ }, { "name": "body", - "description": "Content of the note", + "description": "Content of the note.", "type": { "kind": "NON_NULL", "name": null, @@ -13412,7 +14202,7 @@ }, { "name": "position", - "description": "The position of this note on a diff", + "description": "The position of this note on a diff.", "type": { "kind": "NON_NULL", "name": null, @@ -13514,7 +14304,7 @@ "inputFields": [ { "name": "description", - "description": "Description of the issue", + "description": "Description of the issue.", "type": { "kind": "SCALAR", "name": "String", @@ -13524,7 +14314,7 @@ }, { "name": "dueDate", - "description": "Due date of the issue", + "description": "Due date of the issue.", "type": { "kind": "SCALAR", "name": "ISO8601Date", @@ -13534,7 +14324,7 @@ }, { "name": "confidential", - "description": "Indicates the issue is confidential", + "description": "Indicates the issue is confidential.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -13544,7 +14334,7 @@ }, { "name": "locked", - "description": "Indicates discussion is locked on the issue", + "description": "Indicates discussion is locked on the issue.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -13578,7 +14368,7 @@ }, { "name": "title", - "description": "Title of the issue", + "description": "Title of the issue.", "type": { "kind": "NON_NULL", "name": null, @@ -13602,7 +14392,7 @@ }, { "name": "labels", - "description": "Labels of the issue", + "description": "Labels of the issue.", "type": { "kind": "LIST", "name": null, @@ -13803,8 +14593,8 @@ "fields": null, "inputFields": [ { - "name": "groupPath", - "description": "The target group for the iteration.", + "name": "projectPath", + "description": "Full path of the project with which the resource is associated.", "type": { "kind": "SCALAR", "name": "ID", @@ -13813,8 +14603,8 @@ "defaultValue": null }, { - "name": "projectPath", - "description": "The target project for the iteration.", + "name": "groupPath", + "description": "Full path of the group with which the resource is associated.", "type": { "kind": "SCALAR", "name": "ID", @@ -13966,7 +14756,7 @@ }, { "name": "body", - "description": "Content of the note", + "description": "Content of the note.", "type": { "kind": "NON_NULL", "name": null, @@ -14209,6 +14999,26 @@ "fields": null, "inputFields": [ { + "name": "captchaResponse", + "description": "A valid CAPTCHA response value obtained by using the provided captchaSiteKey with a CAPTCHA API to present a challenge to be solved on the client. Required to resubmit if the previous operation returned \"NeedsCaptchaResponse: true\".", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "spamLogId", + "description": "The spam log ID which must be passed along with a valid CAPTCHA response for the operation to be completed. Required to resubmit if the previous operation returned \"NeedsCaptchaResponse: true\".", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { "name": "title", "description": "Title of the snippet.", "type": { @@ -14313,6 +15123,20 @@ "description": "Autogenerated return type of CreateSnippet", "fields": [ { + "name": "captchaSiteKey", + "description": "The CAPTCHA site key which must be used to render a challenge for the user to solve to obtain a valid captchaResponse value. Included only when an operation was not completed because \"NeedsCaptchaResponse\" is true.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "args": [ @@ -14353,6 +15177,20 @@ "deprecationReason": null }, { + "name": "needsCaptchaResponse", + "description": "Indicates whether the operation was detected as possible spam and not completed. If CAPTCHA is enabled, the request must be resubmitted with a valid CAPTCHA response and spam_log_id included for the operation to be completed. Included only when an operation was not completed because \"NeedsCaptchaResponse\" is true.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "snippet", "description": "The snippet after mutation.", "args": [ @@ -14368,7 +15206,7 @@ }, { "name": "spam", - "description": "Indicates whether the operation returns a record detected as spam.", + "description": "Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response.", "args": [ ], @@ -14379,6 +15217,20 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "spamLogId", + "description": "The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because \"NeedsCaptchaResponse\" is true.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -14539,7 +15391,7 @@ "fields": [ { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -14583,7 +15435,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -14648,7 +15500,7 @@ "fields": [ { "name": "external", - "description": "Whether the emoji is an external link", + "description": "Whether the emoji is an external link.", "args": [ ], @@ -14666,7 +15518,7 @@ }, { "name": "id", - "description": "The ID of the emoji", + "description": "The ID of the emoji.", "args": [ ], @@ -14684,7 +15536,7 @@ }, { "name": "name", - "description": "The name of the emoji", + "description": "The name of the emoji.", "args": [ ], @@ -14702,7 +15554,7 @@ }, { "name": "url", - "description": "The link to file of the emoji", + "description": "The link to file of the emoji.", "args": [ ], @@ -14841,7 +15693,7 @@ { "kind": "SCALAR", "name": "CustomEmojiID", - "description": "Identifier of CustomEmoji", + "description": "Identifier of CustomEmoji.", "fields": null, "inputFields": null, "interfaces": null, @@ -14975,6 +15827,791 @@ "possibleTypes": null }, { + "kind": "OBJECT", + "name": "DastProfile", + "description": "Represents a DAST Profile", + "fields": [ + { + "name": "dastScannerProfile", + "description": "The associated scanner profile.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "DastScannerProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dastSiteProfile", + "description": "The associated site profile.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "DastSiteProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the scan.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "editPath", + "description": "Relative web path to the edit page of a profile.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "ID of the profile.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastProfileID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the profile.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DastProfileConnection", + "description": "The connection type for DastProfile.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DastProfileEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DastProfile", + "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": "INPUT_OBJECT", + "name": "DastProfileCreateInput", + "description": "Autogenerated input type of DastProfileCreate", + "fields": null, + "inputFields": [ + { + "name": "fullPath", + "description": "The project the profile belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description of the profile. Defaults to an empty string.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\"\"" + }, + { + "name": "dastSiteProfileId", + "description": "ID of the site profile to be associated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastSiteProfileID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "dastScannerProfileId", + "description": "ID of the scanner profile to be associated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastScannerProfileID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "runAfterCreate", + "description": "Run scan using profile after creation. Defaults to false.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "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": "DastProfileCreatePayload", + "description": "Autogenerated return type of DastProfileCreate", + "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": "dastProfile", + "description": "The created profile.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "DastProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Errors encountered during execution of the mutation.", + "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": "pipelineUrl", + "description": "The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DastProfileDeleteInput", + "description": "Autogenerated input type of DastProfileDelete", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the profile to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastProfileID", + "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": "DastProfileDeletePayload", + "description": "Autogenerated return type of DastProfileDelete", + "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": "Errors encountered during execution of the mutation.", + "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 + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DastProfileEdge", + "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": "DastProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "DastProfileID", + "description": "Identifier of Dast::Profile.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DastProfileRunInput", + "description": "Autogenerated input type of DastProfileRun", + "fields": null, + "inputFields": [ + { + "name": "fullPath", + "description": "Full path for the project the scanner profile belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "ID of the profile to be used for the scan.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastProfileID", + "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": "DastProfileRunPayload", + "description": "Autogenerated return type of DastProfileRun", + "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": "Errors encountered during execution of the mutation.", + "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": "pipelineUrl", + "description": "URL of the pipeline that was created.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DastProfileUpdateInput", + "description": "Autogenerated input type of DastProfileUpdate", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "ID of the profile to be deleted.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DastProfileID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fullPath", + "description": "The project the profile belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name of the profile.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "description", + "description": "The description of the profile. Defaults to an empty string.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\"\"" + }, + { + "name": "dastSiteProfileId", + "description": "ID of the site profile to be associated.", + "type": { + "kind": "SCALAR", + "name": "DastSiteProfileID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dastScannerProfileId", + "description": "ID of the scanner profile to be associated.", + "type": { + "kind": "SCALAR", + "name": "DastScannerProfileID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "runAfterUpdate", + "description": "Run scan using profile after update. Defaults to false.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "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": "DastProfileUpdatePayload", + "description": "Autogenerated return type of DastProfileUpdate", + "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": "dastProfile", + "description": "The updated profile.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "DastProfile", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Errors encountered during execution of the mutation.", + "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": "pipelineUrl", + "description": "The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "ENUM", "name": "DastScanTypeEnum", "description": null, @@ -15004,7 +16641,7 @@ "fields": [ { "name": "editPath", - "description": "Relative web path to the edit page of a scanner profile", + "description": "Relative web path to the edit page of a scanner profile.", "args": [ ], @@ -15018,7 +16655,7 @@ }, { "name": "globalId", - "description": "ID of the DAST scanner profile Deprecated in 13.6: Use `id`.", + "description": "ID of the DAST scanner profile. Deprecated in 13.6: Use `id`.", "args": [ ], @@ -15036,7 +16673,7 @@ }, { "name": "id", - "description": "ID of the DAST scanner profile", + "description": "ID of the DAST scanner profile.", "args": [ ], @@ -15054,7 +16691,7 @@ }, { "name": "profileName", - "description": "Name of the DAST scanner profile", + "description": "Name of the DAST scanner profile.", "args": [ ], @@ -15100,7 +16737,7 @@ }, { "name": "spiderTimeout", - "description": "The maximum number of minutes allowed for the spider to traverse the site", + "description": "The maximum number of minutes allowed for the spider to traverse the site.", "args": [ ], @@ -15114,7 +16751,7 @@ }, { "name": "targetTimeout", - "description": "The maximum number of seconds allowed for the site under test to respond to a request", + "description": "The maximum number of seconds allowed for the site under test to respond to a request.", "args": [ ], @@ -15549,7 +17186,7 @@ { "kind": "SCALAR", "name": "DastScannerProfileID", - "description": "Identifier of DastScannerProfile", + "description": "Identifier of DastScannerProfile.", "fields": null, "inputFields": null, "interfaces": null, @@ -15751,7 +17388,7 @@ "fields": [ { "name": "editPath", - "description": "Relative web path to the edit page of a site profile", + "description": "Relative web path to the edit page of a site profile.", "args": [ ], @@ -15765,7 +17402,7 @@ }, { "name": "id", - "description": "ID of the site profile", + "description": "ID of the site profile.", "args": [ ], @@ -15783,7 +17420,7 @@ }, { "name": "normalizedTargetUrl", - "description": "Normalized URL of the target to be scanned", + "description": "Normalized URL of the target to be scanned.", "args": [ ], @@ -15797,7 +17434,7 @@ }, { "name": "profileName", - "description": "The name of the site profile", + "description": "The name of the site profile.", "args": [ ], @@ -15811,7 +17448,7 @@ }, { "name": "targetUrl", - "description": "The URL of the target to be scanned", + "description": "The URL of the target to be scanned.", "args": [ ], @@ -15843,7 +17480,7 @@ }, { "name": "validationStatus", - "description": "The current validation status of the site profile", + "description": "The current validation status of the site profile.", "args": [ ], @@ -16206,7 +17843,7 @@ { "kind": "SCALAR", "name": "DastSiteProfileID", - "description": "Identifier of DastSiteProfile", + "description": "Identifier of DastSiteProfile.", "fields": null, "inputFields": null, "interfaces": null, @@ -16568,7 +18205,7 @@ { "kind": "SCALAR", "name": "DastSiteTokenID", - "description": "Identifier of DastSiteToken", + "description": "Identifier of DastSiteToken.", "fields": null, "inputFields": null, "interfaces": null, @@ -16582,7 +18219,7 @@ "fields": [ { "name": "id", - "description": "Global ID of the site validation", + "description": "Global ID of the site validation.", "args": [ ], @@ -16600,7 +18237,7 @@ }, { "name": "normalizedTargetUrl", - "description": "Normalized URL of the target to be validated", + "description": "Normalized URL of the target to be validated.", "args": [ ], @@ -16614,7 +18251,7 @@ }, { "name": "status", - "description": "Status of the site validation", + "description": "Status of the site validation.", "args": [ ], @@ -16907,7 +18544,7 @@ { "kind": "SCALAR", "name": "DastSiteValidationID", - "description": "Identifier of DastSiteValidation", + "description": "Identifier of DastSiteValidation.", "fields": null, "inputFields": null, "interfaces": null, @@ -16915,6 +18552,108 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "DastSiteValidationRevokeInput", + "description": "Autogenerated input type of DastSiteValidationRevoke", + "fields": null, + "inputFields": [ + { + "name": "fullPath", + "description": "The project the site validation belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "normalizedTargetUrl", + "description": "Normalized URL of the target to be revoked.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "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": "DastSiteValidationRevokePayload", + "description": "Autogenerated return type of DastSiteValidationRevoke", + "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": "Errors encountered during execution of the mutation.", + "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 + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "ENUM", "name": "DastSiteValidationStrategyEnum", "description": null, @@ -17248,7 +18987,7 @@ "fields": [ { "name": "completed", - "description": "Whether or not the entire queue was processed in time; if not, retrying the same request is safe", + "description": "Whether or not the entire queue was processed in time; if not, retrying the same request is safe.", "args": [ ], @@ -17262,7 +19001,7 @@ }, { "name": "deletedJobs", - "description": "The number of matching jobs deleted", + "description": "The number of matching jobs deleted.", "args": [ ], @@ -17276,7 +19015,7 @@ }, { "name": "queueSize", - "description": "The queue size after processing", + "description": "The queue size after processing.", "args": [ ], @@ -17303,7 +19042,7 @@ "fields": [ { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -17347,7 +19086,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -17370,7 +19109,7 @@ }, { "name": "diffRefs", - "description": "The diff refs for this design", + "description": "The diff refs for this design.", "args": [ ], @@ -17388,7 +19127,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -17445,7 +19184,7 @@ }, { "name": "event", - "description": "How this design was changed in the current version", + "description": "How this design was changed in the current version.", "args": [ ], @@ -17463,7 +19202,7 @@ }, { "name": "filename", - "description": "The filename of the design", + "description": "The filename of the design.", "args": [ ], @@ -17481,7 +19220,7 @@ }, { "name": "fullPath", - "description": "The full path to the design file", + "description": "The full path to the design file.", "args": [ ], @@ -17499,7 +19238,7 @@ }, { "name": "id", - "description": "The ID of this design", + "description": "The ID of this design.", "args": [ ], @@ -17517,7 +19256,7 @@ }, { "name": "image", - "description": "The URL of the full-sized image", + "description": "The URL of the full-sized image.", "args": [ ], @@ -17549,7 +19288,7 @@ }, { "name": "issue", - "description": "The issue the design belongs to", + "description": "The issue the design belongs to.", "args": [ ], @@ -17567,7 +19306,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -17624,7 +19363,7 @@ }, { "name": "notesCount", - "description": "The total count of user-created notes for this design", + "description": "The total count of user-created notes for this design.", "args": [ ], @@ -17642,7 +19381,7 @@ }, { "name": "project", - "description": "The project the design belongs to", + "description": "The project the design belongs to.", "args": [ ], @@ -17660,7 +19399,7 @@ }, { "name": "versions", - "description": "All versions related to this design ordered newest first", + "description": "All versions related to this design ordered newest first.", "args": [ { "name": "earlierOrEqualToSha", @@ -17764,7 +19503,7 @@ "fields": [ { "name": "design", - "description": "The underlying design", + "description": "The underlying design.", "args": [ ], @@ -17782,7 +19521,7 @@ }, { "name": "diffRefs", - "description": "The diff refs for this design", + "description": "The diff refs for this design.", "args": [ ], @@ -17800,7 +19539,7 @@ }, { "name": "event", - "description": "How this design was changed in the current version", + "description": "How this design was changed in the current version.", "args": [ ], @@ -17818,7 +19557,7 @@ }, { "name": "filename", - "description": "The filename of the design", + "description": "The filename of the design.", "args": [ ], @@ -17836,7 +19575,7 @@ }, { "name": "fullPath", - "description": "The full path to the design file", + "description": "The full path to the design file.", "args": [ ], @@ -17854,7 +19593,7 @@ }, { "name": "id", - "description": "The ID of this design", + "description": "The ID of this design.", "args": [ ], @@ -17872,7 +19611,7 @@ }, { "name": "image", - "description": "The URL of the full-sized image", + "description": "The URL of the full-sized image.", "args": [ ], @@ -17904,7 +19643,7 @@ }, { "name": "issue", - "description": "The issue the design belongs to", + "description": "The issue the design belongs to.", "args": [ ], @@ -17922,7 +19661,7 @@ }, { "name": "notesCount", - "description": "The total count of user-created notes for this design", + "description": "The total count of user-created notes for this design.", "args": [ ], @@ -17940,7 +19679,7 @@ }, { "name": "project", - "description": "The project the design belongs to", + "description": "The project the design belongs to.", "args": [ ], @@ -17958,7 +19697,7 @@ }, { "name": "version", - "description": "The version this design-at-versions is pinned to", + "description": "The version this design-at-versions is pinned to.", "args": [ ], @@ -18105,7 +19844,7 @@ "fields": [ { "name": "copyState", - "description": "Copy state of the design collection", + "description": "Copy state of the design collection.", "args": [ ], @@ -18119,7 +19858,7 @@ }, { "name": "design", - "description": "Find a specific design", + "description": "Find a specific design.", "args": [ { "name": "id", @@ -18152,7 +19891,7 @@ }, { "name": "designAtVersion", - "description": "Find a design as of a version", + "description": "Find a design as of a version.", "args": [ { "name": "id", @@ -18179,7 +19918,7 @@ }, { "name": "designs", - "description": "All designs for the design collection", + "description": "All designs for the design collection.", "args": [ { "name": "ids", @@ -18282,7 +20021,7 @@ }, { "name": "issue", - "description": "Issue associated with the design collection", + "description": "Issue associated with the design collection.", "args": [ ], @@ -18300,7 +20039,7 @@ }, { "name": "project", - "description": "Project associated with the design collection", + "description": "Project associated with the design collection.", "args": [ ], @@ -18318,7 +20057,7 @@ }, { "name": "version", - "description": "A specific version", + "description": "A specific version.", "args": [ { "name": "sha", @@ -18351,7 +20090,7 @@ }, { "name": "versions", - "description": "All versions related to all designs, ordered newest first", + "description": "All versions related to all designs, ordered newest first.", "args": [ { "name": "earlierOrEqualToSha", @@ -18582,7 +20321,7 @@ "fields": [ { "name": "diffRefs", - "description": "The diff refs for this design", + "description": "The diff refs for this design.", "args": [ ], @@ -18600,7 +20339,7 @@ }, { "name": "event", - "description": "How this design was changed in the current version", + "description": "How this design was changed in the current version.", "args": [ ], @@ -18618,7 +20357,7 @@ }, { "name": "filename", - "description": "The filename of the design", + "description": "The filename of the design.", "args": [ ], @@ -18636,7 +20375,7 @@ }, { "name": "fullPath", - "description": "The full path to the design file", + "description": "The full path to the design file.", "args": [ ], @@ -18654,7 +20393,7 @@ }, { "name": "id", - "description": "The ID of this design", + "description": "The ID of this design.", "args": [ ], @@ -18672,7 +20411,7 @@ }, { "name": "image", - "description": "The URL of the full-sized image", + "description": "The URL of the full-sized image.", "args": [ ], @@ -18704,7 +20443,7 @@ }, { "name": "issue", - "description": "The issue the design belongs to", + "description": "The issue the design belongs to.", "args": [ ], @@ -18722,7 +20461,7 @@ }, { "name": "notesCount", - "description": "The total count of user-created notes for this design", + "description": "The total count of user-created notes for this design.", "args": [ ], @@ -18740,7 +20479,7 @@ }, { "name": "project", - "description": "The project the design belongs to", + "description": "The project the design belongs to.", "args": [ ], @@ -18780,7 +20519,7 @@ "fields": [ { "name": "designAtVersion", - "description": "Find a design as of a version", + "description": "Find a design as of a version.", "args": [ { "name": "id", @@ -18807,7 +20546,7 @@ }, { "name": "version", - "description": "Find a version", + "description": "Find a version.", "args": [ { "name": "id", @@ -18981,7 +20720,7 @@ { "kind": "SCALAR", "name": "DesignManagementDesignAtVersionID", - "description": "Identifier of DesignManagement::DesignAtVersion", + "description": "Identifier of DesignManagement::DesignAtVersion.", "fields": null, "inputFields": null, "interfaces": null, @@ -18991,7 +20730,7 @@ { "kind": "SCALAR", "name": "DesignManagementDesignID", - "description": "Identifier of DesignManagement::Design", + "description": "Identifier of DesignManagement::Design.", "fields": null, "inputFields": null, "interfaces": null, @@ -19299,7 +21038,7 @@ { "kind": "SCALAR", "name": "DesignManagementVersionID", - "description": "Identifier of DesignManagement::Version", + "description": "Identifier of DesignManagement::Version.", "fields": null, "inputFields": null, "interfaces": null, @@ -19313,7 +21052,7 @@ "fields": [ { "name": "designAtVersion", - "description": "A particular design as of this version, provided it is visible at this version", + "description": "A particular design as of this version, provided it is visible at this version.", "args": [ { "name": "id", @@ -19360,7 +21099,7 @@ }, { "name": "designs", - "description": "All designs that were changed in the version", + "description": "All designs that were changed in the version.", "args": [ { "name": "after", @@ -19417,7 +21156,7 @@ }, { "name": "designsAtVersion", - "description": "All designs that are visible at this version, as of this version", + "description": "All designs that are visible at this version, as of this version.", "args": [ { "name": "ids", @@ -19510,7 +21249,7 @@ }, { "name": "id", - "description": "ID of the design version", + "description": "ID of the design version.", "args": [ ], @@ -19528,7 +21267,7 @@ }, { "name": "sha", - "description": "SHA of the design version", + "description": "SHA of the design version.", "args": [ ], @@ -20444,7 +22183,7 @@ "fields": [ { "name": "action", - "description": "Action information for the status. This includes method, button title, icon, path, and title", + "description": "Action information for the status. This includes method, button title, icon, path, and title.", "args": [ ], @@ -20458,7 +22197,7 @@ }, { "name": "detailsPath", - "description": "Path of the details for the status", + "description": "Path of the details for the status.", "args": [ ], @@ -20472,7 +22211,7 @@ }, { "name": "favicon", - "description": "Favicon of the status", + "description": "Favicon of the status.", "args": [ ], @@ -20486,7 +22225,7 @@ }, { "name": "group", - "description": "Group of the status", + "description": "Group of the status.", "args": [ ], @@ -20500,7 +22239,7 @@ }, { "name": "hasDetails", - "description": "Indicates if the status has further details", + "description": "Indicates if the status has further details.", "args": [ ], @@ -20514,7 +22253,7 @@ }, { "name": "icon", - "description": "Icon of the status", + "description": "Icon of the status.", "args": [ ], @@ -20528,7 +22267,7 @@ }, { "name": "label", - "description": "Label of the status", + "description": "Label of the status.", "args": [ ], @@ -20542,7 +22281,7 @@ }, { "name": "text", - "description": "Text of the status", + "description": "Text of the status.", "args": [ ], @@ -20556,7 +22295,7 @@ }, { "name": "tooltip", - "description": "Tooltip associated with the status", + "description": "Tooltip associated with the status.", "args": [ ], @@ -20582,30 +22321,8 @@ "description": "Segment", "fields": [ { - "name": "groups", - "description": "Assigned groups", - "args": [ - - ], - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Group", - "ofType": null - } - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { "name": "id", - "description": "ID of the segment", + "description": "ID of the segment.", "args": [ ], @@ -20623,7 +22340,7 @@ }, { "name": "latestSnapshot", - "description": "The latest adoption metrics for the segment", + "description": "The latest adoption metrics for the segment.", "args": [ ], @@ -20636,19 +22353,15 @@ "deprecationReason": null }, { - "name": "name", - "description": "Name of the segment", + "name": "namespace", + "description": "Segment namespace.", "args": [ ], "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "OBJECT", + "name": "Namespace", + "ofType": null }, "isDeprecated": false, "deprecationReason": null @@ -20780,7 +22493,7 @@ "fields": [ { "name": "deploySucceeded", - "description": "At least one deployment succeeded", + "description": "At least one deployment succeeded.", "args": [ ], @@ -20798,7 +22511,7 @@ }, { "name": "endTime", - "description": "The end time for the snapshot where the data points were collected", + "description": "The end time for the snapshot where the data points were collected.", "args": [ ], @@ -20816,7 +22529,7 @@ }, { "name": "issueOpened", - "description": "At least one issue was opened", + "description": "At least one issue was opened.", "args": [ ], @@ -20834,7 +22547,7 @@ }, { "name": "mergeRequestApproved", - "description": "At least one merge request was approved", + "description": "At least one merge request was approved.", "args": [ ], @@ -20852,7 +22565,7 @@ }, { "name": "mergeRequestOpened", - "description": "At least one merge request was opened", + "description": "At least one merge request was opened.", "args": [ ], @@ -20870,7 +22583,7 @@ }, { "name": "pipelineSucceeded", - "description": "At least one pipeline succeeded", + "description": "At least one pipeline succeeded.", "args": [ ], @@ -20888,7 +22601,7 @@ }, { "name": "recordedAt", - "description": "The time the snapshot was recorded", + "description": "The time the snapshot was recorded.", "args": [ ], @@ -20906,7 +22619,7 @@ }, { "name": "runnerConfigured", - "description": "At least one runner was used", + "description": "At least one runner was used.", "args": [ ], @@ -20924,7 +22637,7 @@ }, { "name": "securityScanSucceeded", - "description": "At least one security scan succeeded", + "description": "At least one security scan succeeded.", "args": [ ], @@ -20942,7 +22655,7 @@ }, { "name": "startTime", - "description": "The start time for the snapshot where the data points were collected", + "description": "The start time for the snapshot where the data points were collected.", "args": [ ], @@ -20974,7 +22687,7 @@ "inputFields": [ { "name": "headSha", - "description": "SHA of the HEAD at the time the comment was made", + "description": "SHA of the HEAD at the time the comment was made.", "type": { "kind": "NON_NULL", "name": null, @@ -20988,7 +22701,7 @@ }, { "name": "baseSha", - "description": "Merge base of the branch the comment was made on", + "description": "Merge base of the branch the comment was made on.", "type": { "kind": "SCALAR", "name": "String", @@ -20998,7 +22711,7 @@ }, { "name": "startSha", - "description": "SHA of the branch being compared against", + "description": "SHA of the branch being compared against.", "type": { "kind": "NON_NULL", "name": null, @@ -21026,7 +22739,7 @@ }, { "name": "x", - "description": "X position of the note", + "description": "X position of the note.", "type": { "kind": "NON_NULL", "name": null, @@ -21040,7 +22753,7 @@ }, { "name": "y", - "description": "Y position of the note", + "description": "Y position of the note.", "type": { "kind": "NON_NULL", "name": null, @@ -21054,7 +22767,7 @@ }, { "name": "width", - "description": "Total width of the image", + "description": "Total width of the image.", "type": { "kind": "NON_NULL", "name": null, @@ -21068,7 +22781,7 @@ }, { "name": "height", - "description": "Total height of the image", + "description": "Total height of the image.", "type": { "kind": "NON_NULL", "name": null, @@ -21088,7 +22801,7 @@ { "kind": "SCALAR", "name": "DiffNoteID", - "description": "Identifier of DiffNote", + "description": "Identifier of DiffNote.", "fields": null, "inputFields": null, "interfaces": null, @@ -21103,7 +22816,7 @@ "inputFields": [ { "name": "oldPath", - "description": "The path of the file on the start sha", + "description": "The path of the file on the start sha.", "type": { "kind": "SCALAR", "name": "String", @@ -21113,7 +22826,7 @@ }, { "name": "newPath", - "description": "The path of the file on the head sha", + "description": "The path of the file on the head sha.", "type": { "kind": "SCALAR", "name": "String", @@ -21133,7 +22846,7 @@ "fields": [ { "name": "diffRefs", - "description": "Information about the branch, HEAD, and base at the time of commenting", + "description": "Information about the branch, HEAD, and base at the time of commenting.", "args": [ ], @@ -21151,7 +22864,7 @@ }, { "name": "filePath", - "description": "Path of the file that was changed", + "description": "Path of the file that was changed.", "args": [ ], @@ -21169,7 +22882,7 @@ }, { "name": "height", - "description": "Total height of the image", + "description": "Total height of the image.", "args": [ ], @@ -21183,7 +22896,7 @@ }, { "name": "newLine", - "description": "Line on HEAD SHA that was changed", + "description": "Line on HEAD SHA that was changed.", "args": [ ], @@ -21197,7 +22910,7 @@ }, { "name": "newPath", - "description": "Path of the file on the HEAD SHA", + "description": "Path of the file on the HEAD SHA.", "args": [ ], @@ -21211,7 +22924,7 @@ }, { "name": "oldLine", - "description": "Line on start SHA that was changed", + "description": "Line on start SHA that was changed.", "args": [ ], @@ -21225,7 +22938,7 @@ }, { "name": "oldPath", - "description": "Path of the file on the start SHA", + "description": "Path of the file on the start SHA.", "args": [ ], @@ -21239,7 +22952,7 @@ }, { "name": "positionType", - "description": "Type of file the position refers to", + "description": "Type of file the position refers to.", "args": [ ], @@ -21257,7 +22970,7 @@ }, { "name": "width", - "description": "Total width of the image", + "description": "Total width of the image.", "args": [ ], @@ -21271,7 +22984,7 @@ }, { "name": "x", - "description": "X position of the note", + "description": "X position of the note.", "args": [ ], @@ -21285,7 +22998,7 @@ }, { "name": "y", - "description": "Y position of the note", + "description": "Y position of the note.", "args": [ ], @@ -21313,7 +23026,7 @@ "inputFields": [ { "name": "headSha", - "description": "SHA of the HEAD at the time the comment was made", + "description": "SHA of the HEAD at the time the comment was made.", "type": { "kind": "NON_NULL", "name": null, @@ -21327,7 +23040,7 @@ }, { "name": "baseSha", - "description": "Merge base of the branch the comment was made on", + "description": "Merge base of the branch the comment was made on.", "type": { "kind": "SCALAR", "name": "String", @@ -21337,7 +23050,7 @@ }, { "name": "startSha", - "description": "SHA of the branch being compared against", + "description": "SHA of the branch being compared against.", "type": { "kind": "NON_NULL", "name": null, @@ -21365,7 +23078,7 @@ }, { "name": "oldLine", - "description": "Line on start SHA that was changed", + "description": "Line on start SHA that was changed.", "type": { "kind": "SCALAR", "name": "Int", @@ -21375,7 +23088,7 @@ }, { "name": "newLine", - "description": "Line on HEAD SHA that was changed", + "description": "Line on HEAD SHA that was changed.", "type": { "kind": "NON_NULL", "name": null, @@ -21422,7 +23135,7 @@ "fields": [ { "name": "baseSha", - "description": "Merge base of the branch the comment was made on", + "description": "Merge base of the branch the comment was made on.", "args": [ ], @@ -21436,7 +23149,7 @@ }, { "name": "headSha", - "description": "SHA of the HEAD at the time the comment was made", + "description": "SHA of the HEAD at the time the comment was made.", "args": [ ], @@ -21454,7 +23167,7 @@ }, { "name": "startSha", - "description": "SHA of the branch being compared against", + "description": "SHA of the branch being compared against.", "args": [ ], @@ -21485,7 +23198,7 @@ "fields": [ { "name": "additions", - "description": "Number of lines added to this file", + "description": "Number of lines added to this file.", "args": [ ], @@ -21503,7 +23216,7 @@ }, { "name": "deletions", - "description": "Number of lines deleted from this file", + "description": "Number of lines deleted from this file.", "args": [ ], @@ -21521,7 +23234,7 @@ }, { "name": "path", - "description": "File path, relative to repository root", + "description": "File path, relative to repository root.", "args": [ ], @@ -21552,7 +23265,7 @@ "fields": [ { "name": "additions", - "description": "Number of lines added", + "description": "Number of lines added.", "args": [ ], @@ -21570,7 +23283,7 @@ }, { "name": "changes", - "description": "Number of lines changed", + "description": "Number of lines changed.", "args": [ ], @@ -21588,7 +23301,7 @@ }, { "name": "deletions", - "description": "Number of lines deleted", + "description": "Number of lines deleted.", "args": [ ], @@ -21606,7 +23319,7 @@ }, { "name": "fileCount", - "description": "Number of files changed", + "description": "Number of files changed.", "args": [ ], @@ -21637,7 +23350,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of the discussion's creation", + "description": "Timestamp of the discussion's creation.", "args": [ ], @@ -21655,7 +23368,7 @@ }, { "name": "id", - "description": "ID of this discussion", + "description": "ID of this discussion.", "args": [ ], @@ -21664,7 +23377,7 @@ "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "DiscussionID", "ofType": null } }, @@ -21673,7 +23386,7 @@ }, { "name": "notes", - "description": "All notes in the discussion", + "description": "All notes in the discussion.", "args": [ { "name": "after", @@ -21730,7 +23443,7 @@ }, { "name": "replyId", - "description": "ID used to reply to this discussion", + "description": "ID used to reply to this discussion.", "args": [ ], @@ -21739,7 +23452,7 @@ "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "DiscussionID", "ofType": null } }, @@ -21748,7 +23461,7 @@ }, { "name": "resolvable", - "description": "Indicates if the object can be resolved", + "description": "Indicates if the object can be resolved.", "args": [ ], @@ -21766,7 +23479,7 @@ }, { "name": "resolved", - "description": "Indicates if the object is resolved", + "description": "Indicates if the object is resolved.", "args": [ ], @@ -21784,7 +23497,7 @@ }, { "name": "resolvedAt", - "description": "Timestamp of when the object was resolved", + "description": "Timestamp of when the object was resolved.", "args": [ ], @@ -21798,7 +23511,7 @@ }, { "name": "resolvedBy", - "description": "User who resolved the object", + "description": "User who resolved the object.", "args": [ ], @@ -21937,7 +23650,7 @@ { "kind": "SCALAR", "name": "DiscussionID", - "description": "Identifier of Discussion", + "description": "Identifier of Discussion.", "fields": null, "inputFields": null, "interfaces": null, @@ -22189,7 +23902,7 @@ "fields": [ { "name": "flatPath", - "description": "Flat path of the entry", + "description": "Flat path of the entry.", "args": [ ], @@ -22207,7 +23920,7 @@ }, { "name": "id", - "description": "ID of the entry", + "description": "ID of the entry.", "args": [ ], @@ -22225,7 +23938,7 @@ }, { "name": "name", - "description": "Name of the entry", + "description": "Name of the entry.", "args": [ ], @@ -22243,7 +23956,7 @@ }, { "name": "path", - "description": "Path of the entry", + "description": "Path of the entry.", "args": [ ], @@ -22261,7 +23974,7 @@ }, { "name": "sha", - "description": "Last commit sha for the entry", + "description": "Last commit SHA for the entry.", "args": [ ], @@ -22279,7 +23992,7 @@ }, { "name": "type", - "description": "Type of tree entry", + "description": "Type of tree entry.", "args": [ ], @@ -22353,7 +24066,7 @@ "fields": [ { "name": "id", - "description": "ID of the environment", + "description": "ID of the environment.", "args": [ ], @@ -22371,7 +24084,7 @@ }, { "name": "latestOpenedMostSevereAlert", - "description": "The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned", + "description": "The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned.", "args": [ ], @@ -22385,7 +24098,7 @@ }, { "name": "metricsDashboard", - "description": "Metrics dashboard schema for the environment", + "description": "Metrics dashboard schema for the environment.", "args": [ { "name": "path", @@ -22412,7 +24125,7 @@ }, { "name": "name", - "description": "Human-readable name of the environment", + "description": "Human-readable name of the environment.", "args": [ ], @@ -22448,7 +24161,7 @@ }, { "name": "state", - "description": "State of the environment, for example: available/stopped", + "description": "State of the environment, for example: available/stopped.", "args": [ ], @@ -22587,7 +24300,7 @@ { "kind": "SCALAR", "name": "EnvironmentID", - "description": "Identifier of Environment", + "description": "Identifier of Environment.", "fields": null, "inputFields": null, "interfaces": null, @@ -22703,7 +24416,7 @@ "fields": [ { "name": "author", - "description": "Author of the epic", + "description": "Author of the epic.", "args": [ ], @@ -22720,8 +24433,61 @@ "deprecationReason": null }, { + "name": "awardEmoji", + "description": "A list of award emojis associated with the epic.", + "args": [ + { + "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": "AwardEmojiConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "children", - "description": "Children (sub-epics) of the epic", + "description": "Children (sub-epics) of the epic.", "args": [ { "name": "startDate", @@ -22930,7 +24696,7 @@ }, { "name": "closedAt", - "description": "Timestamp of when the epic was closed", + "description": "Timestamp of when the epic was closed.", "args": [ ], @@ -22944,7 +24710,7 @@ }, { "name": "confidential", - "description": "Indicates if the epic is confidential", + "description": "Indicates if the epic is confidential.", "args": [ ], @@ -22958,7 +24724,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the epic was created", + "description": "Timestamp of when the epic was created.", "args": [ ], @@ -22972,7 +24738,7 @@ }, { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -23016,7 +24782,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -23039,7 +24805,7 @@ }, { "name": "descendantCounts", - "description": "Number of open and closed descendant epics and issues", + "description": "Number of open and closed descendant epics and issues.", "args": [ ], @@ -23053,7 +24819,7 @@ }, { "name": "descendantWeightSum", - "description": "Total weight of open and closed issues in the epic and its descendants", + "description": "Total weight of open and closed issues in the epic and its descendants.", "args": [ ], @@ -23067,7 +24833,7 @@ }, { "name": "description", - "description": "Description of the epic", + "description": "Description of the epic.", "args": [ ], @@ -23081,7 +24847,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -23138,7 +24904,7 @@ }, { "name": "downvotes", - "description": "Number of downvotes the epic has received", + "description": "Number of downvotes the epic has received.", "args": [ ], @@ -23156,7 +24922,7 @@ }, { "name": "dueDate", - "description": "Due date of the epic", + "description": "Due date of the epic.", "args": [ ], @@ -23170,7 +24936,7 @@ }, { "name": "dueDateFixed", - "description": "Fixed due date of the epic", + "description": "Fixed due date of the epic.", "args": [ ], @@ -23184,7 +24950,7 @@ }, { "name": "dueDateFromMilestones", - "description": "Inherited due date of the epic from milestones", + "description": "Inherited due date of the epic from milestones.", "args": [ ], @@ -23198,7 +24964,7 @@ }, { "name": "dueDateIsFixed", - "description": "Indicates if the due date has been manually set", + "description": "Indicates if the due date has been manually set.", "args": [ ], @@ -23211,8 +24977,61 @@ "deprecationReason": null }, { + "name": "events", + "description": "A list of events associated with the object.", + "args": [ + { + "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": "EventConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "group", - "description": "Group to which the epic belongs", + "description": "Group to which the epic belongs.", "args": [ ], @@ -23230,7 +25049,7 @@ }, { "name": "hasChildren", - "description": "Indicates if the epic has children", + "description": "Indicates if the epic has children.", "args": [ ], @@ -23248,7 +25067,7 @@ }, { "name": "hasIssues", - "description": "Indicates if the epic has direct issues", + "description": "Indicates if the epic has direct issues.", "args": [ ], @@ -23266,7 +25085,7 @@ }, { "name": "hasParent", - "description": "Indicates if the epic has a parent epic", + "description": "Indicates if the epic has a parent epic.", "args": [ ], @@ -23284,7 +25103,7 @@ }, { "name": "healthStatus", - "description": "Current health status of the epic", + "description": "Current health status of the epic.", "args": [ ], @@ -23298,7 +25117,7 @@ }, { "name": "id", - "description": "ID of the epic", + "description": "ID of the epic.", "args": [ ], @@ -23316,7 +25135,7 @@ }, { "name": "iid", - "description": "Internal ID of the epic", + "description": "Internal ID of the epic.", "args": [ ], @@ -23334,7 +25153,7 @@ }, { "name": "issues", - "description": "A list of issues associated with the epic", + "description": "A list of issues associated with the epic.", "args": [ { "name": "after", @@ -23387,7 +25206,7 @@ }, { "name": "labels", - "description": "Labels assigned to the epic", + "description": "Labels assigned to the epic.", "args": [ { "name": "after", @@ -23440,7 +25259,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -23497,7 +25316,7 @@ }, { "name": "parent", - "description": "Parent epic of the epic", + "description": "Parent epic of the epic.", "args": [ ], @@ -23511,7 +25330,7 @@ }, { "name": "participants", - "description": "List of participants for the epic", + "description": "List of participants for the epic.", "args": [ { "name": "after", @@ -23564,11 +25383,11 @@ }, { "name": "reference", - "description": "Internal reference of the epic. Returned in shortened format by default", + "description": "Internal reference of the epic. Returned in shortened format by default.", "args": [ { "name": "full", - "description": "Indicates if the reference should be returned in full", + "description": "Indicates if the reference should be returned in full.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -23591,7 +25410,7 @@ }, { "name": "relationPath", - "description": "URI path of the epic-issue relationship", + "description": "URI path of the epic-issue relationship.", "args": [ ], @@ -23605,7 +25424,7 @@ }, { "name": "relativePosition", - "description": "The relative position of the epic in the epic tree", + "description": "The relative position of the epic in the epic tree.", "args": [ ], @@ -23619,7 +25438,7 @@ }, { "name": "startDate", - "description": "Start date of the epic", + "description": "Start date of the epic.", "args": [ ], @@ -23633,7 +25452,7 @@ }, { "name": "startDateFixed", - "description": "Fixed start date of the epic", + "description": "Fixed start date of the epic.", "args": [ ], @@ -23647,7 +25466,7 @@ }, { "name": "startDateFromMilestones", - "description": "Inherited start date of the epic from milestones", + "description": "Inherited start date of the epic from milestones.", "args": [ ], @@ -23661,7 +25480,7 @@ }, { "name": "startDateIsFixed", - "description": "Indicates if the start date has been manually set", + "description": "Indicates if the start date has been manually set.", "args": [ ], @@ -23675,7 +25494,7 @@ }, { "name": "state", - "description": "State of the epic", + "description": "State of the epic.", "args": [ ], @@ -23693,7 +25512,7 @@ }, { "name": "subscribed", - "description": "Indicates the currently logged in user is subscribed to the epic", + "description": "Indicates the currently logged in user is subscribed to the epic.", "args": [ ], @@ -23711,7 +25530,7 @@ }, { "name": "title", - "description": "Title of the epic", + "description": "Title of the epic.", "args": [ ], @@ -23725,7 +25544,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the epic was updated", + "description": "Timestamp of when the epic was updated.", "args": [ ], @@ -23739,7 +25558,7 @@ }, { "name": "upvotes", - "description": "Number of upvotes the epic has received", + "description": "Number of upvotes the epic has received.", "args": [ ], @@ -23757,7 +25576,7 @@ }, { "name": "userDiscussionsCount", - "description": "Number of user discussions in the epic", + "description": "Number of user discussions in the epic.", "args": [ ], @@ -23775,7 +25594,7 @@ }, { "name": "userNotesCount", - "description": "Number of user notes of the epic", + "description": "Number of user notes of the epic.", "args": [ ], @@ -23811,7 +25630,7 @@ }, { "name": "webPath", - "description": "Web path of the epic", + "description": "Web path of the epic.", "args": [ ], @@ -23829,7 +25648,7 @@ }, { "name": "webUrl", - "description": "Web URL of the epic", + "description": "Web URL of the epic.", "args": [ ], @@ -23857,6 +25676,11 @@ "kind": "INTERFACE", "name": "CurrentUserTodos", "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Eventable", + "ofType": null } ], "enumValues": null, @@ -24196,6 +26020,134 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "EpicBoardCreateInput", + "description": "Autogenerated input type of EpicBoardCreate", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The board name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "hideBacklogList", + "description": "Whether or not backlog list is hidden.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "hideClosedList", + "description": "Whether or not closed list is hidden.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "groupPath", + "description": "Full path of the group with which the resource is associated.", + "type": { + "kind": "SCALAR", + "name": "ID", + "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": "EpicBoardCreatePayload", + "description": "Autogenerated return type of EpicBoardCreate", + "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": "epicBoard", + "description": "The created epic board.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "EpicBoard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "Errors encountered during execution of the mutation.", + "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 + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "OBJECT", "name": "EpicBoardEdge", "description": "An edge in a connection.", @@ -24241,6 +26193,128 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "EpicBoardListCreateInput", + "description": "Autogenerated input type of EpicBoardListCreate", + "fields": null, + "inputFields": [ + { + "name": "backlog", + "description": "Create the backlog list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "labelId", + "description": "Global ID of an existing label.", + "type": { + "kind": "SCALAR", + "name": "LabelID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "boardId", + "description": "Global ID of the issue board to mutate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "BoardsEpicBoardID", + "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": "EpicBoardListCreatePayload", + "description": "Autogenerated return type of EpicBoardListCreate", + "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": "Errors encountered during execution of the mutation.", + "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": "list", + "description": "Epic list in the epic board.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "EpicList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "OBJECT", "name": "EpicConnection", "description": "The connection type for Epic.", @@ -24314,7 +26388,7 @@ "fields": [ { "name": "closedEpics", - "description": "Number of closed child epics", + "description": "Number of closed child epics.", "args": [ ], @@ -24328,7 +26402,7 @@ }, { "name": "closedIssues", - "description": "Number of closed epic issues", + "description": "Number of closed epic issues.", "args": [ ], @@ -24342,7 +26416,7 @@ }, { "name": "openedEpics", - "description": "Number of opened child epics", + "description": "Number of opened child epics.", "args": [ ], @@ -24356,7 +26430,7 @@ }, { "name": "openedIssues", - "description": "Number of opened epic issues", + "description": "Number of opened epic issues.", "args": [ ], @@ -24383,7 +26457,7 @@ "fields": [ { "name": "closedIssues", - "description": "Total weight of completed (closed) issues in this epic, including epic descendants", + "description": "Total weight of completed (closed) issues in this epic, including epic descendants.", "args": [ ], @@ -24397,7 +26471,7 @@ }, { "name": "openedIssues", - "description": "Total weight of opened issues in this epic, including epic descendants", + "description": "Total weight of opened issues in this epic, including epic descendants.", "args": [ ], @@ -24469,7 +26543,7 @@ "fields": [ { "name": "issuesAtRisk", - "description": "Number of issues at risk", + "description": "Number of issues at risk.", "args": [ ], @@ -24483,7 +26557,7 @@ }, { "name": "issuesNeedingAttention", - "description": "Number of issues that need attention", + "description": "Number of issues that need attention.", "args": [ ], @@ -24497,7 +26571,7 @@ }, { "name": "issuesOnTrack", - "description": "Number of issues on track", + "description": "Number of issues on track.", "args": [ ], @@ -24520,7 +26594,7 @@ { "kind": "SCALAR", "name": "EpicID", - "description": "Identifier of Epic", + "description": "Identifier of Epic.", "fields": null, "inputFields": null, "interfaces": null, @@ -24534,7 +26608,7 @@ "fields": [ { "name": "alertManagementAlert", - "description": "Alert associated to this issue", + "description": "Alert associated to this issue.", "args": [ ], @@ -24548,7 +26622,7 @@ }, { "name": "assignees", - "description": "Assignees of the issue", + "description": "Assignees of the issue.", "args": [ { "name": "after", @@ -24601,7 +26675,7 @@ }, { "name": "author", - "description": "User that created the issue", + "description": "User that created the issue.", "args": [ ], @@ -24651,7 +26725,7 @@ }, { "name": "closedAt", - "description": "Timestamp of when the issue was closed", + "description": "Timestamp of when the issue was closed.", "args": [ ], @@ -24665,7 +26739,7 @@ }, { "name": "confidential", - "description": "Indicates the issue is confidential", + "description": "Indicates the issue is confidential.", "args": [ ], @@ -24683,7 +26757,7 @@ }, { "name": "createNoteEmail", - "description": "User specific email address for the issue", + "description": "User specific email address for the issue.", "args": [ ], @@ -24697,7 +26771,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the issue was created", + "description": "Timestamp of when the issue was created.", "args": [ ], @@ -24715,7 +26789,7 @@ }, { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -24759,7 +26833,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -24782,7 +26856,7 @@ }, { "name": "description", - "description": "Description of the issue", + "description": "Description of the issue.", "args": [ ], @@ -24810,7 +26884,7 @@ }, { "name": "designCollection", - "description": "Collection of design images associated with this issue", + "description": "Collection of design images associated with this issue.", "args": [ ], @@ -24824,7 +26898,7 @@ }, { "name": "discussionLocked", - "description": "Indicates discussion is locked on the issue", + "description": "Indicates discussion is locked on the issue.", "args": [ ], @@ -24842,7 +26916,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -24899,7 +26973,7 @@ }, { "name": "downvotes", - "description": "Number of downvotes the issue has received", + "description": "Number of downvotes the issue has received.", "args": [ ], @@ -24917,7 +26991,7 @@ }, { "name": "dueDate", - "description": "Due date of the issue", + "description": "Due date of the issue.", "args": [ ], @@ -24931,7 +27005,7 @@ }, { "name": "emailsDisabled", - "description": "Indicates if a project has email notifications disabled: `true` if email notifications are disabled", + "description": "Indicates if a project has email notifications disabled: `true` if email notifications are disabled.", "args": [ ], @@ -24963,7 +27037,7 @@ }, { "name": "epicIssueId", - "description": "ID of the epic-issue relation", + "description": "ID of the epic-issue relation.", "args": [ ], @@ -24995,7 +27069,7 @@ }, { "name": "humanTimeEstimate", - "description": "Human-readable time estimate of the issue", + "description": "Human-readable time estimate of the issue.", "args": [ ], @@ -25009,7 +27083,7 @@ }, { "name": "humanTotalTimeSpent", - "description": "Human-readable total time reported as spent on the issue", + "description": "Human-readable total time reported as spent on the issue.", "args": [ ], @@ -25023,7 +27097,7 @@ }, { "name": "id", - "description": "Global ID of the epic-issue relation", + "description": "Global ID of the epic-issue relation.", "args": [ ], @@ -25037,7 +27111,7 @@ }, { "name": "iid", - "description": "Internal ID of the issue", + "description": "Internal ID of the issue.", "args": [ ], @@ -25069,7 +27143,7 @@ }, { "name": "labels", - "description": "Labels of the issue", + "description": "Labels of the issue.", "args": [ { "name": "after", @@ -25144,7 +27218,7 @@ }, { "name": "milestone", - "description": "Milestone of the issue", + "description": "Milestone of the issue.", "args": [ ], @@ -25158,7 +27232,7 @@ }, { "name": "moved", - "description": "Indicates if issue got moved from other project", + "description": "Indicates if issue got moved from other project.", "args": [ ], @@ -25172,7 +27246,7 @@ }, { "name": "movedTo", - "description": "Updated Issue after it got moved to another project", + "description": "Updated Issue after it got moved to another project.", "args": [ ], @@ -25186,7 +27260,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -25243,7 +27317,7 @@ }, { "name": "participants", - "description": "List of participants in the issue", + "description": "List of participants in the issue.", "args": [ { "name": "after", @@ -25296,11 +27370,11 @@ }, { "name": "reference", - "description": "Internal reference of the issue. Returned in shortened format by default", + "description": "Internal reference of the issue. Returned in shortened format by default.", "args": [ { "name": "full", - "description": "Boolean option specifying whether the reference should be returned in full", + "description": "Boolean option specifying whether the reference should be returned in full.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -25323,7 +27397,7 @@ }, { "name": "relationPath", - "description": "URI path of the epic-issue relation", + "description": "URI path of the epic-issue relation.", "args": [ ], @@ -25337,7 +27411,7 @@ }, { "name": "relativePosition", - "description": "Relative position of the issue (used for positioning in epic tree and issue boards)", + "description": "Relative position of the issue (used for positioning in epic tree and issue boards).", "args": [ ], @@ -25351,7 +27425,7 @@ }, { "name": "severity", - "description": "Severity level of the incident", + "description": "Severity level of the incident.", "args": [ ], @@ -25379,7 +27453,7 @@ }, { "name": "state", - "description": "State of the issue", + "description": "State of the issue.", "args": [ ], @@ -25411,7 +27485,7 @@ }, { "name": "subscribed", - "description": "Indicates the currently logged in user is subscribed to the issue", + "description": "Indicates the currently logged in user is subscribed to the issue.", "args": [ ], @@ -25429,7 +27503,7 @@ }, { "name": "taskCompletionStatus", - "description": "Task completion status of the issue", + "description": "Task completion status of the issue.", "args": [ ], @@ -25447,7 +27521,7 @@ }, { "name": "timeEstimate", - "description": "Time estimate of the issue", + "description": "Time estimate of the issue.", "args": [ ], @@ -25465,7 +27539,7 @@ }, { "name": "title", - "description": "Title of the issue", + "description": "Title of the issue.", "args": [ ], @@ -25497,7 +27571,7 @@ }, { "name": "totalTimeSpent", - "description": "Total time reported as spent on the issue", + "description": "Total time reported as spent on the issue.", "args": [ ], @@ -25515,7 +27589,7 @@ }, { "name": "type", - "description": "Type of the issue", + "description": "Type of the issue.", "args": [ ], @@ -25529,7 +27603,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the issue was last updated", + "description": "Timestamp of when the issue was last updated.", "args": [ ], @@ -25547,7 +27621,7 @@ }, { "name": "updatedBy", - "description": "User that last updated the issue", + "description": "User that last updated the issue.", "args": [ ], @@ -25561,7 +27635,7 @@ }, { "name": "upvotes", - "description": "Number of upvotes the issue has received", + "description": "Number of upvotes the issue has received.", "args": [ ], @@ -25579,7 +27653,7 @@ }, { "name": "userDiscussionsCount", - "description": "Number of user discussions in the issue", + "description": "Number of user discussions in the issue.", "args": [ ], @@ -25597,7 +27671,7 @@ }, { "name": "userNotesCount", - "description": "Number of user notes of the issue", + "description": "Number of user notes of the issue.", "args": [ ], @@ -25633,7 +27707,7 @@ }, { "name": "webPath", - "description": "Web path of the issue", + "description": "Web path of the issue.", "args": [ ], @@ -25651,7 +27725,7 @@ }, { "name": "webUrl", - "description": "Web URL of the issue", + "description": "Web URL of the issue.", "args": [ ], @@ -25705,7 +27779,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -25777,7 +27851,7 @@ }, { "name": "weight", - "description": "Total weight of issues collection", + "description": "Total weight of issues collection.", "args": [ ], @@ -26488,7 +28562,7 @@ "inputFields": [ { "name": "id", - "description": "The ID of the epic_issue or epic that is being moved", + "description": "The ID of the epic_issue or epic that is being moved.", "type": { "kind": "NON_NULL", "name": null, @@ -26502,7 +28576,7 @@ }, { "name": "adjacentReferenceId", - "description": "The ID of the epic_issue or issue that the actual epic or issue is switched with", + "description": "The ID of the epic_issue or issue that the actual epic or issue is switched with.", "type": { "kind": "SCALAR", "name": "EpicTreeSortingID", @@ -26512,7 +28586,7 @@ }, { "name": "relativePosition", - "description": "The type of the switch, after or before allowed", + "description": "The type of the switch, after or before allowed.", "type": { "kind": "ENUM", "name": "MoveType", @@ -26522,7 +28596,7 @@ }, { "name": "newParentId", - "description": "ID of the new parent epic", + "description": "ID of the new parent epic.", "type": { "kind": "SCALAR", "name": "EpicID", @@ -26640,7 +28714,7 @@ { "kind": "SCALAR", "name": "EpicTreeSortingID", - "description": "Identifier of EpicTreeSorting", + "description": "Identifier of EpicTreeSorting.", "fields": null, "inputFields": null, "interfaces": null, @@ -26671,6 +28745,385 @@ "possibleTypes": null }, { + "kind": "OBJECT", + "name": "Event", + "description": "Representing an event", + "fields": [ + { + "name": "action", + "description": "Action of the event.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "EventAction", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "author", + "description": "Author of this event.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "User", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "When this event was created.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "ID of the event.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "When this event was updated.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "EventAction", + "description": "Event action", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED", + "description": "Created action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED", + "description": "Updated action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "Closed action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REOPENED", + "description": "Reopened action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUSHED", + "description": "Pushed action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMMENTED", + "description": "Commented action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERGED", + "description": "Merged action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JOINED", + "description": "Joined action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEFT", + "description": "Left action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESTROYED", + "description": "Destroyed action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED", + "description": "Expired action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED", + "description": "Approved action", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARCHIVED", + "description": "Archived action", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "EventConnection", + "description": "The connection type for Event.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "EventEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Event", + "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": "EventEdge", + "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": "Event", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Eventable", + "description": null, + "fields": [ + { + "name": "events", + "description": "A list of events associated with the object.", + "args": [ + { + "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": "EventConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "BoardEpic", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Epic", + "ofType": null + } + ] + }, + { "kind": "INPUT_OBJECT", "name": "ExportRequirementsInput", "description": "Autogenerated input type of ExportRequirements", @@ -26739,6 +29192,24 @@ "defaultValue": null }, { + "name": "selectedFields", + "description": "List of selected requirements fields to be exported.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "type": { @@ -26813,7 +29284,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of when the issue was created", + "description": "Timestamp of when the issue was created.", "args": [ ], @@ -26827,7 +29298,7 @@ }, { "name": "externalTracker", - "description": "Type of external tracker", + "description": "Type of external tracker.", "args": [ ], @@ -26841,7 +29312,7 @@ }, { "name": "relativeReference", - "description": "Relative reference of the issue in the external tracker", + "description": "Relative reference of the issue in the external tracker.", "args": [ ], @@ -26855,7 +29326,7 @@ }, { "name": "status", - "description": "Status of the issue in the external tracker", + "description": "Status of the issue in the external tracker.", "args": [ ], @@ -26869,7 +29340,7 @@ }, { "name": "title", - "description": "Title of the issue in the external tracker", + "description": "Title of the issue in the external tracker.", "args": [ ], @@ -26883,7 +29354,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the issue was updated", + "description": "Timestamp of when the issue was updated.", "args": [ ], @@ -26897,7 +29368,7 @@ }, { "name": "webUrl", - "description": "URL to the issue in the external tracker", + "description": "URL to the issue in the external tracker.", "args": [ ], @@ -26934,7 +29405,7 @@ "fields": [ { "name": "containerRepositoriesMaxCapacity", - "description": "The maximum concurrency of container repository sync for this secondary node", + "description": "The maximum concurrency of container repository sync for this secondary node.", "args": [ ], @@ -26948,7 +29419,7 @@ }, { "name": "enabled", - "description": "Indicates whether this Geo node is enabled", + "description": "Indicates whether this Geo node is enabled.", "args": [ ], @@ -26962,7 +29433,7 @@ }, { "name": "filesMaxCapacity", - "description": "The maximum concurrency of LFS/attachment backfill for this secondary node", + "description": "The maximum concurrency of LFS/attachment backfill for this secondary node.", "args": [ ], @@ -26976,7 +29447,7 @@ }, { "name": "id", - "description": "ID of this GeoNode", + "description": "ID of this GeoNode.", "args": [ ], @@ -26994,7 +29465,7 @@ }, { "name": "internalUrl", - "description": "The URL defined on the primary node that secondary nodes should use to contact it", + "description": "The URL defined on the primary node that secondary nodes should use to contact it.", "args": [ ], @@ -27008,7 +29479,7 @@ }, { "name": "mergeRequestDiffRegistries", - "description": "Find merge request diff registries on this Geo node", + "description": "Find merge request diff registries on this Geo node.", "args": [ { "name": "ids", @@ -27079,7 +29550,7 @@ }, { "name": "minimumReverificationInterval", - "description": "The interval (in days) in which the repository verification is valid. Once expired, it will be reverified", + "description": "The interval (in days) in which the repository verification is valid. Once expired, it will be reverified.", "args": [ ], @@ -27093,7 +29564,7 @@ }, { "name": "name", - "description": "The unique identifier for this Geo node", + "description": "The unique identifier for this Geo node.", "args": [ ], @@ -27107,7 +29578,7 @@ }, { "name": "packageFileRegistries", - "description": "Package file registries of the GeoNode", + "description": "Package file registries of the GeoNode.", "args": [ { "name": "ids", @@ -27178,7 +29649,7 @@ }, { "name": "primary", - "description": "Indicates whether this Geo node is the primary", + "description": "Indicates whether this Geo node is the primary.", "args": [ ], @@ -27192,7 +29663,7 @@ }, { "name": "reposMaxCapacity", - "description": "The maximum concurrency of repository backfill for this secondary node", + "description": "The maximum concurrency of repository backfill for this secondary node.", "args": [ ], @@ -27206,7 +29677,7 @@ }, { "name": "selectiveSyncNamespaces", - "description": "The namespaces that should be synced, if `selective_sync_type` == `namespaces`", + "description": "The namespaces that should be synced, if `selective_sync_type` == `namespaces`.", "args": [ { "name": "after", @@ -27259,7 +29730,7 @@ }, { "name": "selectiveSyncShards", - "description": "The repository storages whose projects should be synced, if `selective_sync_type` == `shards`", + "description": "The repository storages whose projects should be synced, if `selective_sync_type` == `shards`.", "args": [ ], @@ -27281,7 +29752,7 @@ }, { "name": "selectiveSyncType", - "description": "Indicates if syncing is limited to only specific groups, or shards", + "description": "Indicates if syncing is limited to only specific groups, or shards.", "args": [ ], @@ -27295,7 +29766,7 @@ }, { "name": "snippetRepositoryRegistries", - "description": "Find snippet repository registries on this Geo node", + "description": "Find snippet repository registries on this Geo node.", "args": [ { "name": "ids", @@ -27366,7 +29837,7 @@ }, { "name": "syncObjectStorage", - "description": "Indicates if this secondary node will replicate blobs in Object Storage", + "description": "Indicates if this secondary node will replicate blobs in Object Storage.", "args": [ ], @@ -27380,7 +29851,7 @@ }, { "name": "terraformStateVersionRegistries", - "description": "Find terraform state version registries on this Geo node", + "description": "Find terraform state version registries on this Geo node.", "args": [ { "name": "ids", @@ -27451,7 +29922,7 @@ }, { "name": "url", - "description": "The user-facing URL for this Geo node", + "description": "The user-facing URL for this Geo node.", "args": [ ], @@ -27465,7 +29936,7 @@ }, { "name": "verificationMaxCapacity", - "description": "The maximum concurrency of repository verification for this secondary node", + "description": "The maximum concurrency of repository verification for this secondary node.", "args": [ ], @@ -27488,7 +29959,7 @@ { "kind": "SCALAR", "name": "GitlabErrorTrackingDetailedErrorID", - "description": "Identifier of Gitlab::ErrorTracking::DetailedError", + "description": "Identifier of Gitlab::ErrorTracking::DetailedError.", "fields": null, "inputFields": null, "interfaces": null, @@ -27496,13 +29967,101 @@ "possibleTypes": null }, { + "kind": "INPUT_OBJECT", + "name": "GitlabSubscriptionActivateInput", + "description": "Autogenerated input type of GitlabSubscriptionActivate", + "fields": null, + "inputFields": [ + { + "name": "activationCode", + "description": "Activation code received after purchasing a GitLab subscription.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "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": "GitlabSubscriptionActivatePayload", + "description": "Autogenerated return type of GitlabSubscriptionActivate", + "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": "Errors encountered during execution of the mutation.", + "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 + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "OBJECT", "name": "GrafanaIntegration", "description": null, "fields": [ { "name": "createdAt", - "description": "Timestamp of the issue's creation", + "description": "Timestamp of the issue's creation.", "args": [ ], @@ -27520,7 +30079,7 @@ }, { "name": "enabled", - "description": "Indicates whether Grafana integration is enabled", + "description": "Indicates whether Grafana integration is enabled.", "args": [ ], @@ -27538,7 +30097,7 @@ }, { "name": "grafanaUrl", - "description": "URL for the Grafana host for the Grafana integration", + "description": "URL for the Grafana host for the Grafana integration.", "args": [ ], @@ -27556,7 +30115,7 @@ }, { "name": "id", - "description": "Internal ID of the Grafana integration", + "description": "Internal ID of the Grafana integration.", "args": [ ], @@ -27574,7 +30133,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of the issue's last activity", + "description": "Timestamp of the issue's last activity.", "args": [ ], @@ -27605,7 +30164,7 @@ "fields": [ { "name": "actualRepositorySizeLimit", - "description": "Size limit for repositories in the namespace in bytes", + "description": "Size limit for repositories in the namespace in bytes.", "args": [ ], @@ -27619,7 +30178,7 @@ }, { "name": "additionalPurchasedStorageSize", - "description": "Additional storage purchased for the root namespace in bytes", + "description": "Additional storage purchased for the root namespace in bytes.", "args": [ ], @@ -27633,7 +30192,7 @@ }, { "name": "autoDevopsEnabled", - "description": "Indicates whether Auto DevOps is enabled for all projects within this group", + "description": "Indicates whether Auto DevOps is enabled for all projects within this group.", "args": [ ], @@ -27647,7 +30206,7 @@ }, { "name": "avatarUrl", - "description": "Avatar URL of the group", + "description": "Avatar URL of the group.", "args": [ ], @@ -27661,7 +30220,7 @@ }, { "name": "board", - "description": "A single board of the group", + "description": "A single board of the group.", "args": [ { "name": "id", @@ -27688,7 +30247,7 @@ }, { "name": "boards", - "description": "Boards of the group", + "description": "Boards of the group.", "args": [ { "name": "id", @@ -27751,7 +30310,7 @@ }, { "name": "codeCoverageActivities", - "description": "Represents the code coverage activity for this group", + "description": "Represents the code coverage activity for this group.", "args": [ { "name": "startDate", @@ -27881,7 +30440,7 @@ }, { "name": "containerRepositories", - "description": "Container repositories of the group", + "description": "Container repositories of the group.", "args": [ { "name": "name", @@ -27894,6 +30453,16 @@ "defaultValue": null }, { + "name": "sort", + "description": "Sort container repositories by this criteria.", + "type": { + "kind": "ENUM", + "name": "ContainerRepositorySort", + "ofType": null + }, + "defaultValue": "created_desc" + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -27944,7 +30513,7 @@ }, { "name": "containerRepositoriesCount", - "description": "Number of container repositories in the group", + "description": "Number of container repositories in the group.", "args": [ ], @@ -27962,7 +30531,7 @@ }, { "name": "containsLockedProjects", - "description": "Includes at least one project where the repository size exceeds the limit", + "description": "Includes at least one project where the repository size exceeds the limit.", "args": [ ], @@ -27980,7 +30549,7 @@ }, { "name": "customEmoji", - "description": "Custom emoji within this namespace Available only when feature flag `custom_emoji` is enabled.", + "description": "Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled.", "args": [ { "name": "after", @@ -28033,7 +30602,7 @@ }, { "name": "description", - "description": "Description of the namespace", + "description": "Description of the namespace.", "args": [ ], @@ -28061,7 +30630,7 @@ }, { "name": "emailsDisabled", - "description": "Indicates if a group has email notifications disabled", + "description": "Indicates if a group has email notifications disabled.", "args": [ ], @@ -28075,7 +30644,7 @@ }, { "name": "epic", - "description": "Find a single epic", + "description": "Find a single epic.", "args": [ { "name": "startDate", @@ -28244,7 +30813,7 @@ }, { "name": "epicBoard", - "description": "Find a single epic board", + "description": "Find a single epic board.", "args": [ { "name": "id", @@ -28271,7 +30840,7 @@ }, { "name": "epicBoards", - "description": "Find epic boards", + "description": "Find epic boards.", "args": [ { "name": "after", @@ -28324,7 +30893,7 @@ }, { "name": "epics", - "description": "Find epics", + "description": "Find epics.", "args": [ { "name": "startDate", @@ -28547,7 +31116,7 @@ }, { "name": "fullName", - "description": "Full name of the namespace", + "description": "Full name of the namespace.", "args": [ ], @@ -28565,7 +31134,7 @@ }, { "name": "fullPath", - "description": "Full path of the namespace", + "description": "Full path of the namespace.", "args": [ ], @@ -28583,7 +31152,7 @@ }, { "name": "groupMembers", - "description": "A membership of a user within this group", + "description": "A membership of a user within this group.", "args": [ { "name": "search", @@ -28678,7 +31247,7 @@ }, { "name": "id", - "description": "ID of the namespace", + "description": "ID of the namespace.", "args": [ ], @@ -28696,7 +31265,7 @@ }, { "name": "isTemporaryStorageIncreaseEnabled", - "description": "Status of the temporary storage increase", + "description": "Status of the temporary storage increase.", "args": [ ], @@ -28714,7 +31283,7 @@ }, { "name": "issues", - "description": "Issues for projects in this group", + "description": "Issues for projects in this group.", "args": [ { "name": "iid", @@ -29013,7 +31582,7 @@ }, { "name": "iterations", - "description": "Find iterations", + "description": "Find iterations.", "args": [ { "name": "startDate", @@ -29146,11 +31715,11 @@ }, { "name": "label", - "description": "A label available on this group", + "description": "A label available on this group.", "args": [ { "name": "title", - "description": "Title of the label", + "description": "Title of the label.", "type": { "kind": "NON_NULL", "name": null, @@ -29173,9 +31742,49 @@ }, { "name": "labels", - "description": "Labels available on this group", + "description": "Labels available on this group.", "args": [ { + "name": "searchTerm", + "description": "A search term to find labels with.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeAncestorGroups", + "description": "Include labels from ancestor groups.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "includeDescendantGroups", + "description": "Include labels from descendant groups.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "onlyGroupLabels", + "description": "Include only group level labels.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -29214,16 +31823,6 @@ "ofType": null }, "defaultValue": null - }, - { - "name": "searchTerm", - "description": "A search term to find labels with", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null } ], "type": { @@ -29236,7 +31835,7 @@ }, { "name": "lfsEnabled", - "description": "Indicates if Large File Storage (LFS) is enabled for namespace", + "description": "Indicates if Large File Storage (LFS) is enabled for namespace.", "args": [ ], @@ -29250,7 +31849,7 @@ }, { "name": "mentionsDisabled", - "description": "Indicates if a group is disabled from getting mentioned", + "description": "Indicates if a group is disabled from getting mentioned.", "args": [ ], @@ -29264,7 +31863,7 @@ }, { "name": "mergeRequests", - "description": "Merge requests for projects in this group", + "description": "Merge requests for projects in this group.", "args": [ { "name": "iids", @@ -29469,7 +32068,7 @@ }, { "name": "milestones", - "description": "Milestones of the group", + "description": "Milestones of the group.", "args": [ { "name": "startDate", @@ -29620,7 +32219,7 @@ }, { "name": "name", - "description": "Name of the namespace", + "description": "Name of the namespace.", "args": [ ], @@ -29638,7 +32237,7 @@ }, { "name": "packageSettings", - "description": "The package settings for the namespace", + "description": "The package settings for the namespace.", "args": [ ], @@ -29652,7 +32251,7 @@ }, { "name": "parent", - "description": "Parent group", + "description": "Parent group.", "args": [ ], @@ -29666,7 +32265,7 @@ }, { "name": "path", - "description": "Path of the namespace", + "description": "Path of the namespace.", "args": [ ], @@ -29684,7 +32283,7 @@ }, { "name": "projectCreationLevel", - "description": "The permission level required to create projects in the group", + "description": "The permission level required to create projects in the group.", "args": [ ], @@ -29698,7 +32297,7 @@ }, { "name": "projects", - "description": "Projects within this namespace", + "description": "Projects within this namespace.", "args": [ { "name": "includeSubgroups", @@ -29795,7 +32394,7 @@ }, { "name": "repositorySizeExcessProjectCount", - "description": "Number of projects in the root namespace where the repository size exceeds the limit", + "description": "Number of projects in the root namespace where the repository size exceeds the limit.", "args": [ ], @@ -29813,7 +32412,7 @@ }, { "name": "requestAccessEnabled", - "description": "Indicates if users can request access to namespace", + "description": "Indicates if users can request access to namespace.", "args": [ ], @@ -29827,7 +32426,7 @@ }, { "name": "requireTwoFactorAuthentication", - "description": "Indicates if all users in this group are required to set up two-factor authentication", + "description": "Indicates if all users in this group are required to set up two-factor authentication.", "args": [ ], @@ -29841,7 +32440,7 @@ }, { "name": "rootStorageStatistics", - "description": "Aggregated storage statistics of the namespace. Only available for root namespaces", + "description": "Aggregated storage statistics of the namespace. Only available for root namespaces.", "args": [ ], @@ -29855,7 +32454,7 @@ }, { "name": "shareWithGroupLock", - "description": "Indicates if sharing a project with another group within this group is prevented", + "description": "Indicates if sharing a project with another group within this group is prevented.", "args": [ ], @@ -29869,7 +32468,7 @@ }, { "name": "stats", - "description": "Group statistics", + "description": "Group statistics.", "args": [ ], @@ -29883,7 +32482,7 @@ }, { "name": "storageSizeLimit", - "description": "Total storage limit of the root namespace in bytes", + "description": "Total storage limit of the root namespace in bytes.", "args": [ ], @@ -29897,7 +32496,7 @@ }, { "name": "subgroupCreationLevel", - "description": "The permission level required to create subgroups within the group", + "description": "The permission level required to create subgroups within the group.", "args": [ ], @@ -29911,7 +32510,7 @@ }, { "name": "temporaryStorageIncreaseEndsOn", - "description": "Date until the temporary storage increase is active", + "description": "Date until the temporary storage increase is active.", "args": [ ], @@ -29925,7 +32524,7 @@ }, { "name": "timelogs", - "description": "Time logged in issues by group members", + "description": "Time logged in issues by group members.", "args": [ { "name": "startDate", @@ -30022,7 +32621,7 @@ }, { "name": "totalRepositorySize", - "description": "Total repository size of all projects in the root namespace in bytes", + "description": "Total repository size of all projects in the root namespace in bytes.", "args": [ ], @@ -30036,7 +32635,7 @@ }, { "name": "totalRepositorySizeExcess", - "description": "Total excess repository size of all projects in the root namespace in bytes", + "description": "Total excess repository size of all projects in the root namespace in bytes.", "args": [ ], @@ -30050,7 +32649,7 @@ }, { "name": "twoFactorGracePeriod", - "description": "Time before two-factor authentication is enforced", + "description": "Time before two-factor authentication is enforced.", "args": [ ], @@ -30082,7 +32681,7 @@ }, { "name": "visibility", - "description": "Visibility of the namespace", + "description": "Visibility of the namespace.", "args": [ ], @@ -30096,7 +32695,7 @@ }, { "name": "vulnerabilities", - "description": "Vulnerabilities reported on the projects in the group and its subgroups", + "description": "Vulnerabilities reported on the projects in the group and its subgroups.", "args": [ { "name": "projectId", @@ -30269,7 +32868,7 @@ }, { "name": "vulnerabilitiesCountByDay", - "description": "Number of vulnerabilities per day for the projects in the group and its subgroups", + "description": "Number of vulnerabilities per day for the projects in the group and its subgroups.", "args": [ { "name": "startDate", @@ -30350,7 +32949,7 @@ }, { "name": "vulnerabilitiesCountByDayAndSeverity", - "description": "Number of vulnerabilities per severity level, per day, for the projects in the group and its subgroups Deprecated in 13.3: Use `vulnerabilitiesCountByDay`.", + "description": "Number of vulnerabilities per severity level, per day, for the projects in the group and its subgroups. Deprecated in 13.3: Use `vulnerabilitiesCountByDay`.", "args": [ { "name": "startDate", @@ -30431,7 +33030,7 @@ }, { "name": "vulnerabilityGrades", - "description": "Represents vulnerable project counts for each grade", + "description": "Represents vulnerable project counts for each grade.", "args": [ { "name": "includeSubgroups", @@ -30466,7 +33065,7 @@ }, { "name": "vulnerabilityScanners", - "description": "Vulnerability scanners reported on the project vulnerabilties of the group and its subgroups", + "description": "Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups.", "args": [ { "name": "after", @@ -30519,7 +33118,7 @@ }, { "name": "vulnerabilitySeveritiesCount", - "description": "Counts for each vulnerability severity in the group and its subgroups", + "description": "Counts for each vulnerability severity in the group and its subgroups.", "args": [ { "name": "projectId", @@ -30622,7 +33221,7 @@ }, { "name": "webUrl", - "description": "Web URL of the group", + "description": "Web URL of the group.", "args": [ ], @@ -30649,7 +33248,7 @@ { "kind": "SCALAR", "name": "GroupID", - "description": "Identifier of Group", + "description": "Identifier of Group.", "fields": null, "inputFields": null, "interfaces": null, @@ -30663,7 +33262,7 @@ "fields": [ { "name": "accessLevel", - "description": "GitLab::Access level", + "description": "GitLab::Access level.", "args": [ ], @@ -30677,7 +33276,7 @@ }, { "name": "createdAt", - "description": "Date and time the membership was created", + "description": "Date and time the membership was created.", "args": [ ], @@ -30691,7 +33290,7 @@ }, { "name": "createdBy", - "description": "User that authorized membership", + "description": "User that authorized membership.", "args": [ ], @@ -30705,7 +33304,7 @@ }, { "name": "expiresAt", - "description": "Date and time the membership expires", + "description": "Date and time the membership expires.", "args": [ ], @@ -30719,7 +33318,7 @@ }, { "name": "group", - "description": "Group that a User is a member of", + "description": "Group that a User is a member of.", "args": [ ], @@ -30733,7 +33332,7 @@ }, { "name": "id", - "description": "ID of the member", + "description": "ID of the member.", "args": [ ], @@ -30751,7 +33350,7 @@ }, { "name": "updatedAt", - "description": "Date and time the membership was last updated", + "description": "Date and time the membership was last updated.", "args": [ ], @@ -30765,7 +33364,7 @@ }, { "name": "user", - "description": "User that is associated with the member object", + "description": "User that is associated with the member object.", "args": [ ], @@ -31031,7 +33630,7 @@ "fields": [ { "name": "releaseStats", - "description": "Statistics related to releases within the group", + "description": "Statistics related to releases within the group.", "args": [ ], @@ -31483,6 +34082,34 @@ "defaultValue": null }, { + "name": "payloadExample", + "description": "The example of an alert payload.", + "type": { + "kind": "SCALAR", + "name": "JsonString", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "payloadAttributeMappings", + "description": "The custom mapping of GitLab alert attributes to fields from the payload_example.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AlertManagementPayloadAlertFieldInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "type": { @@ -31587,7 +34214,7 @@ { "kind": "SCALAR", "name": "IncidentManagementOncallParticipantID", - "description": "Identifier of IncidentManagement::OncallParticipant", + "description": "Identifier of IncidentManagement::OncallParticipant.", "fields": null, "inputFields": null, "interfaces": null, @@ -31717,6 +34344,87 @@ "deprecationReason": null }, { + "name": "shifts", + "description": "Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month.", + "args": [ + { + "name": "startTime", + "description": "Start of timeframe to include shifts for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "endTime", + "description": "End of timeframe to include shifts for. Cannot exceed one month after start.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "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": "IncidentManagementOncallShiftConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "startsAt", "description": "Start date of the on-call rotation.", "args": [ @@ -31853,7 +34561,7 @@ { "kind": "SCALAR", "name": "IncidentManagementOncallRotationID", - "description": "Identifier of IncidentManagement::OncallRotation", + "description": "Identifier of IncidentManagement::OncallRotation.", "fields": null, "inputFields": null, "interfaces": null, @@ -31867,7 +34575,7 @@ "fields": [ { "name": "description", - "description": "Description of the on-call schedule", + "description": "Description of the on-call schedule.", "args": [ ], @@ -31881,7 +34589,7 @@ }, { "name": "iid", - "description": "Internal ID of the on-call schedule", + "description": "Internal ID of the on-call schedule.", "args": [ ], @@ -31899,7 +34607,7 @@ }, { "name": "name", - "description": "Name of the on-call schedule", + "description": "Name of the on-call schedule.", "args": [ ], @@ -31917,7 +34625,7 @@ }, { "name": "rotations", - "description": "On-call rotations for the on-call schedule", + "description": "On-call rotations for the on-call schedule.", "args": [ { "name": "after", @@ -31974,7 +34682,7 @@ }, { "name": "timezone", - "description": "Time zone of the on-call schedule", + "description": "Time zone of the on-call schedule.", "args": [ ], @@ -32112,12 +34820,179 @@ }, { "kind": "OBJECT", + "name": "IncidentManagementOncallShift", + "description": "A block of time for which a participant is on-call.", + "fields": [ + { + "name": "endsAt", + "description": "End time of the on-call shift.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "participant", + "description": "Participant assigned to the on-call shift.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "OncallParticipantType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startsAt", + "description": "Start time of the on-call shift.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "IncidentManagementOncallShiftConnection", + "description": "The connection type for IncidentManagementOncallShift.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "IncidentManagementOncallShiftEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "IncidentManagementOncallShift", + "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": "IncidentManagementOncallShiftEdge", + "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": "IncidentManagementOncallShift", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "InstanceSecurityDashboard", "description": null, "fields": [ { "name": "projects", - "description": "Projects selected in Instance Security Dashboard", + "description": "Projects selected in Instance Security Dashboard.", "args": [ { "name": "after", @@ -32174,7 +35049,7 @@ }, { "name": "vulnerabilityGrades", - "description": "Represents vulnerable project counts for each grade", + "description": "Represents vulnerable project counts for each grade.", "args": [ ], @@ -32200,7 +35075,7 @@ }, { "name": "vulnerabilityScanners", - "description": "Vulnerability scanners reported on the vulnerabilties from projects selected in Instance Security Dashboard", + "description": "Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard.", "args": [ { "name": "after", @@ -32253,7 +35128,7 @@ }, { "name": "vulnerabilitySeveritiesCount", - "description": "Counts for each vulnerability severity from projects selected in Instance Security Dashboard", + "description": "Counts for each vulnerability severity from projects selected in Instance Security Dashboard.", "args": [ { "name": "projectId", @@ -32369,7 +35244,7 @@ "fields": [ { "name": "count", - "description": "Object count", + "description": "Object count.", "args": [ ], @@ -32387,7 +35262,7 @@ }, { "name": "identifier", - "description": "The type of objects being measured", + "description": "The type of objects being measured.", "args": [ ], @@ -32405,7 +35280,7 @@ }, { "name": "recordedAt", - "description": "The time the measurement was recorded", + "description": "The time the measurement was recorded.", "args": [ ], @@ -32630,7 +35505,7 @@ "fields": [ { "name": "alertManagementAlert", - "description": "Alert associated to this issue", + "description": "Alert associated to this issue.", "args": [ ], @@ -32644,7 +35519,7 @@ }, { "name": "assignees", - "description": "Assignees of the issue", + "description": "Assignees of the issue.", "args": [ { "name": "after", @@ -32697,7 +35572,7 @@ }, { "name": "author", - "description": "User that created the issue", + "description": "User that created the issue.", "args": [ ], @@ -32747,7 +35622,7 @@ }, { "name": "closedAt", - "description": "Timestamp of when the issue was closed", + "description": "Timestamp of when the issue was closed.", "args": [ ], @@ -32761,7 +35636,7 @@ }, { "name": "confidential", - "description": "Indicates the issue is confidential", + "description": "Indicates the issue is confidential.", "args": [ ], @@ -32779,7 +35654,7 @@ }, { "name": "createNoteEmail", - "description": "User specific email address for the issue", + "description": "User specific email address for the issue.", "args": [ ], @@ -32793,7 +35668,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the issue was created", + "description": "Timestamp of when the issue was created.", "args": [ ], @@ -32811,7 +35686,7 @@ }, { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -32855,7 +35730,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -32878,7 +35753,7 @@ }, { "name": "description", - "description": "Description of the issue", + "description": "Description of the issue.", "args": [ ], @@ -32906,7 +35781,7 @@ }, { "name": "designCollection", - "description": "Collection of design images associated with this issue", + "description": "Collection of design images associated with this issue.", "args": [ ], @@ -32920,7 +35795,7 @@ }, { "name": "discussionLocked", - "description": "Indicates discussion is locked on the issue", + "description": "Indicates discussion is locked on the issue.", "args": [ ], @@ -32938,7 +35813,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -32995,7 +35870,7 @@ }, { "name": "downvotes", - "description": "Number of downvotes the issue has received", + "description": "Number of downvotes the issue has received.", "args": [ ], @@ -33013,7 +35888,7 @@ }, { "name": "dueDate", - "description": "Due date of the issue", + "description": "Due date of the issue.", "args": [ ], @@ -33027,7 +35902,7 @@ }, { "name": "emailsDisabled", - "description": "Indicates if a project has email notifications disabled: `true` if email notifications are disabled", + "description": "Indicates if a project has email notifications disabled: `true` if email notifications are disabled.", "args": [ ], @@ -33073,7 +35948,7 @@ }, { "name": "humanTimeEstimate", - "description": "Human-readable time estimate of the issue", + "description": "Human-readable time estimate of the issue.", "args": [ ], @@ -33087,7 +35962,7 @@ }, { "name": "humanTotalTimeSpent", - "description": "Human-readable total time reported as spent on the issue", + "description": "Human-readable total time reported as spent on the issue.", "args": [ ], @@ -33101,7 +35976,7 @@ }, { "name": "id", - "description": "ID of the issue", + "description": "ID of the issue.", "args": [ ], @@ -33119,7 +35994,7 @@ }, { "name": "iid", - "description": "Internal ID of the issue", + "description": "Internal ID of the issue.", "args": [ ], @@ -33151,7 +36026,7 @@ }, { "name": "labels", - "description": "Labels of the issue", + "description": "Labels of the issue.", "args": [ { "name": "after", @@ -33226,7 +36101,7 @@ }, { "name": "milestone", - "description": "Milestone of the issue", + "description": "Milestone of the issue.", "args": [ ], @@ -33240,7 +36115,7 @@ }, { "name": "moved", - "description": "Indicates if issue got moved from other project", + "description": "Indicates if issue got moved from other project.", "args": [ ], @@ -33254,7 +36129,7 @@ }, { "name": "movedTo", - "description": "Updated Issue after it got moved to another project", + "description": "Updated Issue after it got moved to another project.", "args": [ ], @@ -33268,7 +36143,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -33325,7 +36200,7 @@ }, { "name": "participants", - "description": "List of participants in the issue", + "description": "List of participants in the issue.", "args": [ { "name": "after", @@ -33378,11 +36253,11 @@ }, { "name": "reference", - "description": "Internal reference of the issue. Returned in shortened format by default", + "description": "Internal reference of the issue. Returned in shortened format by default.", "args": [ { "name": "full", - "description": "Boolean option specifying whether the reference should be returned in full", + "description": "Boolean option specifying whether the reference should be returned in full.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -33405,7 +36280,7 @@ }, { "name": "relativePosition", - "description": "Relative position of the issue (used for positioning in epic tree and issue boards)", + "description": "Relative position of the issue (used for positioning in epic tree and issue boards).", "args": [ ], @@ -33419,7 +36294,7 @@ }, { "name": "severity", - "description": "Severity level of the incident", + "description": "Severity level of the incident.", "args": [ ], @@ -33447,7 +36322,7 @@ }, { "name": "state", - "description": "State of the issue", + "description": "State of the issue.", "args": [ ], @@ -33479,7 +36354,7 @@ }, { "name": "subscribed", - "description": "Indicates the currently logged in user is subscribed to the issue", + "description": "Indicates the currently logged in user is subscribed to the issue.", "args": [ ], @@ -33497,7 +36372,7 @@ }, { "name": "taskCompletionStatus", - "description": "Task completion status of the issue", + "description": "Task completion status of the issue.", "args": [ ], @@ -33515,7 +36390,7 @@ }, { "name": "timeEstimate", - "description": "Time estimate of the issue", + "description": "Time estimate of the issue.", "args": [ ], @@ -33533,7 +36408,7 @@ }, { "name": "title", - "description": "Title of the issue", + "description": "Title of the issue.", "args": [ ], @@ -33565,7 +36440,7 @@ }, { "name": "totalTimeSpent", - "description": "Total time reported as spent on the issue", + "description": "Total time reported as spent on the issue.", "args": [ ], @@ -33583,7 +36458,7 @@ }, { "name": "type", - "description": "Type of the issue", + "description": "Type of the issue.", "args": [ ], @@ -33597,7 +36472,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the issue was last updated", + "description": "Timestamp of when the issue was last updated.", "args": [ ], @@ -33615,7 +36490,7 @@ }, { "name": "updatedBy", - "description": "User that last updated the issue", + "description": "User that last updated the issue.", "args": [ ], @@ -33629,7 +36504,7 @@ }, { "name": "upvotes", - "description": "Number of upvotes the issue has received", + "description": "Number of upvotes the issue has received.", "args": [ ], @@ -33647,7 +36522,7 @@ }, { "name": "userDiscussionsCount", - "description": "Number of user discussions in the issue", + "description": "Number of user discussions in the issue.", "args": [ ], @@ -33665,7 +36540,7 @@ }, { "name": "userNotesCount", - "description": "Number of user notes of the issue", + "description": "Number of user notes of the issue.", "args": [ ], @@ -33701,7 +36576,7 @@ }, { "name": "webPath", - "description": "Web path of the issue", + "description": "Web path of the issue.", "args": [ ], @@ -33719,7 +36594,7 @@ }, { "name": "webUrl", - "description": "Web URL of the issue", + "description": "Web URL of the issue.", "args": [ ], @@ -33773,7 +36648,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -33845,7 +36720,7 @@ }, { "name": "weight", - "description": "Total weight of issues collection", + "description": "Total weight of issues collection.", "args": [ ], @@ -33917,7 +36792,7 @@ { "kind": "SCALAR", "name": "IssueID", - "description": "Identifier of Issue", + "description": "Identifier of Issue.", "fields": null, "inputFields": null, "interfaces": null, @@ -35881,7 +38756,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of iteration creation", + "description": "Timestamp of iteration creation.", "args": [ ], @@ -35899,7 +38774,7 @@ }, { "name": "description", - "description": "Description of the iteration", + "description": "Description of the iteration.", "args": [ ], @@ -35927,7 +38802,7 @@ }, { "name": "dueDate", - "description": "Timestamp of the iteration due date", + "description": "Timestamp of the iteration due date.", "args": [ ], @@ -35941,7 +38816,7 @@ }, { "name": "id", - "description": "ID of the iteration", + "description": "ID of the iteration.", "args": [ ], @@ -35959,7 +38834,7 @@ }, { "name": "iid", - "description": "Internal ID of the iteration", + "description": "Internal ID of the iteration.", "args": [ ], @@ -35977,7 +38852,7 @@ }, { "name": "report", - "description": "Historically accurate report about the timebox", + "description": "Historically accurate report about the timebox.", "args": [ ], @@ -35991,7 +38866,7 @@ }, { "name": "scopedPath", - "description": "Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts", + "description": "Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.", "args": [ ], @@ -36005,7 +38880,7 @@ }, { "name": "scopedUrl", - "description": "Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts", + "description": "Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts.", "args": [ ], @@ -36019,7 +38894,7 @@ }, { "name": "startDate", - "description": "Timestamp of the iteration start date", + "description": "Timestamp of the iteration start date.", "args": [ ], @@ -36033,7 +38908,7 @@ }, { "name": "state", - "description": "State of the iteration", + "description": "State of the iteration.", "args": [ ], @@ -36051,7 +38926,7 @@ }, { "name": "title", - "description": "Title of the iteration", + "description": "Title of the iteration.", "args": [ ], @@ -36069,7 +38944,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of last iteration update", + "description": "Timestamp of last iteration update.", "args": [ ], @@ -36087,7 +38962,7 @@ }, { "name": "webPath", - "description": "Web path of the iteration", + "description": "Web path of the iteration.", "args": [ ], @@ -36105,7 +38980,7 @@ }, { "name": "webUrl", - "description": "Web URL of the iteration", + "description": "Web URL of the iteration.", "args": [ ], @@ -36248,7 +39123,7 @@ { "kind": "SCALAR", "name": "IterationID", - "description": "Identifier of Iteration", + "description": "Identifier of Iteration.", "fields": null, "inputFields": null, "interfaces": null, @@ -36342,7 +39217,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of when the Jira import was created", + "description": "Timestamp of when the Jira import was created.", "args": [ ], @@ -36356,7 +39231,7 @@ }, { "name": "failedToImportCount", - "description": "Count of issues that failed to import", + "description": "Count of issues that failed to import.", "args": [ ], @@ -36374,7 +39249,7 @@ }, { "name": "importedIssuesCount", - "description": "Count of issues that were successfully imported", + "description": "Count of issues that were successfully imported.", "args": [ ], @@ -36392,7 +39267,7 @@ }, { "name": "jiraProjectKey", - "description": "Project key for the imported Jira project", + "description": "Project key for the imported Jira project.", "args": [ ], @@ -36410,7 +39285,7 @@ }, { "name": "scheduledAt", - "description": "Timestamp of when the Jira import was scheduled", + "description": "Timestamp of when the Jira import was scheduled.", "args": [ ], @@ -36424,7 +39299,7 @@ }, { "name": "scheduledBy", - "description": "User that started the Jira import", + "description": "User that started the Jira import.", "args": [ ], @@ -36438,7 +39313,7 @@ }, { "name": "totalIssueCount", - "description": "Total count of issues that were attempted to import", + "description": "Total count of issues that were attempted to import.", "args": [ ], @@ -36845,7 +39720,7 @@ "fields": [ { "name": "key", - "description": "Key of the Jira project", + "description": "Key of the Jira project.", "args": [ ], @@ -36863,7 +39738,7 @@ }, { "name": "name", - "description": "Name of the Jira project", + "description": "Name of the Jira project.", "args": [ ], @@ -36877,7 +39752,7 @@ }, { "name": "projectId", - "description": "ID of the Jira project", + "description": "ID of the Jira project.", "args": [ ], @@ -37020,7 +39895,7 @@ "fields": [ { "name": "active", - "description": "Indicates if the service is active", + "description": "Indicates if the service is active.", "args": [ ], @@ -37034,7 +39909,7 @@ }, { "name": "projects", - "description": "List of all Jira projects fetched through Jira REST API", + "description": "List of all Jira projects fetched through Jira REST API.", "args": [ { "name": "name", @@ -37097,7 +39972,7 @@ }, { "name": "type", - "description": "Class name of the service", + "description": "Class name of the service.", "args": [ ], @@ -37128,7 +40003,7 @@ "fields": [ { "name": "gitlabId", - "description": "ID of the matched GitLab user", + "description": "ID of the matched GitLab user.", "args": [ ], @@ -37142,7 +40017,7 @@ }, { "name": "gitlabName", - "description": "Name of the matched GitLab user", + "description": "Name of the matched GitLab user.", "args": [ ], @@ -37156,7 +40031,7 @@ }, { "name": "gitlabUsername", - "description": "Username of the matched GitLab user", + "description": "Username of the matched GitLab user.", "args": [ ], @@ -37170,7 +40045,7 @@ }, { "name": "jiraAccountId", - "description": "Account ID of the Jira user", + "description": "Account ID of the Jira user.", "args": [ ], @@ -37188,7 +40063,7 @@ }, { "name": "jiraDisplayName", - "description": "Display name of the Jira user", + "description": "Display name of the Jira user.", "args": [ ], @@ -37206,7 +40081,7 @@ }, { "name": "jiraEmail", - "description": "Email of the Jira user, returned only for users with public emails", + "description": "Email of the Jira user, returned only for users with public emails.", "args": [ ], @@ -37234,7 +40109,7 @@ "inputFields": [ { "name": "jiraAccountId", - "description": "Jira account ID of the user", + "description": "Jira account ID of the user.", "type": { "kind": "NON_NULL", "name": null, @@ -37248,7 +40123,7 @@ }, { "name": "gitlabId", - "description": "Id of the GitLab user", + "description": "Id of the GitLab user.", "type": { "kind": "SCALAR", "name": "Int", @@ -37451,7 +40326,7 @@ "fields": [ { "name": "color", - "description": "Background color of the label", + "description": "Background color of the label.", "args": [ ], @@ -37469,7 +40344,7 @@ }, { "name": "description", - "description": "Description of the label (Markdown rendered as HTML for caching)", + "description": "Description of the label (Markdown rendered as HTML for caching).", "args": [ ], @@ -37497,7 +40372,7 @@ }, { "name": "id", - "description": "Label ID", + "description": "Label ID.", "args": [ ], @@ -37515,7 +40390,7 @@ }, { "name": "textColor", - "description": "Text color of the label", + "description": "Text color of the label.", "args": [ ], @@ -37533,7 +40408,7 @@ }, { "name": "title", - "description": "Content of the label", + "description": "Content of the label.", "args": [ ], @@ -37564,7 +40439,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -37650,7 +40525,7 @@ "inputFields": [ { "name": "projectPath", - "description": "The project full path the resource is associated with.", + "description": "Full path of the project with which the resource is associated.", "type": { "kind": "SCALAR", "name": "ID", @@ -37660,7 +40535,7 @@ }, { "name": "groupPath", - "description": "The group full path the resource is associated with.", + "description": "Full path of the group with which the resource is associated.", "type": { "kind": "SCALAR", "name": "ID", @@ -37700,7 +40575,7 @@ "name": "String", "ofType": null }, - "defaultValue": "\"#428BCA\"" + "defaultValue": "\"#6699cc\"" }, { "name": "clientMutationId", @@ -37832,7 +40707,7 @@ { "kind": "SCALAR", "name": "LabelID", - "description": "Identifier of Label", + "description": "Identifier of Label.", "fields": null, "inputFields": null, "interfaces": null, @@ -37842,7 +40717,7 @@ { "kind": "SCALAR", "name": "ListID", - "description": "Identifier of List", + "description": "Identifier of List.", "fields": null, "inputFields": null, "interfaces": null, @@ -38058,7 +40933,7 @@ "fields": [ { "name": "accessLevel", - "description": "GitLab::Access level", + "description": "GitLab::Access level.", "args": [ ], @@ -38072,7 +40947,7 @@ }, { "name": "createdAt", - "description": "Date and time the membership was created", + "description": "Date and time the membership was created.", "args": [ ], @@ -38086,7 +40961,7 @@ }, { "name": "createdBy", - "description": "User that authorized membership", + "description": "User that authorized membership.", "args": [ ], @@ -38100,7 +40975,7 @@ }, { "name": "expiresAt", - "description": "Date and time the membership expires", + "description": "Date and time the membership expires.", "args": [ ], @@ -38114,7 +40989,7 @@ }, { "name": "id", - "description": "ID of the member", + "description": "ID of the member.", "args": [ ], @@ -38132,7 +41007,7 @@ }, { "name": "updatedAt", - "description": "Date and time the membership was last updated", + "description": "Date and time the membership was last updated.", "args": [ ], @@ -38146,7 +41021,7 @@ }, { "name": "user", - "description": "User that is associated with the member object", + "description": "User that is associated with the member object.", "args": [ ], @@ -38298,7 +41173,7 @@ "fields": [ { "name": "allowCollaboration", - "description": "Indicates if members of the target project can push to the fork", + "description": "Indicates if members of the target project can push to the fork.", "args": [ ], @@ -38312,7 +41187,7 @@ }, { "name": "approvalsLeft", - "description": "Number of approvals left", + "description": "Number of approvals left.", "args": [ ], @@ -38326,7 +41201,7 @@ }, { "name": "approvalsRequired", - "description": "Number of approvals required", + "description": "Number of approvals required.", "args": [ ], @@ -38358,7 +41233,7 @@ }, { "name": "approvedBy", - "description": "Users who approved the merge request", + "description": "Users who approved the merge request.", "args": [ { "name": "after", @@ -38411,7 +41286,7 @@ }, { "name": "assignees", - "description": "Assignees of the merge request", + "description": "Assignees of the merge request.", "args": [ { "name": "after", @@ -38464,7 +41339,7 @@ }, { "name": "author", - "description": "User who created this merge request", + "description": "User who created this merge request.", "args": [ ], @@ -38478,7 +41353,7 @@ }, { "name": "autoMergeEnabled", - "description": "Indicates if auto merge is enabled for the merge request", + "description": "Indicates if auto merge is enabled for the merge request.", "args": [ ], @@ -38496,7 +41371,7 @@ }, { "name": "autoMergeStrategy", - "description": "Selected auto merge strategy", + "description": "Selected auto merge strategy.", "args": [ ], @@ -38510,7 +41385,7 @@ }, { "name": "availableAutoMergeStrategies", - "description": "Array of available auto merge strategies", + "description": "Array of available auto merge strategies.", "args": [ ], @@ -38532,7 +41407,7 @@ }, { "name": "commitCount", - "description": "Number of commits in the merge request", + "description": "Number of commits in the merge request.", "args": [ ], @@ -38546,7 +41421,7 @@ }, { "name": "commitsWithoutMergeCommits", - "description": "Merge request commits excluding merge commits", + "description": "Merge request commits excluding merge commits.", "args": [ { "name": "after", @@ -38599,7 +41474,7 @@ }, { "name": "conflicts", - "description": "Indicates if the merge request has conflicts", + "description": "Indicates if the merge request has conflicts.", "args": [ ], @@ -38617,7 +41492,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the merge request was created", + "description": "Timestamp of when the merge request was created.", "args": [ ], @@ -38635,7 +41510,7 @@ }, { "name": "currentUserTodos", - "description": "Todos for the current user", + "description": "To-do items for the current user.", "args": [ { "name": "after", @@ -38679,7 +41554,7 @@ }, { "name": "state", - "description": "State of the todos", + "description": "State of the to-do items.", "type": { "kind": "ENUM", "name": "TodoStateEnum", @@ -38702,7 +41577,7 @@ }, { "name": "defaultMergeCommitMessage", - "description": "Default merge commit message of the merge request", + "description": "Default merge commit message of the merge request.", "args": [ ], @@ -38716,7 +41591,7 @@ }, { "name": "defaultMergeCommitMessageWithDescription", - "description": "Default merge commit message of the merge request with description", + "description": "Default merge commit message of the merge request with description.", "args": [ ], @@ -38730,7 +41605,7 @@ }, { "name": "defaultSquashCommitMessage", - "description": "Default squash commit message of the merge request", + "description": "Default squash commit message of the merge request.", "args": [ ], @@ -38744,7 +41619,7 @@ }, { "name": "description", - "description": "Description of the merge request (Markdown rendered as HTML for caching)", + "description": "Description of the merge request (Markdown rendered as HTML for caching).", "args": [ ], @@ -38772,7 +41647,7 @@ }, { "name": "diffHeadSha", - "description": "Diff head SHA of the merge request", + "description": "Diff head SHA of the merge request.", "args": [ ], @@ -38786,7 +41661,7 @@ }, { "name": "diffRefs", - "description": "References of the base SHA, the head SHA, and the start SHA for this merge request", + "description": "References of the base SHA, the head SHA, and the start SHA for this merge request.", "args": [ ], @@ -38800,11 +41675,11 @@ }, { "name": "diffStats", - "description": "Details about which files were changed in this merge request", + "description": "Details about which files were changed in this merge request.", "args": [ { "name": "path", - "description": "A specific file-path", + "description": "A specific file-path.", "type": { "kind": "SCALAR", "name": "String", @@ -38831,7 +41706,7 @@ }, { "name": "diffStatsSummary", - "description": "Summary of which files were changed in this merge request", + "description": "Summary of which files were changed in this merge request.", "args": [ ], @@ -38845,7 +41720,7 @@ }, { "name": "discussionLocked", - "description": "Indicates if comments on the merge request are locked to members only", + "description": "Indicates if comments on the merge request are locked to members only.", "args": [ ], @@ -38863,7 +41738,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -38920,7 +41795,7 @@ }, { "name": "downvotes", - "description": "Number of downvotes for the merge request", + "description": "Number of downvotes for the merge request.", "args": [ ], @@ -38938,7 +41813,7 @@ }, { "name": "forceRemoveSourceBranch", - "description": "Indicates if the project settings will lead to source branch deletion after merge", + "description": "Indicates if the project settings will lead to source branch deletion after merge.", "args": [ ], @@ -38952,7 +41827,25 @@ }, { "name": "hasCi", - "description": "Indicates if the merge request has CI", + "description": "Indicates if the merge request has CI.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasSecurityReports", + "description": "Indicates if the source branch has any security reports.", "args": [ ], @@ -38970,7 +41863,7 @@ }, { "name": "headPipeline", - "description": "The pipeline running on the branch HEAD of the merge request", + "description": "The pipeline running on the branch HEAD of the merge request.", "args": [ ], @@ -38984,7 +41877,7 @@ }, { "name": "id", - "description": "ID of the merge request", + "description": "ID of the merge request.", "args": [ ], @@ -39002,7 +41895,7 @@ }, { "name": "iid", - "description": "Internal ID of the merge request", + "description": "Internal ID of the merge request.", "args": [ ], @@ -39020,7 +41913,7 @@ }, { "name": "inProgressMergeCommitSha", - "description": "Commit SHA of the merge request if merge is in progress", + "description": "Commit SHA of the merge request if merge is in progress.", "args": [ ], @@ -39034,7 +41927,7 @@ }, { "name": "labels", - "description": "Labels of the merge request", + "description": "Labels of the merge request.", "args": [ { "name": "after", @@ -39087,7 +41980,7 @@ }, { "name": "mergeCommitSha", - "description": "SHA of the merge request commit (set once merged)", + "description": "SHA of the merge request commit (set once merged).", "args": [ ], @@ -39101,7 +41994,7 @@ }, { "name": "mergeError", - "description": "Error message due to a merge error", + "description": "Error message due to a merge error.", "args": [ ], @@ -39115,7 +42008,7 @@ }, { "name": "mergeOngoing", - "description": "Indicates if a merge is currently occurring", + "description": "Indicates if a merge is currently occurring.", "args": [ ], @@ -39133,7 +42026,7 @@ }, { "name": "mergeStatus", - "description": "Status of the merge request", + "description": "Status of the merge request.", "args": [ ], @@ -39147,7 +42040,7 @@ }, { "name": "mergeTrainsCount", - "description": "", + "description": "Number of merge requests in the merge train.", "args": [ ], @@ -39161,7 +42054,7 @@ }, { "name": "mergeUser", - "description": "User who merged this merge request", + "description": "User who merged this merge request.", "args": [ ], @@ -39175,7 +42068,7 @@ }, { "name": "mergeWhenPipelineSucceeds", - "description": "Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS)", + "description": "Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS).", "args": [ ], @@ -39189,7 +42082,7 @@ }, { "name": "mergeable", - "description": "Indicates if the merge request is mergeable", + "description": "Indicates if the merge request is mergeable.", "args": [ ], @@ -39207,7 +42100,7 @@ }, { "name": "mergeableDiscussionsState", - "description": "Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged", + "description": "Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged.", "args": [ ], @@ -39221,7 +42114,7 @@ }, { "name": "mergedAt", - "description": "Timestamp of when the merge request was merged, null if not merged", + "description": "Timestamp of when the merge request was merged, null if not merged.", "args": [ ], @@ -39235,7 +42128,7 @@ }, { "name": "milestone", - "description": "The milestone of the merge request", + "description": "The milestone of the merge request.", "args": [ ], @@ -39249,7 +42142,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -39442,7 +42335,7 @@ }, { "name": "project", - "description": "Alias for target_project", + "description": "Alias for target_project.", "args": [ ], @@ -39460,7 +42353,7 @@ }, { "name": "projectId", - "description": "ID of the merge request project", + "description": "ID of the merge request project.", "args": [ ], @@ -39478,7 +42371,7 @@ }, { "name": "rebaseCommitSha", - "description": "Rebase commit SHA of the merge request", + "description": "Rebase commit SHA of the merge request.", "args": [ ], @@ -39492,7 +42385,7 @@ }, { "name": "rebaseInProgress", - "description": "Indicates if there is a rebase currently in progress for the merge request", + "description": "Indicates if there is a rebase currently in progress for the merge request.", "args": [ ], @@ -39510,11 +42403,11 @@ }, { "name": "reference", - "description": "Internal reference of the merge request. Returned in shortened format by default", + "description": "Internal reference of the merge request. Returned in shortened format by default.", "args": [ { "name": "full", - "description": "Boolean option specifying whether the reference should be returned in full", + "description": "Boolean option specifying whether the reference should be returned in full.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -39604,7 +42497,7 @@ }, { "name": "shouldBeRebased", - "description": "Indicates if the merge request will be rebased", + "description": "Indicates if the merge request will be rebased.", "args": [ ], @@ -39622,7 +42515,7 @@ }, { "name": "shouldRemoveSourceBranch", - "description": "Indicates if the source branch of the merge request will be deleted after merge", + "description": "Indicates if the source branch of the merge request will be deleted after merge.", "args": [ ], @@ -39636,7 +42529,7 @@ }, { "name": "sourceBranch", - "description": "Source branch of the merge request", + "description": "Source branch of the merge request.", "args": [ ], @@ -39654,7 +42547,7 @@ }, { "name": "sourceBranchExists", - "description": "Indicates if the source branch of the merge request exists", + "description": "Indicates if the source branch of the merge request exists.", "args": [ ], @@ -39672,7 +42565,7 @@ }, { "name": "sourceBranchProtected", - "description": "Indicates if the source branch is protected", + "description": "Indicates if the source branch is protected.", "args": [ ], @@ -39690,7 +42583,7 @@ }, { "name": "sourceProject", - "description": "Source project of the merge request", + "description": "Source project of the merge request.", "args": [ ], @@ -39704,7 +42597,7 @@ }, { "name": "sourceProjectId", - "description": "ID of the merge request source project", + "description": "ID of the merge request source project.", "args": [ ], @@ -39718,7 +42611,7 @@ }, { "name": "squash", - "description": "Indicates if squash on merge is enabled", + "description": "Indicates if squash on merge is enabled.", "args": [ ], @@ -39736,7 +42629,7 @@ }, { "name": "squashOnMerge", - "description": "Indicates if squash on merge is enabled", + "description": "Indicates if squash on merge is enabled.", "args": [ ], @@ -39754,7 +42647,7 @@ }, { "name": "state", - "description": "State of the merge request", + "description": "State of the merge request.", "args": [ ], @@ -39772,7 +42665,7 @@ }, { "name": "subscribed", - "description": "Indicates if the currently logged in user is subscribed to this merge request", + "description": "Indicates if the currently logged in user is subscribed to this merge request.", "args": [ ], @@ -39790,7 +42683,7 @@ }, { "name": "targetBranch", - "description": "Target branch of the merge request", + "description": "Target branch of the merge request.", "args": [ ], @@ -39808,7 +42701,7 @@ }, { "name": "targetBranchExists", - "description": "Indicates if the target branch of the merge request exists", + "description": "Indicates if the target branch of the merge request exists.", "args": [ ], @@ -39826,7 +42719,7 @@ }, { "name": "targetProject", - "description": "Target project of the merge request", + "description": "Target project of the merge request.", "args": [ ], @@ -39844,7 +42737,7 @@ }, { "name": "targetProjectId", - "description": "ID of the merge request target project", + "description": "ID of the merge request target project.", "args": [ ], @@ -39880,7 +42773,7 @@ }, { "name": "timeEstimate", - "description": "Time estimate of the merge request", + "description": "Time estimate of the merge request.", "args": [ ], @@ -39898,7 +42791,7 @@ }, { "name": "title", - "description": "Title of the merge request", + "description": "Title of the merge request.", "args": [ ], @@ -39930,7 +42823,7 @@ }, { "name": "totalTimeSpent", - "description": "Total time reported as spent on the merge request", + "description": "Total time reported as spent on the merge request.", "args": [ ], @@ -39948,7 +42841,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the merge request was last updated", + "description": "Timestamp of when the merge request was last updated.", "args": [ ], @@ -39966,7 +42859,7 @@ }, { "name": "upvotes", - "description": "Number of upvotes for the merge request", + "description": "Number of upvotes for the merge request.", "args": [ ], @@ -39984,7 +42877,7 @@ }, { "name": "userDiscussionsCount", - "description": "Number of user discussions in the merge request", + "description": "Number of user discussions in the merge request.", "args": [ ], @@ -39998,7 +42891,7 @@ }, { "name": "userNotesCount", - "description": "User notes count of the merge request", + "description": "User notes count of the merge request.", "args": [ ], @@ -40030,7 +42923,7 @@ }, { "name": "webUrl", - "description": "Web URL of the merge request", + "description": "Web URL of the merge request.", "args": [ ], @@ -40044,7 +42937,7 @@ }, { "name": "workInProgress", - "description": "Indicates if the merge request is a work in progress (WIP)", + "description": "Indicates if the merge request is a work in progress (WIP).", "args": [ ], @@ -40084,7 +42977,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -40156,7 +43049,7 @@ }, { "name": "totalTimeToMerge", - "description": "Total sum of time to merge, in seconds, for the collection of merge requests", + "description": "Total sum of time to merge, in seconds, for the collection of merge requests.", "args": [ ], @@ -40198,7 +43091,7 @@ }, { "name": "title", - "description": "Title of the merge request", + "description": "Title of the merge request.", "type": { "kind": "NON_NULL", "name": null, @@ -40212,7 +43105,7 @@ }, { "name": "sourceBranch", - "description": "Source branch of the merge request", + "description": "Source branch of the merge request.", "type": { "kind": "NON_NULL", "name": null, @@ -40226,7 +43119,7 @@ }, { "name": "targetBranch", - "description": "Target branch of the merge request", + "description": "Target branch of the merge request.", "type": { "kind": "NON_NULL", "name": null, @@ -40240,7 +43133,7 @@ }, { "name": "description", - "description": "Description of the merge request (Markdown rendered as HTML for caching)", + "description": "Description of the merge request (Markdown rendered as HTML for caching).", "type": { "kind": "SCALAR", "name": "String", @@ -40250,7 +43143,7 @@ }, { "name": "labels", - "description": "Labels of the merge request", + "description": "Labels of the merge request.", "type": { "kind": "LIST", "name": null, @@ -40415,7 +43308,7 @@ }, { "name": "mergeRequestDiffId", - "description": "ID of the Merge Request diff", + "description": "ID of the Merge Request diff.", "args": [ ], @@ -40641,7 +43534,7 @@ { "kind": "SCALAR", "name": "MergeRequestID", - "description": "Identifier of MergeRequest", + "description": "Identifier of MergeRequest.", "fields": null, "inputFields": null, "interfaces": null, @@ -40649,6 +43542,29 @@ "possibleTypes": null }, { + "kind": "ENUM", + "name": "MergeRequestNewState", + "description": "New state to apply to a merge request.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OPEN", + "description": "Open the merge request if it is closed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "Close the merge request if it is open.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { "kind": "OBJECT", "name": "MergeRequestPermissions", "description": "Check permissions for the current user on a merge request", @@ -40825,6 +43741,136 @@ }, { "kind": "INPUT_OBJECT", + "name": "MergeRequestReviewerRereviewInput", + "description": "Autogenerated input type of MergeRequestReviewerRereview", + "fields": null, + "inputFields": [ + { + "name": "projectPath", + "description": "The project the merge request 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 merge request to mutate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "userId", + "description": "The user ID for the user that has been requested for a new review.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UserID", + "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": "MergeRequestReviewerRereviewPayload", + "description": "Autogenerated return type of MergeRequestReviewerRereview", + "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": "Errors encountered during execution of the mutation.", + "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": "mergeRequest", + "description": "The merge request after mutation.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "MergeRequest", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", "name": "MergeRequestSetAssigneesInput", "description": "Autogenerated input type of MergeRequestSetAssignees", "fields": null, @@ -41776,7 +44822,7 @@ }, { "name": "merged", - "description": null, + "description": "Merge Request has been merged", "isDeprecated": false, "deprecationReason": null } @@ -41819,7 +44865,7 @@ }, { "name": "title", - "description": "Title of the merge request", + "description": "Title of the merge request.", "type": { "kind": "SCALAR", "name": "String", @@ -41829,7 +44875,7 @@ }, { "name": "targetBranch", - "description": "Target branch of the merge request", + "description": "Target branch of the merge request.", "type": { "kind": "SCALAR", "name": "String", @@ -41839,7 +44885,7 @@ }, { "name": "description", - "description": "Description of the merge request (Markdown rendered as HTML for caching)", + "description": "Description of the merge request (Markdown rendered as HTML for caching).", "type": { "kind": "SCALAR", "name": "String", @@ -41848,6 +44894,16 @@ "defaultValue": null }, { + "name": "state", + "description": "The action to perform to change the state.", + "type": { + "kind": "ENUM", + "name": "MergeRequestNewState", + "ofType": null + }, + "defaultValue": null + }, + { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "type": { @@ -41936,7 +44992,7 @@ "fields": [ { "name": "revision", - "description": "Revision", + "description": "Revision.", "args": [ ], @@ -41954,7 +45010,7 @@ }, { "name": "version", - "description": "Version", + "description": "Version.", "args": [ ], @@ -41985,7 +45041,7 @@ "fields": [ { "name": "fileName", - "description": "File name of the metric image", + "description": "File name of the metric image.", "args": [ ], @@ -41999,7 +45055,7 @@ }, { "name": "filePath", - "description": "File path of the metric image", + "description": "File path of the metric image.", "args": [ ], @@ -42013,7 +45069,7 @@ }, { "name": "id", - "description": "ID of the metric upload", + "description": "ID of the metric upload.", "args": [ ], @@ -42031,7 +45087,7 @@ }, { "name": "iid", - "description": "Internal ID of the metric upload", + "description": "Internal ID of the metric upload.", "args": [ ], @@ -42049,7 +45105,7 @@ }, { "name": "url", - "description": "URL of the metric source", + "description": "URL of the metric source.", "args": [ ], @@ -42080,7 +45136,7 @@ "fields": [ { "name": "annotations", - "description": "Annotations added to the dashboard", + "description": "Annotations added to the dashboard.", "args": [ { "name": "from", @@ -42157,7 +45213,7 @@ }, { "name": "path", - "description": "Path to a file with the dashboard definition", + "description": "Path to a file with the dashboard definition.", "args": [ ], @@ -42171,7 +45227,7 @@ }, { "name": "schemaValidationWarnings", - "description": "Dashboard schema validation warnings", + "description": "Dashboard schema validation warnings.", "args": [ ], @@ -42206,7 +45262,7 @@ "fields": [ { "name": "description", - "description": "Description of the annotation", + "description": "Description of the annotation.", "args": [ ], @@ -42220,7 +45276,7 @@ }, { "name": "endingAt", - "description": "Timestamp marking end of annotated time span", + "description": "Timestamp marking end of annotated time span.", "args": [ ], @@ -42234,7 +45290,7 @@ }, { "name": "id", - "description": "ID of the annotation", + "description": "ID of the annotation.", "args": [ ], @@ -42252,7 +45308,7 @@ }, { "name": "panelId", - "description": "ID of a dashboard panel to which the annotation should be scoped", + "description": "ID of a dashboard panel to which the annotation should be scoped.", "args": [ ], @@ -42266,7 +45322,7 @@ }, { "name": "startingAt", - "description": "Timestamp marking start of annotated time span", + "description": "Timestamp marking start of annotated time span.", "args": [ ], @@ -42401,7 +45457,7 @@ { "kind": "SCALAR", "name": "MetricsDashboardAnnotationID", - "description": "Identifier of Metrics::Dashboard::Annotation", + "description": "Identifier of Metrics::Dashboard::Annotation.", "fields": null, "inputFields": null, "interfaces": null, @@ -42415,7 +45471,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp of milestone creation", + "description": "Timestamp of milestone creation.", "args": [ ], @@ -42433,7 +45489,7 @@ }, { "name": "description", - "description": "Description of the milestone", + "description": "Description of the milestone.", "args": [ ], @@ -42447,7 +45503,7 @@ }, { "name": "dueDate", - "description": "Timestamp of the milestone due date", + "description": "Timestamp of the milestone due date.", "args": [ ], @@ -42461,7 +45517,7 @@ }, { "name": "groupMilestone", - "description": "Indicates if milestone is at group level", + "description": "Indicates if milestone is at group level.", "args": [ ], @@ -42479,7 +45535,7 @@ }, { "name": "id", - "description": "ID of the milestone", + "description": "ID of the milestone.", "args": [ ], @@ -42497,7 +45553,7 @@ }, { "name": "projectMilestone", - "description": "Indicates if milestone is at project level", + "description": "Indicates if milestone is at project level.", "args": [ ], @@ -42515,7 +45571,7 @@ }, { "name": "report", - "description": "Historically accurate report about the timebox", + "description": "Historically accurate report about the timebox.", "args": [ ], @@ -42529,7 +45585,7 @@ }, { "name": "startDate", - "description": "Timestamp of the milestone start date", + "description": "Timestamp of the milestone start date.", "args": [ ], @@ -42543,7 +45599,7 @@ }, { "name": "state", - "description": "State of the milestone", + "description": "State of the milestone.", "args": [ ], @@ -42561,7 +45617,7 @@ }, { "name": "stats", - "description": "Milestone statistics", + "description": "Milestone statistics.", "args": [ ], @@ -42575,7 +45631,7 @@ }, { "name": "subgroupMilestone", - "description": "Indicates if milestone is at subgroup level", + "description": "Indicates if milestone is at subgroup level.", "args": [ ], @@ -42593,7 +45649,7 @@ }, { "name": "title", - "description": "Title of the milestone", + "description": "Title of the milestone.", "args": [ ], @@ -42611,7 +45667,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of last milestone update", + "description": "Timestamp of last milestone update.", "args": [ ], @@ -42629,7 +45685,7 @@ }, { "name": "webPath", - "description": "Web path of the milestone", + "description": "Web path of the milestone.", "args": [ ], @@ -42772,7 +45828,7 @@ { "kind": "SCALAR", "name": "MilestoneID", - "description": "Identifier of Milestone", + "description": "Identifier of Milestone.", "fields": null, "inputFields": null, "interfaces": null, @@ -42782,20 +45838,20 @@ { "kind": "ENUM", "name": "MilestoneStateEnum", - "description": null, + "description": "Current state of milestone", "fields": null, "inputFields": null, "interfaces": null, "enumValues": [ { "name": "active", - "description": null, + "description": "Milestone is currently active", "isDeprecated": false, "deprecationReason": null }, { "name": "closed", - "description": null, + "description": "Milestone is closed", "isDeprecated": false, "deprecationReason": null } @@ -42809,7 +45865,7 @@ "fields": [ { "name": "closedIssuesCount", - "description": "Number of closed issues associated with the milestone", + "description": "Number of closed issues associated with the milestone.", "args": [ ], @@ -42823,7 +45879,7 @@ }, { "name": "totalIssuesCount", - "description": "Total number of issues associated with the milestone", + "description": "Total number of issues associated with the milestone.", "args": [ ], @@ -43007,6 +46063,33 @@ "deprecationReason": null }, { + "name": "apiFuzzingCiConfigurationCreate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ApiFuzzingCiConfigurationCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ApiFuzzingCiConfigurationCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "awardEmojiAdd", "description": null, "args": [ @@ -43790,6 +46873,114 @@ "deprecationReason": null }, { + "name": "dastProfileCreate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DastProfileCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DastProfileCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dastProfileDelete", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DastProfileDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DastProfileDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dastProfileRun", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DastProfileRunInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DastProfileRunPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dastProfileUpdate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DastProfileUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DastProfileUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "dastScannerProfileCreate", "description": null, "args": [ @@ -44006,6 +47197,33 @@ "deprecationReason": null }, { + "name": "dastSiteValidationRevoke", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DastSiteValidationRevokeInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "DastSiteValidationRevokePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "deleteAnnotation", "description": null, "args": [ @@ -44438,6 +47656,60 @@ "deprecationReason": null }, { + "name": "epicBoardCreate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EpicBoardCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "EpicBoardCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "epicBoardListCreate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "EpicBoardListCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "EpicBoardListCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "epicSetSubscription", "description": null, "args": [ @@ -44519,6 +47791,33 @@ "deprecationReason": null }, { + "name": "gitlabSubscriptionActivate", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "GitlabSubscriptionActivateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "GitlabSubscriptionActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "httpIntegrationCreate", "description": null, "args": [ @@ -45059,6 +48358,33 @@ "deprecationReason": null }, { + "name": "mergeRequestReviewerRereview", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MergeRequestReviewerRereviewInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MergeRequestReviewerRereviewPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "mergeRequestSetAssignees", "description": null, "args": [ @@ -45302,6 +48628,33 @@ "deprecationReason": null }, { + "name": "oncallRotationDestroy", + "description": null, + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "OncallRotationDestroyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OncallRotationDestroyPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "oncallScheduleCreate", "description": null, "args": [ @@ -46193,33 +49546,6 @@ "deprecationReason": null }, { - "name": "updateDevopsAdoptionSegment", - "description": null, - "args": [ - { - "name": "input", - "description": null, - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "INPUT_OBJECT", - "name": "UpdateDevopsAdoptionSegmentInput", - "ofType": null - } - }, - "defaultValue": null - } - ], - "type": { - "kind": "OBJECT", - "name": "UpdateDevopsAdoptionSegmentPayload", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { "name": "updateEpic", "description": null, "args": [ @@ -46641,7 +49967,7 @@ "fields": [ { "name": "actualRepositorySizeLimit", - "description": "Size limit for repositories in the namespace in bytes", + "description": "Size limit for repositories in the namespace in bytes.", "args": [ ], @@ -46655,7 +49981,7 @@ }, { "name": "additionalPurchasedStorageSize", - "description": "Additional storage purchased for the root namespace in bytes", + "description": "Additional storage purchased for the root namespace in bytes.", "args": [ ], @@ -46732,7 +50058,7 @@ }, { "name": "containsLockedProjects", - "description": "Includes at least one project where the repository size exceeds the limit", + "description": "Includes at least one project where the repository size exceeds the limit.", "args": [ ], @@ -46750,7 +50076,7 @@ }, { "name": "description", - "description": "Description of the namespace", + "description": "Description of the namespace.", "args": [ ], @@ -46778,7 +50104,7 @@ }, { "name": "fullName", - "description": "Full name of the namespace", + "description": "Full name of the namespace.", "args": [ ], @@ -46796,7 +50122,7 @@ }, { "name": "fullPath", - "description": "Full path of the namespace", + "description": "Full path of the namespace.", "args": [ ], @@ -46814,7 +50140,7 @@ }, { "name": "id", - "description": "ID of the namespace", + "description": "ID of the namespace.", "args": [ ], @@ -46832,7 +50158,7 @@ }, { "name": "isTemporaryStorageIncreaseEnabled", - "description": "Status of the temporary storage increase", + "description": "Status of the temporary storage increase.", "args": [ ], @@ -46850,7 +50176,7 @@ }, { "name": "lfsEnabled", - "description": "Indicates if Large File Storage (LFS) is enabled for namespace", + "description": "Indicates if Large File Storage (LFS) is enabled for namespace.", "args": [ ], @@ -46864,7 +50190,7 @@ }, { "name": "name", - "description": "Name of the namespace", + "description": "Name of the namespace.", "args": [ ], @@ -46882,7 +50208,7 @@ }, { "name": "packageSettings", - "description": "The package settings for the namespace", + "description": "The package settings for the namespace.", "args": [ ], @@ -46896,7 +50222,7 @@ }, { "name": "path", - "description": "Path of the namespace", + "description": "Path of the namespace.", "args": [ ], @@ -46914,7 +50240,7 @@ }, { "name": "projects", - "description": "Projects within this namespace", + "description": "Projects within this namespace.", "args": [ { "name": "includeSubgroups", @@ -47011,7 +50337,7 @@ }, { "name": "repositorySizeExcessProjectCount", - "description": "Number of projects in the root namespace where the repository size exceeds the limit", + "description": "Number of projects in the root namespace where the repository size exceeds the limit.", "args": [ ], @@ -47029,7 +50355,7 @@ }, { "name": "requestAccessEnabled", - "description": "Indicates if users can request access to namespace", + "description": "Indicates if users can request access to namespace.", "args": [ ], @@ -47043,7 +50369,7 @@ }, { "name": "rootStorageStatistics", - "description": "Aggregated storage statistics of the namespace. Only available for root namespaces", + "description": "Aggregated storage statistics of the namespace. Only available for root namespaces.", "args": [ ], @@ -47057,7 +50383,7 @@ }, { "name": "storageSizeLimit", - "description": "Total storage limit of the root namespace in bytes", + "description": "Total storage limit of the root namespace in bytes.", "args": [ ], @@ -47071,7 +50397,7 @@ }, { "name": "temporaryStorageIncreaseEndsOn", - "description": "Date until the temporary storage increase is active", + "description": "Date until the temporary storage increase is active.", "args": [ ], @@ -47085,7 +50411,7 @@ }, { "name": "totalRepositorySize", - "description": "Total repository size of all projects in the root namespace in bytes", + "description": "Total repository size of all projects in the root namespace in bytes.", "args": [ ], @@ -47099,7 +50425,7 @@ }, { "name": "totalRepositorySizeExcess", - "description": "Total excess repository size of all projects in the root namespace in bytes", + "description": "Total excess repository size of all projects in the root namespace in bytes.", "args": [ ], @@ -47113,7 +50439,7 @@ }, { "name": "visibility", - "description": "Visibility of the namespace", + "description": "Visibility of the namespace.", "args": [ ], @@ -47248,7 +50574,7 @@ { "kind": "SCALAR", "name": "NamespaceID", - "description": "Identifier of Namespace", + "description": "Identifier of Namespace.", "fields": null, "inputFields": null, "interfaces": null, @@ -47388,7 +50714,7 @@ "inputFields": [ { "name": "labelName", - "description": "Filter by label name", + "description": "Filter by label name.", "type": { "kind": "LIST", "name": null, @@ -47402,7 +50728,7 @@ }, { "name": "milestoneTitle", - "description": "Filter by milestone title", + "description": "Filter by milestone title.", "type": { "kind": "SCALAR", "name": "String", @@ -47412,7 +50738,7 @@ }, { "name": "assigneeUsername", - "description": "Filter by assignee username", + "description": "Filter by assignee username.", "type": { "kind": "LIST", "name": null, @@ -47426,7 +50752,7 @@ }, { "name": "authorUsername", - "description": "Filter by author username", + "description": "Filter by author username.", "type": { "kind": "SCALAR", "name": "String", @@ -47436,7 +50762,7 @@ }, { "name": "releaseTag", - "description": "Filter by release tag", + "description": "Filter by release tag.", "type": { "kind": "SCALAR", "name": "String", @@ -47446,7 +50772,7 @@ }, { "name": "myReactionEmoji", - "description": "Filter by reaction emoji", + "description": "Filter by reaction emoji.", "type": { "kind": "SCALAR", "name": "String", @@ -47456,7 +50782,7 @@ }, { "name": "epicId", - "description": "Filter by epic ID. Incompatible with epicWildcardId", + "description": "Filter by epic ID. Incompatible with epicWildcardId.", "type": { "kind": "SCALAR", "name": "EpicID", @@ -47466,7 +50792,7 @@ }, { "name": "iterationTitle", - "description": "Filter by iteration title", + "description": "Filter by iteration title.", "type": { "kind": "SCALAR", "name": "String", @@ -47476,7 +50802,7 @@ }, { "name": "weight", - "description": "Filter by weight", + "description": "Filter by weight.", "type": { "kind": "SCALAR", "name": "String", @@ -47496,7 +50822,7 @@ "fields": [ { "name": "author", - "description": "User who wrote this note", + "description": "User who wrote this note.", "args": [ ], @@ -47514,7 +50840,7 @@ }, { "name": "body", - "description": "Content of the note", + "description": "Content of the note.", "args": [ ], @@ -47546,7 +50872,7 @@ }, { "name": "confidential", - "description": "Indicates if this note is confidential", + "description": "Indicates if this note is confidential.", "args": [ ], @@ -47560,7 +50886,7 @@ }, { "name": "createdAt", - "description": "Timestamp of the note creation", + "description": "Timestamp of the note creation.", "args": [ ], @@ -47578,7 +50904,7 @@ }, { "name": "discussion", - "description": "The discussion this note is a part of", + "description": "The discussion this note is a part of.", "args": [ ], @@ -47592,7 +50918,7 @@ }, { "name": "id", - "description": "ID of the note", + "description": "ID of the note.", "args": [ ], @@ -47601,7 +50927,7 @@ "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "NoteID", "ofType": null } }, @@ -47610,7 +50936,7 @@ }, { "name": "position", - "description": "The position of this note on a diff", + "description": "The position of this note on a diff.", "args": [ ], @@ -47624,7 +50950,7 @@ }, { "name": "project", - "description": "Project associated with the note", + "description": "Project associated with the note.", "args": [ ], @@ -47638,7 +50964,7 @@ }, { "name": "resolvable", - "description": "Indicates if the object can be resolved", + "description": "Indicates if the object can be resolved.", "args": [ ], @@ -47656,7 +50982,7 @@ }, { "name": "resolved", - "description": "Indicates if the object is resolved", + "description": "Indicates if the object is resolved.", "args": [ ], @@ -47674,7 +51000,7 @@ }, { "name": "resolvedAt", - "description": "Timestamp of when the object was resolved", + "description": "Timestamp of when the object was resolved.", "args": [ ], @@ -47688,7 +51014,7 @@ }, { "name": "resolvedBy", - "description": "User who resolved the object", + "description": "User who resolved the object.", "args": [ ], @@ -47702,7 +51028,7 @@ }, { "name": "system", - "description": "Indicates whether this note was created by the system or by a user", + "description": "Indicates whether this note was created by the system or by a user.", "args": [ ], @@ -47720,7 +51046,7 @@ }, { "name": "systemNoteIconName", - "description": "Name of the icon corresponding to a system note", + "description": "Name of the icon corresponding to a system note.", "args": [ ], @@ -47734,7 +51060,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of the note's last activity", + "description": "Timestamp of the note's last activity.", "args": [ ], @@ -47752,7 +51078,7 @@ }, { "name": "url", - "description": "URL to view this Note in the Web UI", + "description": "URL to view this Note in the Web UI.", "args": [ ], @@ -47909,7 +51235,7 @@ { "kind": "SCALAR", "name": "NoteID", - "description": "Identifier of Note", + "description": "Identifier of Note.", "fields": null, "inputFields": null, "interfaces": null, @@ -48044,7 +51370,7 @@ "fields": [ { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -48101,7 +51427,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -48211,7 +51537,7 @@ { "kind": "SCALAR", "name": "NoteableID", - "description": "Identifier of Noteable", + "description": "Identifier of Noteable.", "fields": null, "inputFields": null, "interfaces": null, @@ -48628,6 +51954,136 @@ }, { "kind": "INPUT_OBJECT", + "name": "OncallRotationDestroyInput", + "description": "Autogenerated input type of OncallRotationDestroy", + "fields": null, + "inputFields": [ + { + "name": "projectPath", + "description": "The project to remove the on-call schedule from.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "scheduleIid", + "description": "The IID of the on-call schedule to the on-call rotation belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The ID of the on-call rotation to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "IncidentManagementOncallRotationID", + "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": "OncallRotationDestroyPayload", + "description": "Autogenerated return type of OncallRotationDestroy", + "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": "Errors encountered during execution of the mutation.", + "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": "oncallRotation", + "description": "The on-call rotation.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "IncidentManagementOncallRotation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", "name": "OncallRotationLengthInputType", "description": "The rotation length of the on-call rotation", "fields": null, @@ -49148,7 +52604,7 @@ "fields": [ { "name": "createdAt", - "description": "The created date.", + "description": "Date of creation.", "args": [ ], @@ -49166,7 +52622,7 @@ }, { "name": "id", - "description": "The ID of the package.", + "description": "ID of the package.", "args": [ ], @@ -49175,7 +52631,7 @@ "name": null, "ofType": { "kind": "SCALAR", - "name": "ID", + "name": "PackagesPackageID", "ofType": null } }, @@ -49183,320 +52639,22 @@ "deprecationReason": null }, { - "name": "name", - "description": "The name of the package.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "packageType", - "description": "The type of the package.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "ENUM", - "name": "PackageTypeEnum", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "pipelines", - "description": "Pipelines that built the package.", - "args": [ - { - "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": "PipelineConnection", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "project", - "description": "Project where the package is stored.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "Project", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "tags", - "description": "The package tags.", - "args": [ - { - "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": "PackageTagConnection", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "updatedAt", - "description": "The updated date.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Time", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "version", - "description": "The version of the package.", + "name": "metadata", + "description": "Package metadata.", "args": [ ], "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "versions", - "description": "The other versions of the package.", - "args": [ - { - "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": "PackageConnection", + "kind": "UNION", + "name": "PackageMetadata", "ofType": null }, "isDeprecated": false, "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", - "name": "PackageComposerDetails", - "description": "Details of a Composer package", - "fields": [ - { - "name": "composerMetadatum", - "description": "The Composer metadatum.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PackageComposerMetadatumType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "createdAt", - "description": "The created date.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "Time", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "id", - "description": "The ID of the package.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "ID", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null }, { "name": "name", - "description": "The name of the package.", + "description": "Name of the package.", "args": [ ], @@ -49514,7 +52672,7 @@ }, { "name": "packageType", - "description": "The type of the package.", + "description": "Package type.", "args": [ ], @@ -49603,7 +52761,7 @@ }, { "name": "tags", - "description": "The package tags.", + "description": "Package tags.", "args": [ { "name": "after", @@ -49656,7 +52814,7 @@ }, { "name": "updatedAt", - "description": "The updated date.", + "description": "Date of most recent update.", "args": [ ], @@ -49674,7 +52832,7 @@ }, { "name": "version", - "description": "The version of the package.", + "description": "Version string.", "args": [ ], @@ -49733,7 +52891,7 @@ ], "type": { "kind": "OBJECT", - "name": "PackageConnection", + "name": "PackageWithoutVersionsConnection", "ofType": null }, "isDeprecated": false, @@ -49818,55 +52976,6 @@ }, { "kind": "OBJECT", - "name": "PackageComposerMetadatumType", - "description": "Composer metadatum", - "fields": [ - { - "name": "composerJson", - "description": "Data of the Composer JSON file.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "OBJECT", - "name": "PackageComposerJsonType", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - }, - { - "name": "targetSha", - "description": "Target SHA of the package.", - "args": [ - - ], - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "OBJECT", "name": "PackageConnection", "description": "The connection type for Package.", "fields": [ @@ -50044,7 +53153,7 @@ }, { "name": "packageFileId", - "description": "ID of the PackageFile", + "description": "ID of the PackageFile.", "args": [ ], @@ -50223,6 +53332,22 @@ "possibleTypes": null }, { + "kind": "UNION", + "name": "PackageMetadata", + "description": "Represents metadata associated with a Package", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ComposerMetadata", + "ofType": null + } + ] + }, + { "kind": "OBJECT", "name": "PackageSettings", "description": "Namespace-level Package Registry settings", @@ -50480,7 +53605,7 @@ }, { "name": "NPM", - "description": "Packages from the NPM package manager", + "description": "Packages from the npm package manager", "isDeprecated": false, "deprecationReason": null }, @@ -50525,14 +53650,387 @@ "description": "Packages from the Debian package manager", "isDeprecated": false, "deprecationReason": null + }, + { + "name": "RUBYGEMS", + "description": "Packages from the Rubygems package manager", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PackageWithoutVersions", + "description": "Represents a version of a package in the Package Registry", + "fields": [ + { + "name": "createdAt", + "description": "Date of creation.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "ID of the package.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "PackagesPackageID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metadata", + "description": "Package metadata.", + "args": [ + + ], + "type": { + "kind": "UNION", + "name": "PackageMetadata", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the package.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "packageType", + "description": "Package type.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PackageTypeEnum", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pipelines", + "description": "Pipelines that built the package.", + "args": [ + { + "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": "PipelineConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "project", + "description": "Project where the package is stored.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Project", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "Package tags.", + "args": [ + { + "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": "PackageTagConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "Date of most recent update.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Time", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "version", + "description": "Version string.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PackageWithoutVersionsConnection", + "description": "The connection type for PackageWithoutVersions.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PackageWithoutVersionsEdge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of nodes.", + "args": [ + + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PackageWithoutVersions", + "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": "PackageWithoutVersionsEdge", + "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": "PackageWithoutVersions", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, "possibleTypes": null }, { "kind": "SCALAR", "name": "PackagesPackageID", - "description": "Identifier of Packages::Package", + "description": "Identifier of Packages::Package.", "fields": null, "inputFields": null, "interfaces": null, @@ -50623,7 +54121,7 @@ "fields": [ { "name": "active", - "description": "Indicates if the pipeline is active", + "description": "Indicates if the pipeline is active.", "args": [ ], @@ -50641,7 +54139,7 @@ }, { "name": "beforeSha", - "description": "Base SHA of the source branch", + "description": "Base SHA of the source branch.", "args": [ ], @@ -50655,7 +54153,7 @@ }, { "name": "cancelable", - "description": "Specifies if a pipeline can be canceled", + "description": "Specifies if a pipeline can be canceled.", "args": [ ], @@ -50673,7 +54171,7 @@ }, { "name": "committedAt", - "description": "Timestamp of the pipeline's commit", + "description": "Timestamp of the pipeline's commit.", "args": [ ], @@ -50687,7 +54185,7 @@ }, { "name": "configSource", - "description": "Config source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE)", + "description": "Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE)", "args": [ ], @@ -50701,7 +54199,7 @@ }, { "name": "coverage", - "description": "Coverage percentage", + "description": "Coverage percentage.", "args": [ ], @@ -50715,7 +54213,7 @@ }, { "name": "createdAt", - "description": "Timestamp of the pipeline's creation", + "description": "Timestamp of the pipeline's creation.", "args": [ ], @@ -50733,7 +54231,7 @@ }, { "name": "detailedStatus", - "description": "Detailed status of the pipeline", + "description": "Detailed status of the pipeline.", "args": [ ], @@ -50751,7 +54249,7 @@ }, { "name": "downstream", - "description": "Pipelines this pipeline will trigger", + "description": "Pipelines this pipeline will trigger.", "args": [ { "name": "after", @@ -50804,7 +54302,7 @@ }, { "name": "duration", - "description": "Duration of the pipeline in seconds", + "description": "Duration of the pipeline in seconds.", "args": [ ], @@ -50818,7 +54316,7 @@ }, { "name": "finishedAt", - "description": "Timestamp of the pipeline's completion", + "description": "Timestamp of the pipeline's completion.", "args": [ ], @@ -50832,7 +54330,7 @@ }, { "name": "id", - "description": "ID of the pipeline", + "description": "ID of the pipeline.", "args": [ ], @@ -50850,7 +54348,7 @@ }, { "name": "iid", - "description": "Internal ID of the pipeline", + "description": "Internal ID of the pipeline.", "args": [ ], @@ -50868,7 +54366,7 @@ }, { "name": "jobs", - "description": "Jobs belonging to the pipeline", + "description": "Jobs belonging to the pipeline.", "args": [ { "name": "securityReportTypes", @@ -50939,7 +54437,7 @@ }, { "name": "path", - "description": "Relative path to the pipeline's page", + "description": "Relative path to the pipeline's page.", "args": [ ], @@ -50953,7 +54451,7 @@ }, { "name": "project", - "description": "Project the pipeline belongs to", + "description": "Project the pipeline belongs to.", "args": [ ], @@ -50967,7 +54465,7 @@ }, { "name": "retryable", - "description": "Specifies if a pipeline can be retried", + "description": "Specifies if a pipeline can be retried.", "args": [ ], @@ -50985,7 +54483,7 @@ }, { "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.", "args": [ ], @@ -50999,7 +54497,7 @@ }, { "name": "sha", - "description": "SHA of the pipeline's commit", + "description": "SHA of the pipeline's commit.", "args": [ ], @@ -51017,7 +54515,7 @@ }, { "name": "sourceJob", - "description": "Job where pipeline was triggered from", + "description": "Job where pipeline was triggered from.", "args": [ ], @@ -51031,7 +54529,7 @@ }, { "name": "stages", - "description": "Stages of the pipeline", + "description": "Stages of the pipeline.", "args": [ { "name": "after", @@ -51084,7 +54582,7 @@ }, { "name": "startedAt", - "description": "Timestamp when the pipeline was started", + "description": "Timestamp when the pipeline was started.", "args": [ ], @@ -51116,7 +54614,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of the pipeline's last activity", + "description": "Timestamp of the pipeline's last activity.", "args": [ ], @@ -51134,7 +54632,7 @@ }, { "name": "upstream", - "description": "Pipeline that triggered the pipeline", + "description": "Pipeline that triggered the pipeline.", "args": [ ], @@ -51148,7 +54646,7 @@ }, { "name": "user", - "description": "Pipeline user", + "description": "Pipeline user.", "args": [ ], @@ -51177,6 +54675,24 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "warnings", + "description": "Indicates if a pipeline has warnings.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -51193,7 +54709,7 @@ "fields": [ { "name": "monthPipelinesLabels", - "description": "Labels for the monthly pipeline count", + "description": "Labels for the monthly pipeline count.", "args": [ ], @@ -51215,7 +54731,7 @@ }, { "name": "monthPipelinesSuccessful", - "description": "Total monthly successful pipeline count", + "description": "Total monthly successful pipeline count.", "args": [ ], @@ -51237,7 +54753,7 @@ }, { "name": "monthPipelinesTotals", - "description": "Total monthly pipeline count", + "description": "Total monthly pipeline count.", "args": [ ], @@ -51259,7 +54775,7 @@ }, { "name": "pipelineTimesLabels", - "description": "Pipeline times labels", + "description": "Pipeline times labels.", "args": [ ], @@ -51281,7 +54797,7 @@ }, { "name": "pipelineTimesValues", - "description": "Pipeline times", + "description": "Pipeline times.", "args": [ ], @@ -51303,7 +54819,7 @@ }, { "name": "weekPipelinesLabels", - "description": "Labels for the weekly pipeline count", + "description": "Labels for the weekly pipeline count.", "args": [ ], @@ -51325,7 +54841,7 @@ }, { "name": "weekPipelinesSuccessful", - "description": "Total weekly successful pipeline count", + "description": "Total weekly successful pipeline count.", "args": [ ], @@ -51347,7 +54863,7 @@ }, { "name": "weekPipelinesTotals", - "description": "Total weekly pipeline count", + "description": "Total weekly pipeline count.", "args": [ ], @@ -51369,7 +54885,7 @@ }, { "name": "yearPipelinesLabels", - "description": "Labels for the yearly pipeline count", + "description": "Labels for the yearly pipeline count.", "args": [ ], @@ -51391,7 +54907,7 @@ }, { "name": "yearPipelinesSuccessful", - "description": "Total yearly successful pipeline count", + "description": "Total yearly successful pipeline count.", "args": [ ], @@ -51413,7 +54929,7 @@ }, { "name": "yearPipelinesTotals", - "description": "Total yearly pipeline count", + "description": "Total yearly pipeline count.", "args": [ ], @@ -51584,6 +55100,12 @@ "description": null, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "COMPLIANCE_SOURCE", + "description": null, + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -51595,7 +55117,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -52059,7 +55581,7 @@ "fields": [ { "name": "actualRepositorySizeLimit", - "description": "Size limit for the repository in bytes", + "description": "Size limit for the repository in bytes.", "args": [ ], @@ -52073,7 +55595,7 @@ }, { "name": "alertManagementAlert", - "description": "A single Alert Management alert of the project", + "description": "A single Alert Management alert of the project.", "args": [ { "name": "iid", @@ -52158,7 +55680,7 @@ }, { "name": "alertManagementAlertStatusCounts", - "description": "Counts of alerts by status for the project", + "description": "Counts of alerts by status for the project.", "args": [ { "name": "search", @@ -52191,7 +55713,7 @@ }, { "name": "alertManagementAlerts", - "description": "Alert Management alerts of the project", + "description": "Alert Management alerts of the project.", "args": [ { "name": "iid", @@ -52316,7 +55838,7 @@ }, { "name": "alertManagementIntegrations", - "description": "Integrations which can receive alerts for the project", + "description": "Integrations which can receive alerts for the project.", "args": [ { "name": "after", @@ -52368,8 +55890,43 @@ "deprecationReason": null }, { + "name": "alertManagementPayloadFields", + "description": "Extract alert fields from payload for custom mapping.", + "args": [ + { + "name": "payloadExample", + "description": "Sample payload for extracting alert fields for custom mappings.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AlertManagementPayloadAlertField", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "allowMergeOnSkippedPipeline", - "description": "If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs", + "description": "If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs.", "args": [ ], @@ -52382,8 +55939,22 @@ "deprecationReason": null }, { + "name": "apiFuzzingCiConfiguration", + "description": "API fuzzing configuration for the project. Available only when feature flag `api_fuzzing_configuration_ui` is enabled.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "ApiFuzzingCiConfiguration", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "archived", - "description": "Indicates the archived status of the project", + "description": "Indicates the archived status of the project.", "args": [ ], @@ -52397,7 +55968,7 @@ }, { "name": "autocloseReferencedIssues", - "description": "Indicates if issues referenced by merge requests and commits within the default branch are closed automatically", + "description": "Indicates if issues referenced by merge requests and commits within the default branch are closed automatically.", "args": [ ], @@ -52411,7 +55982,7 @@ }, { "name": "avatarUrl", - "description": "URL to avatar image file of the project", + "description": "URL to avatar image file of the project.", "args": [ ], @@ -52425,7 +55996,7 @@ }, { "name": "board", - "description": "A single board of the project", + "description": "A single board of the project.", "args": [ { "name": "id", @@ -52452,7 +56023,7 @@ }, { "name": "boards", - "description": "Boards of the project", + "description": "Boards of the project.", "args": [ { "name": "id", @@ -52515,7 +56086,7 @@ }, { "name": "ciCdSettings", - "description": "CI/CD settings for the project", + "description": "CI/CD settings for the project.", "args": [ ], @@ -52529,7 +56100,7 @@ }, { "name": "clusterAgent", - "description": "Find a single cluster agent by name", + "description": "Find a single cluster agent by name.", "args": [ { "name": "name", @@ -52556,7 +56127,7 @@ }, { "name": "clusterAgents", - "description": "Cluster agents associated with the project", + "description": "Cluster agents associated with the project.", "args": [ { "name": "after", @@ -52609,7 +56180,7 @@ }, { "name": "codeCoverageSummary", - "description": "Code coverage summary associated with the project", + "description": "Code coverage summary associated with the project.", "args": [ ], @@ -52623,7 +56194,7 @@ }, { "name": "complianceFrameworks", - "description": "Compliance frameworks associated with the project", + "description": "Compliance frameworks associated with the project.", "args": [ { "name": "after", @@ -52676,7 +56247,7 @@ }, { "name": "containerExpirationPolicy", - "description": "The container expiration policy of the project", + "description": "The container expiration policy of the project.", "args": [ ], @@ -52690,7 +56261,7 @@ }, { "name": "containerRegistryEnabled", - "description": "Indicates if the project stores Docker container images in a container registry", + "description": "Indicates if the project stores Docker container images in a container registry.", "args": [ ], @@ -52704,7 +56275,7 @@ }, { "name": "containerRepositories", - "description": "Container repositories of the project", + "description": "Container repositories of the project.", "args": [ { "name": "name", @@ -52717,6 +56288,16 @@ "defaultValue": null }, { + "name": "sort", + "description": "Sort container repositories by this criteria.", + "type": { + "kind": "ENUM", + "name": "ContainerRepositorySort", + "ofType": null + }, + "defaultValue": "created_desc" + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -52767,7 +56348,7 @@ }, { "name": "containerRepositoriesCount", - "description": "Number of container repositories in the project", + "description": "Number of container repositories in the project.", "args": [ ], @@ -52785,7 +56366,7 @@ }, { "name": "createdAt", - "description": "Timestamp of the project creation", + "description": "Timestamp of the project creation.", "args": [ ], @@ -52798,8 +56379,61 @@ "deprecationReason": null }, { + "name": "dastProfiles", + "description": "DAST Profiles associated with the project. Always returns no nodes if `dast_saved_scans` is disabled.", + "args": [ + { + "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": "DastProfileConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "dastScannerProfiles", - "description": "The DAST scanner profiles associated with the project", + "description": "The DAST scanner profiles associated with the project.", "args": [ { "name": "after", @@ -52852,7 +56486,7 @@ }, { "name": "dastSiteProfile", - "description": "DAST Site Profile associated with the project", + "description": "DAST Site Profile associated with the project.", "args": [ { "name": "id", @@ -52879,7 +56513,7 @@ }, { "name": "dastSiteProfiles", - "description": "DAST Site Profiles associated with the project", + "description": "DAST Site Profiles associated with the project.", "args": [ { "name": "after", @@ -52932,7 +56566,7 @@ }, { "name": "dastSiteValidations", - "description": "DAST Site Validations associated with the project. Will always return no nodes if `security_on_demand_scans_site_validation` is disabled", + "description": "DAST Site Validations associated with the project. Always returns no nodes if `security_on_demand_scans_site_validation` is disabled.", "args": [ { "name": "normalizedTargetUrls", @@ -53003,7 +56637,7 @@ }, { "name": "description", - "description": "Short description of the project", + "description": "Short description of the project.", "args": [ ], @@ -53031,7 +56665,7 @@ }, { "name": "environment", - "description": "A single environment of the project", + "description": "A single environment of the project.", "args": [ { "name": "name", @@ -53082,7 +56716,7 @@ }, { "name": "environments", - "description": "Environments of the project", + "description": "Environments of the project.", "args": [ { "name": "name", @@ -53173,7 +56807,7 @@ }, { "name": "forksCount", - "description": "Number of times the project has been forked", + "description": "Number of times the project has been forked.", "args": [ ], @@ -53191,7 +56825,7 @@ }, { "name": "fullPath", - "description": "Full path of the project", + "description": "Full path of the project.", "args": [ ], @@ -53209,7 +56843,7 @@ }, { "name": "grafanaIntegration", - "description": "Grafana integration details for the project", + "description": "Grafana integration details for the project.", "args": [ ], @@ -53223,7 +56857,7 @@ }, { "name": "group", - "description": "Group of the project", + "description": "Group of the project.", "args": [ ], @@ -53237,7 +56871,7 @@ }, { "name": "httpUrlToRepo", - "description": "URL to connect to the project via HTTPS", + "description": "URL to connect to the project via HTTPS.", "args": [ ], @@ -53251,7 +56885,7 @@ }, { "name": "id", - "description": "ID of the project", + "description": "ID of the project.", "args": [ ], @@ -53269,7 +56903,7 @@ }, { "name": "importStatus", - "description": "Status of import background job of the project", + "description": "Status of import background job of the project.", "args": [ ], @@ -53283,7 +56917,7 @@ }, { "name": "incidentManagementOncallSchedules", - "description": "Incident Management On-call schedules of the project", + "description": "Incident Management On-call schedules of the project.", "args": [ { "name": "after", @@ -53336,7 +56970,7 @@ }, { "name": "issue", - "description": "A single issue of the project", + "description": "A single issue of the project.", "args": [ { "name": "iid", @@ -53585,7 +57219,7 @@ }, { "name": "issueStatusCounts", - "description": "Counts of issues by status for the project", + "description": "Counts of issues by status for the project.", "args": [ { "name": "iid", @@ -53790,7 +57424,7 @@ }, { "name": "issues", - "description": "Issues of the project", + "description": "Issues of the project.", "args": [ { "name": "iid", @@ -54093,7 +57727,7 @@ }, { "name": "iterations", - "description": "Find iterations", + "description": "Find iterations.", "args": [ { "name": "startDate", @@ -54226,7 +57860,7 @@ }, { "name": "jiraImportStatus", - "description": "Status of Jira import background job of the project", + "description": "Status of Jira import background job of the project.", "args": [ ], @@ -54240,7 +57874,7 @@ }, { "name": "jiraImports", - "description": "Jira imports into the project", + "description": "Jira imports into the project.", "args": [ { "name": "after", @@ -54293,7 +57927,7 @@ }, { "name": "jobsEnabled", - "description": "Indicates if CI/CD pipeline jobs are enabled for the current user", + "description": "Indicates if CI/CD pipeline jobs are enabled for the current user.", "args": [ ], @@ -54307,11 +57941,11 @@ }, { "name": "label", - "description": "A label available on this project", + "description": "A label available on this project.", "args": [ { "name": "title", - "description": "Title of the label", + "description": "Title of the label.", "type": { "kind": "NON_NULL", "name": null, @@ -54334,9 +57968,29 @@ }, { "name": "labels", - "description": "Labels available on this project", + "description": "Labels available on this project.", "args": [ { + "name": "searchTerm", + "description": "A search term to find labels with.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "includeAncestorGroups", + "description": "Include labels from ancestor groups.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -54375,16 +58029,6 @@ "ofType": null }, "defaultValue": null - }, - { - "name": "searchTerm", - "description": "A search term to find labels with", - "type": { - "kind": "SCALAR", - "name": "String", - "ofType": null - }, - "defaultValue": null } ], "type": { @@ -54397,7 +58041,7 @@ }, { "name": "lastActivityAt", - "description": "Timestamp of the project last activity", + "description": "Timestamp of the project last activity.", "args": [ ], @@ -54411,7 +58055,7 @@ }, { "name": "lfsEnabled", - "description": "Indicates if the project has Large File Storage (LFS) enabled", + "description": "Indicates if the project has Large File Storage (LFS) enabled.", "args": [ ], @@ -54425,7 +58069,7 @@ }, { "name": "mergeRequest", - "description": "A single merge request of the project", + "description": "A single merge request of the project.", "args": [ { "name": "iid", @@ -54452,7 +58096,7 @@ }, { "name": "mergeRequests", - "description": "Merge requests of the project", + "description": "Merge requests of the project.", "args": [ { "name": "iids", @@ -54685,7 +58329,7 @@ }, { "name": "milestones", - "description": "Milestones of the project", + "description": "Milestones of the project.", "args": [ { "name": "startDate", @@ -54836,7 +58480,7 @@ }, { "name": "name", - "description": "Name of the project (without namespace)", + "description": "Name of the project (without namespace).", "args": [ ], @@ -54854,7 +58498,7 @@ }, { "name": "nameWithNamespace", - "description": "Full name of the project with its namespace", + "description": "Full name of the project with its namespace.", "args": [ ], @@ -54872,7 +58516,7 @@ }, { "name": "namespace", - "description": "Namespace of the project", + "description": "Namespace of the project.", "args": [ ], @@ -54886,7 +58530,7 @@ }, { "name": "onlyAllowMergeIfAllDiscussionsAreResolved", - "description": "Indicates if merge requests of the project can only be merged when all the discussions are resolved", + "description": "Indicates if merge requests of the project can only be merged when all the discussions are resolved.", "args": [ ], @@ -54900,7 +58544,7 @@ }, { "name": "onlyAllowMergeIfPipelineSucceeds", - "description": "Indicates if merge requests of the project can only be merged with successful jobs", + "description": "Indicates if merge requests of the project can only be merged with successful jobs.", "args": [ ], @@ -54914,7 +58558,7 @@ }, { "name": "openIssuesCount", - "description": "Number of open issues for the project", + "description": "Number of open issues for the project.", "args": [ ], @@ -54928,7 +58572,7 @@ }, { "name": "packages", - "description": "Packages of the project", + "description": "Packages of the project.", "args": [ { "name": "after", @@ -54981,7 +58625,7 @@ }, { "name": "path", - "description": "Path of the project", + "description": "Path of the project.", "args": [ ], @@ -54999,7 +58643,7 @@ }, { "name": "pipeline", - "description": "Build pipeline of the project", + "description": "Build pipeline of the project.", "args": [ { "name": "iid", @@ -55026,7 +58670,7 @@ }, { "name": "pipelineAnalytics", - "description": "Pipeline analytics", + "description": "Pipeline analytics.", "args": [ ], @@ -55040,7 +58684,7 @@ }, { "name": "pipelines", - "description": "Build pipelines of the project", + "description": "Build pipelines of the project.", "args": [ { "name": "status", @@ -55123,7 +58767,7 @@ }, { "name": "printingMergeRequestLinkEnabled", - "description": "Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line", + "description": "Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line.", "args": [ ], @@ -55137,7 +58781,7 @@ }, { "name": "projectMembers", - "description": "Members of the project", + "description": "Members of the project.", "args": [ { "name": "search", @@ -55218,7 +58862,7 @@ }, { "name": "publicJobs", - "description": "Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts", + "description": "Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts.", "args": [ ], @@ -55232,7 +58876,7 @@ }, { "name": "release", - "description": "A single release of the project", + "description": "A single release of the project.", "args": [ { "name": "tagName", @@ -55259,7 +58903,7 @@ }, { "name": "releases", - "description": "Releases of the project", + "description": "Releases of the project.", "args": [ { "name": "sort", @@ -55322,7 +58966,7 @@ }, { "name": "removeSourceBranchAfterMerge", - "description": "Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project", + "description": "Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project.", "args": [ ], @@ -55336,7 +58980,7 @@ }, { "name": "repository", - "description": "Git repository of the project", + "description": "Git repository of the project.", "args": [ ], @@ -55350,7 +58994,7 @@ }, { "name": "repositorySizeExcess", - "description": "Size of repository that exceeds the limit in bytes", + "description": "Size of repository that exceeds the limit in bytes.", "args": [ ], @@ -55364,7 +59008,7 @@ }, { "name": "requestAccessEnabled", - "description": "Indicates if users can request member access to the project", + "description": "Indicates if users can request member access to the project.", "args": [ ], @@ -55378,7 +59022,7 @@ }, { "name": "requirement", - "description": "Find a single requirement", + "description": "Find a single requirement.", "args": [ { "name": "sort", @@ -55455,6 +59099,16 @@ } }, "defaultValue": null + }, + { + "name": "lastTestReportState", + "description": "The state of latest requirement test report.", + "type": { + "kind": "ENUM", + "name": "TestReportState", + "ofType": null + }, + "defaultValue": null } ], "type": { @@ -55467,7 +59121,7 @@ }, { "name": "requirementStatesCount", - "description": "Number of requirements for the project by their state", + "description": "Number of requirements for the project by their state.", "args": [ ], @@ -55481,7 +59135,7 @@ }, { "name": "requirements", - "description": "Find requirements", + "description": "Find requirements.", "args": [ { "name": "sort", @@ -55560,6 +59214,16 @@ "defaultValue": null }, { + "name": "lastTestReportState", + "description": "The state of latest requirement test report.", + "type": { + "kind": "ENUM", + "name": "TestReportState", + "ofType": null + }, + "defaultValue": null + }, + { "name": "after", "description": "Returns the elements in the list that come after the specified cursor.", "type": { @@ -55610,7 +59274,7 @@ }, { "name": "sastCiConfiguration", - "description": "SAST CI configuration for the project", + "description": "SAST CI configuration for the project.", "args": [ ], @@ -55624,7 +59288,7 @@ }, { "name": "securityDashboardPath", - "description": "Path to project's security dashboard", + "description": "Path to project's security dashboard.", "args": [ ], @@ -55638,7 +59302,7 @@ }, { "name": "securityScanners", - "description": "Information about security analyzers used in the project", + "description": "Information about security analyzers used in the project.", "args": [ ], @@ -55652,7 +59316,7 @@ }, { "name": "sentryDetailedError", - "description": "Detailed version of a Sentry error on the project", + "description": "Detailed version of a Sentry error on the project.", "args": [ { "name": "id", @@ -55679,7 +59343,7 @@ }, { "name": "sentryErrors", - "description": "Paginated collection of Sentry errors on the project", + "description": "Paginated collection of Sentry errors on the project.", "args": [ ], @@ -55721,7 +59385,7 @@ }, { "name": "services", - "description": "Project services", + "description": "Project services.", "args": [ { "name": "active", @@ -55794,7 +59458,7 @@ }, { "name": "sharedRunnersEnabled", - "description": "Indicates if shared runners are enabled for the project", + "description": "Indicates if shared runners are enabled for the project.", "args": [ ], @@ -55808,7 +59472,7 @@ }, { "name": "snippets", - "description": "Snippets of the project", + "description": "Snippets of the project.", "args": [ { "name": "ids", @@ -55903,7 +59567,7 @@ }, { "name": "squashReadOnly", - "description": "Indicates if squash readonly is enabled", + "description": "Indicates if `squashReadOnly` is enabled.", "args": [ ], @@ -55921,7 +59585,7 @@ }, { "name": "sshUrlToRepo", - "description": "URL to connect to the project via SSH", + "description": "URL to connect to the project via SSH.", "args": [ ], @@ -55935,7 +59599,7 @@ }, { "name": "starCount", - "description": "Number of times the project has been starred", + "description": "Number of times the project has been starred.", "args": [ ], @@ -55953,7 +59617,7 @@ }, { "name": "statistics", - "description": "Statistics of the project", + "description": "Statistics of the project.", "args": [ ], @@ -55967,7 +59631,7 @@ }, { "name": "suggestionCommitMessage", - "description": "The commit message used to apply merge request suggestions", + "description": "The commit message used to apply merge request suggestions.", "args": [ ], @@ -55981,7 +59645,7 @@ }, { "name": "tagList", - "description": "List of project topics (not Git tags)", + "description": "List of project topics (not Git tags).", "args": [ ], @@ -55994,8 +59658,35 @@ "deprecationReason": null }, { + "name": "terraformState", + "description": "Find a single Terraform state by name.", + "args": [ + { + "name": "name", + "description": "Name of the Terraform state.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "TerraformState", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "terraformStates", - "description": "Terraform states associated with the project", + "description": "Terraform states associated with the project.", "args": [ { "name": "after", @@ -56066,7 +59757,7 @@ }, { "name": "visibility", - "description": "Visibility of the project", + "description": "Visibility of the project.", "args": [ ], @@ -56080,7 +59771,7 @@ }, { "name": "vulnerabilities", - "description": "Vulnerabilities reported on the project", + "description": "Vulnerabilities reported on the project.", "args": [ { "name": "projectId", @@ -56253,7 +59944,7 @@ }, { "name": "vulnerabilitiesCountByDay", - "description": "Number of vulnerabilities per day for the project", + "description": "Number of vulnerabilities per day for the project.", "args": [ { "name": "startDate", @@ -56334,7 +60025,7 @@ }, { "name": "vulnerabilityScanners", - "description": "Vulnerability scanners reported on the project vulnerabilties", + "description": "Vulnerability scanners reported on the project vulnerabilities.", "args": [ { "name": "after", @@ -56387,7 +60078,7 @@ }, { "name": "vulnerabilitySeveritiesCount", - "description": "Counts for each vulnerability severity in the project", + "description": "Counts for each vulnerability severity in the project.", "args": [ { "name": "projectId", @@ -56490,7 +60181,7 @@ }, { "name": "webUrl", - "description": "Web URL of the project", + "description": "Web URL of the project.", "args": [ ], @@ -56708,7 +60399,7 @@ { "kind": "SCALAR", "name": "ProjectID", - "description": "Identifier of Project", + "description": "Identifier of Project.", "fields": null, "inputFields": null, "interfaces": null, @@ -56722,7 +60413,7 @@ "fields": [ { "name": "accessLevel", - "description": "GitLab::Access level", + "description": "GitLab::Access level.", "args": [ ], @@ -56736,7 +60427,7 @@ }, { "name": "createdAt", - "description": "Date and time the membership was created", + "description": "Date and time the membership was created.", "args": [ ], @@ -56750,7 +60441,7 @@ }, { "name": "createdBy", - "description": "User that authorized membership", + "description": "User that authorized membership.", "args": [ ], @@ -56764,7 +60455,7 @@ }, { "name": "expiresAt", - "description": "Date and time the membership expires", + "description": "Date and time the membership expires.", "args": [ ], @@ -56778,7 +60469,7 @@ }, { "name": "id", - "description": "ID of the member", + "description": "ID of the member.", "args": [ ], @@ -56796,7 +60487,7 @@ }, { "name": "project", - "description": "Project that User is a member of", + "description": "Project that User is a member of.", "args": [ ], @@ -56810,7 +60501,7 @@ }, { "name": "updatedAt", - "description": "Date and time the membership was last updated", + "description": "Date and time the membership was last updated.", "args": [ ], @@ -56824,7 +60515,7 @@ }, { "name": "user", - "description": "User that is associated with the member object", + "description": "User that is associated with the member object.", "args": [ ], @@ -57793,7 +61484,7 @@ "fields": [ { "name": "buildArtifactsSize", - "description": "Build artifacts size of the project in bytes", + "description": "Build artifacts size of the project in bytes.", "args": [ ], @@ -57811,7 +61502,7 @@ }, { "name": "commitCount", - "description": "Commit count of the project", + "description": "Commit count of the project.", "args": [ ], @@ -57829,7 +61520,7 @@ }, { "name": "lfsObjectsSize", - "description": "Large File Storage (LFS) object size of the project in bytes", + "description": "Large File Storage (LFS) object size of the project in bytes.", "args": [ ], @@ -57847,7 +61538,7 @@ }, { "name": "packagesSize", - "description": "Packages size of the project in bytes", + "description": "Packages size of the project in bytes.", "args": [ ], @@ -57865,7 +61556,7 @@ }, { "name": "repositorySize", - "description": "Repository size of the project in bytes", + "description": "Repository size of the project in bytes.", "args": [ ], @@ -57883,7 +61574,7 @@ }, { "name": "snippetsSize", - "description": "Snippets size of the project in bytes", + "description": "Snippets size of the project in bytes.", "args": [ ], @@ -57897,7 +61588,7 @@ }, { "name": "storageSize", - "description": "Storage size of the project in bytes", + "description": "Storage size of the project in bytes.", "args": [ ], @@ -57915,7 +61606,7 @@ }, { "name": "uploadsSize", - "description": "Uploads size of the project in bytes", + "description": "Uploads size of the project in bytes.", "args": [ ], @@ -57929,7 +61620,7 @@ }, { "name": "wikiSize", - "description": "Wiki size of the project in bytes", + "description": "Wiki size of the project in bytes.", "args": [ ], @@ -57956,7 +61647,7 @@ "fields": [ { "name": "humanizedText", - "description": "The human-readable text of the alert condition", + "description": "The human-readable text of the alert condition.", "args": [ ], @@ -57974,7 +61665,7 @@ }, { "name": "id", - "description": "ID of the alert condition", + "description": "ID of the alert condition.", "args": [ ], @@ -58355,7 +62046,7 @@ { "kind": "SCALAR", "name": "PrometheusServiceID", - "description": "Identifier of PrometheusService", + "description": "Identifier of PrometheusService.", "fields": null, "inputFields": null, "interfaces": null, @@ -58508,6 +62199,20 @@ "description": null, "fields": [ { + "name": "ciApplicationSettings", + "description": "CI related settings that apply to the entire instance.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "CiApplicationSettings", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "ciConfig", "description": "Get linted and processed contents of a CI config. Should not be requested more than once per request.", "args": [ @@ -58560,11 +62265,11 @@ }, { "name": "containerRepository", - "description": "Find a container repository", + "description": "Find a container repository.", "args": [ { "name": "id", - "description": "The global ID of the container repository", + "description": "The global ID of the container repository.", "type": { "kind": "NON_NULL", "name": null, @@ -58587,7 +62292,7 @@ }, { "name": "currentUser", - "description": "Get information about current user", + "description": "Get information about current user.", "args": [ ], @@ -58601,7 +62306,7 @@ }, { "name": "designManagement", - "description": "Fields related to design management", + "description": "Fields related to design management.", "args": [ ], @@ -58619,7 +62324,7 @@ }, { "name": "devopsAdoptionSegments", - "description": "Get configured DevOps adoption segments on the instance", + "description": "Get configured DevOps adoption segments on the instance.", "args": [ { "name": "after", @@ -58672,7 +62377,7 @@ }, { "name": "echo", - "description": "Text to echo back", + "description": "Text to echo back.", "args": [ { "name": "text", @@ -58703,7 +62408,7 @@ }, { "name": "geoNode", - "description": "Find a Geo node", + "description": "Find a Geo node.", "args": [ { "name": "name", @@ -58726,7 +62431,7 @@ }, { "name": "group", - "description": "Find a group", + "description": "Find a group.", "args": [ { "name": "fullPath", @@ -58753,7 +62458,7 @@ }, { "name": "instanceSecurityDashboard", - "description": "Fields related to Instance Security Dashboard", + "description": "Fields related to Instance Security Dashboard.", "args": [ ], @@ -58767,7 +62472,7 @@ }, { "name": "instanceStatisticsMeasurements", - "description": "Get statistics on the instance", + "description": "Get statistics on the instance.", "args": [ { "name": "identifier", @@ -58854,11 +62559,11 @@ }, { "name": "issue", - "description": "Find an issue", + "description": "Find an issue.", "args": [ { "name": "id", - "description": "The global ID of the Issue", + "description": "The global ID of the Issue.", "type": { "kind": "NON_NULL", "name": null, @@ -58881,11 +62586,11 @@ }, { "name": "iteration", - "description": "Find an iteration", + "description": "Find an iteration.", "args": [ { "name": "id", - "description": "Find an iteration by its ID", + "description": "Find an iteration by its ID.", "type": { "kind": "NON_NULL", "name": null, @@ -58908,7 +62613,7 @@ }, { "name": "metadata", - "description": "Metadata about GitLab", + "description": "Metadata about GitLab.", "args": [ ], @@ -58922,11 +62627,11 @@ }, { "name": "milestone", - "description": "Find a milestone", + "description": "Find a milestone.", "args": [ { "name": "id", - "description": "Find a milestone by its ID", + "description": "Find a milestone by its ID.", "type": { "kind": "NON_NULL", "name": null, @@ -58949,7 +62654,7 @@ }, { "name": "namespace", - "description": "Find a namespace", + "description": "Find a namespace.", "args": [ { "name": "fullPath", @@ -58975,8 +62680,8 @@ "deprecationReason": null }, { - "name": "packageComposerDetails", - "description": "Find a composer package", + "name": "package", + "description": "Find a package.", "args": [ { "name": "id", @@ -58995,7 +62700,7 @@ ], "type": { "kind": "OBJECT", - "name": "PackageComposerDetails", + "name": "Package", "ofType": null }, "isDeprecated": false, @@ -59003,7 +62708,7 @@ }, { "name": "project", - "description": "Find a project", + "description": "Find a project.", "args": [ { "name": "fullPath", @@ -59030,7 +62735,7 @@ }, { "name": "projects", - "description": "Find projects visible to the current user", + "description": "Find projects visible to the current user.", "args": [ { "name": "membership", @@ -59141,7 +62846,7 @@ }, { "name": "runnerPlatforms", - "description": "Supported runner platforms", + "description": "Supported runner platforms.", "args": [ { "name": "after", @@ -59194,7 +62899,7 @@ }, { "name": "runnerSetup", - "description": "Get runner setup instructions", + "description": "Get runner setup instructions.", "args": [ { "name": "platform", @@ -59255,7 +62960,7 @@ }, { "name": "snippets", - "description": "Find Snippets visible to the current user", + "description": "Find Snippets visible to the current user.", "args": [ { "name": "ids", @@ -59376,7 +63081,7 @@ }, { "name": "user", - "description": "Find a user", + "description": "Find a user.", "args": [ { "name": "id", @@ -59409,7 +63114,7 @@ }, { "name": "users", - "description": "Find users", + "description": "Find users.", "args": [ { "name": "ids", @@ -59528,7 +63233,7 @@ }, { "name": "vulnerabilities", - "description": "Vulnerabilities reported on projects on the current user's instance security dashboard", + "description": "Vulnerabilities reported on projects on the current user's instance security dashboard.", "args": [ { "name": "projectId", @@ -59701,7 +63406,7 @@ }, { "name": "vulnerabilitiesCountByDay", - "description": "Number of vulnerabilities per day for the projects on the current user's instance security dashboard", + "description": "Number of vulnerabilities per day for the projects on the current user's instance security dashboard.", "args": [ { "name": "startDate", @@ -59782,7 +63487,7 @@ }, { "name": "vulnerabilitiesCountByDayAndSeverity", - "description": "Number of vulnerabilities per severity level, per day, for the projects on the current user's instance security dashboard Deprecated in 13.3: Use `vulnerabilitiesCountByDay`.", + "description": "Number of vulnerabilities per severity level, per day, for the projects on the current user's instance security dashboard. Deprecated in 13.3: Use `vulnerabilitiesCountByDay`.", "args": [ { "name": "startDate", @@ -59863,11 +63568,11 @@ }, { "name": "vulnerability", - "description": "Find a vulnerability", + "description": "Find a vulnerability.", "args": [ { "name": "id", - "description": "The Global ID of the Vulnerability", + "description": "The Global ID of the Vulnerability.", "type": { "kind": "NON_NULL", "name": null, @@ -59938,7 +63643,7 @@ "fields": [ { "name": "assets", - "description": "Assets of the release", + "description": "Assets of the release.", "args": [ ], @@ -59952,7 +63657,7 @@ }, { "name": "author", - "description": "User that created the release", + "description": "User that created the release.", "args": [ ], @@ -59966,7 +63671,7 @@ }, { "name": "commit", - "description": "The commit associated with the release", + "description": "The commit associated with the release.", "args": [ ], @@ -59980,7 +63685,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the release was created", + "description": "Timestamp of when the release was created.", "args": [ ], @@ -59994,7 +63699,7 @@ }, { "name": "description", - "description": "Description (also known as \"release notes\") of the release", + "description": "Description (also known as \"release notes\") of the release.", "args": [ ], @@ -60022,7 +63727,7 @@ }, { "name": "evidences", - "description": "Evidence for the release", + "description": "Evidence for the release.", "args": [ { "name": "after", @@ -60075,7 +63780,7 @@ }, { "name": "links", - "description": "Links of the release", + "description": "Links of the release.", "args": [ ], @@ -60089,7 +63794,7 @@ }, { "name": "milestones", - "description": "Milestones associated to the release", + "description": "Milestones associated to the release.", "args": [ { "name": "after", @@ -60142,7 +63847,7 @@ }, { "name": "name", - "description": "Name of the release", + "description": "Name of the release.", "args": [ ], @@ -60156,7 +63861,7 @@ }, { "name": "releasedAt", - "description": "Timestamp of when the release was released", + "description": "Timestamp of when the release was released.", "args": [ ], @@ -60170,7 +63875,7 @@ }, { "name": "tagName", - "description": "Name of the tag associated with the release", + "description": "Name of the tag associated with the release.", "args": [ ], @@ -60184,7 +63889,7 @@ }, { "name": "tagPath", - "description": "Relative web path to the tag associated with the release", + "description": "Relative web path to the tag associated with the release.", "args": [ ], @@ -60198,7 +63903,7 @@ }, { "name": "upcomingRelease", - "description": "Indicates the release is an upcoming release", + "description": "Indicates the release is an upcoming release.", "args": [ ], @@ -60225,7 +63930,7 @@ "fields": [ { "name": "directAssetUrl", - "description": "Direct asset URL of the link", + "description": "Direct asset URL of the link.", "args": [ ], @@ -60239,7 +63944,7 @@ }, { "name": "external", - "description": "Indicates the link points to an external resource", + "description": "Indicates the link points to an external resource.", "args": [ ], @@ -60253,7 +63958,7 @@ }, { "name": "id", - "description": "ID of the link", + "description": "ID of the link.", "args": [ ], @@ -60271,7 +63976,7 @@ }, { "name": "linkType", - "description": "Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`", + "description": "Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`.", "args": [ ], @@ -60285,7 +63990,7 @@ }, { "name": "name", - "description": "Name of the link", + "description": "Name of the link.", "args": [ ], @@ -60299,7 +64004,7 @@ }, { "name": "url", - "description": "URL of the link", + "description": "URL of the link.", "args": [ ], @@ -60439,7 +64144,7 @@ "inputFields": [ { "name": "name", - "description": "Name of the asset link", + "description": "Name of the asset link.", "type": { "kind": "NON_NULL", "name": null, @@ -60453,7 +64158,7 @@ }, { "name": "url", - "description": "URL of the asset link", + "description": "URL of the asset link.", "type": { "kind": "NON_NULL", "name": null, @@ -60467,7 +64172,7 @@ }, { "name": "directAssetPath", - "description": "Relative path for a direct asset link", + "description": "Relative path for a direct asset link.", "type": { "kind": "SCALAR", "name": "String", @@ -60477,7 +64182,7 @@ }, { "name": "linkType", - "description": "The type of the asset link", + "description": "The type of the asset link.", "type": { "kind": "ENUM", "name": "ReleaseAssetLinkType", @@ -60532,7 +64237,7 @@ "fields": [ { "name": "count", - "description": "Number of assets of the release", + "description": "Number of assets of the release.", "args": [ ], @@ -60546,7 +64251,7 @@ }, { "name": "links", - "description": "Asset links of the release", + "description": "Asset links of the release.", "args": [ { "name": "after", @@ -60599,7 +64304,7 @@ }, { "name": "sources", - "description": "Sources of the release", + "description": "Sources of the release.", "args": [ { "name": "after", @@ -60666,7 +64371,7 @@ "inputFields": [ { "name": "links", - "description": "A list of asset links to associate to the release", + "description": "A list of asset links to associate to the release.", "type": { "kind": "LIST", "name": null, @@ -60694,7 +64399,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -61124,7 +64829,7 @@ "fields": [ { "name": "collectedAt", - "description": "Timestamp when the evidence was collected", + "description": "Timestamp when the evidence was collected.", "args": [ ], @@ -61138,7 +64843,7 @@ }, { "name": "filepath", - "description": "URL from where the evidence can be downloaded", + "description": "URL from where the evidence can be downloaded.", "args": [ ], @@ -61152,7 +64857,7 @@ }, { "name": "id", - "description": "ID of the evidence", + "description": "ID of the evidence.", "args": [ ], @@ -61170,7 +64875,7 @@ }, { "name": "sha", - "description": "SHA1 ID of the evidence hash", + "description": "SHA1 ID of the evidence hash.", "args": [ ], @@ -61309,7 +65014,7 @@ "fields": [ { "name": "closedIssuesUrl", - "description": "HTTP URL of the issues page, filtered by this release and `state=closed`", + "description": "HTTP URL of the issues page, filtered by this release and `state=closed`.", "args": [ ], @@ -61323,7 +65028,7 @@ }, { "name": "closedMergeRequestsUrl", - "description": "HTTP URL of the merge request page , filtered by this release and `state=closed`", + "description": "HTTP URL of the merge request page , filtered by this release and `state=closed`.", "args": [ ], @@ -61337,7 +65042,7 @@ }, { "name": "editUrl", - "description": "HTTP URL of the release's edit page", + "description": "HTTP URL of the release's edit page.", "args": [ ], @@ -61351,7 +65056,7 @@ }, { "name": "mergedMergeRequestsUrl", - "description": "HTTP URL of the merge request page , filtered by this release and `state=merged`", + "description": "HTTP URL of the merge request page , filtered by this release and `state=merged`.", "args": [ ], @@ -61365,7 +65070,7 @@ }, { "name": "openedIssuesUrl", - "description": "HTTP URL of the issues page, filtered by this release and `state=open`", + "description": "HTTP URL of the issues page, filtered by this release and `state=open`.", "args": [ ], @@ -61379,7 +65084,7 @@ }, { "name": "openedMergeRequestsUrl", - "description": "HTTP URL of the merge request page, filtered by this release and `state=open`", + "description": "HTTP URL of the merge request page, filtered by this release and `state=open`.", "args": [ ], @@ -61393,7 +65098,7 @@ }, { "name": "selfUrl", - "description": "HTTP URL of the release", + "description": "HTTP URL of the release.", "args": [ ], @@ -61455,7 +65160,7 @@ "fields": [ { "name": "format", - "description": "Format of the source", + "description": "Format of the source.", "args": [ ], @@ -61469,7 +65174,7 @@ }, { "name": "url", - "description": "Download URL of the source", + "description": "Download URL of the source.", "args": [ ], @@ -61787,7 +65492,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "type": { "kind": "NON_NULL", "name": null, @@ -61991,7 +65696,7 @@ }, { "name": "position", - "description": "The position of this note on a diff", + "description": "The position of this note on a diff.", "type": { "kind": "NON_NULL", "name": null, @@ -62092,7 +65797,7 @@ "fields": [ { "name": "empty", - "description": "Indicates repository has no visible content", + "description": "Indicates repository has no visible content.", "args": [ ], @@ -62110,7 +65815,7 @@ }, { "name": "exists", - "description": "Indicates a corresponding Git repository exists on disk", + "description": "Indicates a corresponding Git repository exists on disk.", "args": [ ], @@ -62128,7 +65833,7 @@ }, { "name": "rootRef", - "description": "Default branch of the repository", + "description": "Default branch of the repository.", "args": [ ], @@ -62142,7 +65847,7 @@ }, { "name": "tree", - "description": "Tree of the repository", + "description": "Tree of the repository.", "args": [ { "name": "path", @@ -62198,7 +65903,7 @@ "fields": [ { "name": "author", - "description": "Author of the requirement", + "description": "Author of the requirement.", "args": [ ], @@ -62216,7 +65921,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the requirement was created", + "description": "Timestamp of when the requirement was created.", "args": [ ], @@ -62234,7 +65939,7 @@ }, { "name": "description", - "description": "Description of the requirement", + "description": "Description of the requirement.", "args": [ ], @@ -62262,7 +65967,7 @@ }, { "name": "id", - "description": "ID of the requirement", + "description": "ID of the requirement.", "args": [ ], @@ -62280,7 +65985,7 @@ }, { "name": "iid", - "description": "Internal ID of the requirement", + "description": "Internal ID of the requirement.", "args": [ ], @@ -62298,7 +66003,7 @@ }, { "name": "lastTestReportManuallyCreated", - "description": "Indicates if latest test report was created by user", + "description": "Indicates if latest test report was created by user.", "args": [ ], @@ -62312,7 +66017,7 @@ }, { "name": "lastTestReportState", - "description": "Latest requirement test report state", + "description": "Latest requirement test report state.", "args": [ ], @@ -62326,7 +66031,7 @@ }, { "name": "project", - "description": "Project to which the requirement belongs", + "description": "Project to which the requirement belongs.", "args": [ ], @@ -62344,7 +66049,7 @@ }, { "name": "state", - "description": "State of the requirement", + "description": "State of the requirement.", "args": [ ], @@ -62362,7 +66067,7 @@ }, { "name": "testReports", - "description": "Test reports of the requirement", + "description": "Test reports of the requirement.", "args": [ { "name": "sort", @@ -62425,7 +66130,7 @@ }, { "name": "title", - "description": "Title of the requirement", + "description": "Title of the requirement.", "args": [ ], @@ -62453,7 +66158,7 @@ }, { "name": "updatedAt", - "description": "Timestamp of when the requirement was last updated", + "description": "Timestamp of when the requirement was last updated.", "args": [ ], @@ -62740,7 +66445,7 @@ "fields": [ { "name": "archived", - "description": "Number of archived requirements", + "description": "Number of archived requirements.", "args": [ ], @@ -62754,7 +66459,7 @@ }, { "name": "opened", - "description": "Number of opened requirements", + "description": "Number of opened requirements.", "args": [ ], @@ -62781,7 +66486,7 @@ "fields": [ { "name": "resolvable", - "description": "Indicates if the object can be resolved", + "description": "Indicates if the object can be resolved.", "args": [ ], @@ -62799,7 +66504,7 @@ }, { "name": "resolved", - "description": "Indicates if the object is resolved", + "description": "Indicates if the object is resolved.", "args": [ ], @@ -62817,7 +66522,7 @@ }, { "name": "resolvedAt", - "description": "Timestamp of when the object was resolved", + "description": "Timestamp of when the object was resolved.", "args": [ ], @@ -62831,7 +66536,7 @@ }, { "name": "resolvedBy", - "description": "User who resolved the object", + "description": "User who resolved the object.", "args": [ ], @@ -62969,7 +66674,7 @@ "fields": [ { "name": "buildArtifactsSize", - "description": "The CI artifacts size in bytes", + "description": "The CI artifacts size in bytes.", "args": [ ], @@ -62987,7 +66692,7 @@ }, { "name": "lfsObjectsSize", - "description": "The LFS objects size in bytes", + "description": "The LFS objects size in bytes.", "args": [ ], @@ -63005,7 +66710,7 @@ }, { "name": "packagesSize", - "description": "The packages size in bytes", + "description": "The packages size in bytes.", "args": [ ], @@ -63023,7 +66728,7 @@ }, { "name": "pipelineArtifactsSize", - "description": "The CI pipeline artifacts size in bytes", + "description": "The CI pipeline artifacts size in bytes.", "args": [ ], @@ -63041,7 +66746,7 @@ }, { "name": "repositorySize", - "description": "The Git repository size in bytes", + "description": "The Git repository size in bytes.", "args": [ ], @@ -63059,7 +66764,7 @@ }, { "name": "snippetsSize", - "description": "The snippets size in bytes", + "description": "The snippets size in bytes.", "args": [ ], @@ -63077,7 +66782,7 @@ }, { "name": "storageSize", - "description": "The total storage in bytes", + "description": "The total storage in bytes.", "args": [ ], @@ -63095,7 +66800,7 @@ }, { "name": "uploadsSize", - "description": "The uploads size in bytes", + "description": "The uploads size in bytes.", "args": [ ], @@ -63113,7 +66818,7 @@ }, { "name": "wikiSize", - "description": "The wiki size in bytes", + "description": "The wiki size in bytes.", "args": [ ], @@ -63288,7 +66993,7 @@ "fields": [ { "name": "downloadLocation", - "description": "Download location for the runner for the platform architecture", + "description": "Download location for the runner for the platform architecture.", "args": [ ], @@ -63306,7 +67011,7 @@ }, { "name": "name", - "description": "Name of the runner platform architecture", + "description": "Name of the runner platform architecture.", "args": [ ], @@ -63449,7 +67154,7 @@ "fields": [ { "name": "architectures", - "description": "Runner architectures supported for the platform", + "description": "Runner architectures supported for the platform.", "args": [ { "name": "after", @@ -63502,7 +67207,7 @@ }, { "name": "humanReadableName", - "description": "Human readable name of the runner platform", + "description": "Human readable name of the runner platform.", "args": [ ], @@ -63520,7 +67225,7 @@ }, { "name": "name", - "description": "Name slug of the runner platform", + "description": "Name slug of the runner platform.", "args": [ ], @@ -63663,7 +67368,7 @@ "fields": [ { "name": "installInstructions", - "description": "Instructions for installing the runner on the specified architecture", + "description": "Instructions for installing the runner on the specified architecture.", "args": [ ], @@ -63681,7 +67386,7 @@ }, { "name": "registerInstructions", - "description": "Instructions for registering the runner", + "description": "Instructions for registering the runner.", "args": [ ], @@ -63880,7 +67585,7 @@ "fields": [ { "name": "description", - "description": "Analyzer description that is displayed on the form", + "description": "Analyzer description that is displayed on the form.", "args": [ ], @@ -63894,7 +67599,7 @@ }, { "name": "enabled", - "description": "Indicates whether an analyzer is enabled", + "description": "Indicates whether an analyzer is enabled.", "args": [ ], @@ -63908,7 +67613,7 @@ }, { "name": "label", - "description": "Analyzer label used in the config UI", + "description": "Analyzer label used in the config UI.", "args": [ ], @@ -63922,7 +67627,7 @@ }, { "name": "name", - "description": "Name of the analyzer", + "description": "Name of the analyzer.", "args": [ ], @@ -63936,7 +67641,7 @@ }, { "name": "variables", - "description": "List of supported variables", + "description": "List of supported variables.", "args": [ { "name": "after", @@ -64115,7 +67820,7 @@ "inputFields": [ { "name": "name", - "description": "Name of analyzer", + "description": "Name of analyzer.", "type": { "kind": "NON_NULL", "name": null, @@ -64129,7 +67834,7 @@ }, { "name": "enabled", - "description": "State of the analyzer", + "description": "State of the analyzer.", "type": { "kind": "NON_NULL", "name": null, @@ -64143,7 +67848,7 @@ }, { "name": "variables", - "description": "List of variables for the analyzer", + "description": "List of variables for the analyzer.", "type": { "kind": "LIST", "name": null, @@ -64448,7 +68153,7 @@ "inputFields": [ { "name": "field", - "description": "CI keyword of entity", + "description": "CI keyword of entity.", "type": { "kind": "NON_NULL", "name": null, @@ -64462,7 +68167,7 @@ }, { "name": "defaultValue", - "description": "Default value that is used if value is empty", + "description": "Default value that is used if value is empty.", "type": { "kind": "NON_NULL", "name": null, @@ -64476,7 +68181,7 @@ }, { "name": "value", - "description": "Current value of the entity", + "description": "Current value of the entity.", "type": { "kind": "NON_NULL", "name": null, @@ -64501,7 +68206,7 @@ "inputFields": [ { "name": "global", - "description": "List of global entities related to SAST configuration", + "description": "List of global entities related to SAST configuration.", "type": { "kind": "LIST", "name": null, @@ -64519,7 +68224,7 @@ }, { "name": "pipeline", - "description": "List of pipeline entities related to SAST configuration", + "description": "List of pipeline entities related to SAST configuration.", "type": { "kind": "LIST", "name": null, @@ -64537,7 +68242,7 @@ }, { "name": "analyzers", - "description": "List of analyzers and related variables for the SAST configuration", + "description": "List of analyzers and related variables for the SAST configuration.", "type": { "kind": "LIST", "name": null, @@ -64747,7 +68452,7 @@ "fields": [ { "name": "requestMethod", - "description": "The HTTP request method used to access the URL", + "description": "The HTTP request method used to access the URL.", "args": [ ], @@ -64761,7 +68466,7 @@ }, { "name": "url", - "description": "The URL scanned by the scanner", + "description": "The URL scanned by the scanner.", "args": [ ], @@ -64900,7 +68605,7 @@ "fields": [ { "name": "apiFuzzing", - "description": "Aggregated counts for the api_fuzzing scan", + "description": "Aggregated counts for the `api_fuzzing` scan", "args": [ ], @@ -64914,7 +68619,7 @@ }, { "name": "containerScanning", - "description": "Aggregated counts for the container_scanning scan", + "description": "Aggregated counts for the `container_scanning` scan", "args": [ ], @@ -64928,7 +68633,7 @@ }, { "name": "coverageFuzzing", - "description": "Aggregated counts for the coverage_fuzzing scan", + "description": "Aggregated counts for the `coverage_fuzzing` scan", "args": [ ], @@ -64942,7 +68647,7 @@ }, { "name": "dast", - "description": "Aggregated counts for the dast scan", + "description": "Aggregated counts for the `dast` scan", "args": [ ], @@ -64956,7 +68661,7 @@ }, { "name": "dependencyScanning", - "description": "Aggregated counts for the dependency_scanning scan", + "description": "Aggregated counts for the `dependency_scanning` scan", "args": [ ], @@ -64970,7 +68675,7 @@ }, { "name": "sast", - "description": "Aggregated counts for the sast scan", + "description": "Aggregated counts for the `sast` scan", "args": [ ], @@ -64984,7 +68689,7 @@ }, { "name": "secretDetection", - "description": "Aggregated counts for the secret_detection scan", + "description": "Aggregated counts for the `secret_detection` scan", "args": [ ], @@ -65011,7 +68716,7 @@ "fields": [ { "name": "scannedResources", - "description": "A list of the first 20 scanned resources", + "description": "A list of the first 20 scanned resources.", "args": [ { "name": "after", @@ -65064,7 +68769,7 @@ }, { "name": "scannedResourcesCount", - "description": "Total number of scanned resources", + "description": "Total number of scanned resources.", "args": [ ], @@ -65078,7 +68783,7 @@ }, { "name": "scannedResourcesCsvPath", - "description": "Path to download all the scanned resources in CSV format", + "description": "Path to download all the scanned resources in CSV format.", "args": [ ], @@ -65092,7 +68797,7 @@ }, { "name": "vulnerabilitiesCount", - "description": "Total number of vulnerabilities", + "description": "Total number of vulnerabilities.", "args": [ ], @@ -65304,7 +69009,7 @@ "fields": [ { "name": "count", - "description": "Count of occurrences", + "description": "Count of occurrences.", "args": [ ], @@ -65322,7 +69027,7 @@ }, { "name": "culprit", - "description": "Culprit of the error", + "description": "Culprit of the error.", "args": [ ], @@ -65340,7 +69045,7 @@ }, { "name": "externalBaseUrl", - "description": "External Base URL of the Sentry Instance", + "description": "External Base URL of the Sentry Instance.", "args": [ ], @@ -65358,7 +69063,7 @@ }, { "name": "externalUrl", - "description": "External URL of the error", + "description": "External URL of the error.", "args": [ ], @@ -65376,7 +69081,7 @@ }, { "name": "firstReleaseLastCommit", - "description": "Commit the error was first seen", + "description": "Commit the error was first seen.", "args": [ ], @@ -65390,7 +69095,7 @@ }, { "name": "firstReleaseShortVersion", - "description": "Release short version the error was first seen", + "description": "Release short version the error was first seen.", "args": [ ], @@ -65404,7 +69109,7 @@ }, { "name": "firstReleaseVersion", - "description": "Release version the error was first seen", + "description": "Release version the error was first seen.", "args": [ ], @@ -65418,7 +69123,7 @@ }, { "name": "firstSeen", - "description": "Timestamp when the error was first seen", + "description": "Timestamp when the error was first seen.", "args": [ ], @@ -65436,7 +69141,7 @@ }, { "name": "frequency", - "description": "Last 24hr stats of the error", + "description": "Last 24hr stats of the error.", "args": [ ], @@ -65462,7 +69167,7 @@ }, { "name": "gitlabCommit", - "description": "GitLab commit SHA attributed to the Error based on the release version", + "description": "GitLab commit SHA attributed to the Error based on the release version.", "args": [ ], @@ -65476,7 +69181,7 @@ }, { "name": "gitlabCommitPath", - "description": "Path to the GitLab page for the GitLab commit attributed to the error", + "description": "Path to the GitLab page for the GitLab commit attributed to the error.", "args": [ ], @@ -65490,7 +69195,7 @@ }, { "name": "gitlabIssuePath", - "description": "URL of GitLab Issue", + "description": "URL of GitLab Issue.", "args": [ ], @@ -65504,7 +69209,7 @@ }, { "name": "id", - "description": "ID (global ID) of the error", + "description": "ID (global ID) of the error.", "args": [ ], @@ -65522,7 +69227,7 @@ }, { "name": "lastReleaseLastCommit", - "description": "Commit the error was last seen", + "description": "Commit the error was last seen.", "args": [ ], @@ -65536,7 +69241,7 @@ }, { "name": "lastReleaseShortVersion", - "description": "Release short version the error was last seen", + "description": "Release short version the error was last seen.", "args": [ ], @@ -65550,7 +69255,7 @@ }, { "name": "lastReleaseVersion", - "description": "Release version the error was last seen", + "description": "Release version the error was last seen.", "args": [ ], @@ -65564,7 +69269,7 @@ }, { "name": "lastSeen", - "description": "Timestamp when the error was last seen", + "description": "Timestamp when the error was last seen.", "args": [ ], @@ -65582,7 +69287,7 @@ }, { "name": "message", - "description": "Sentry metadata message of the error", + "description": "Sentry metadata message of the error.", "args": [ ], @@ -65596,7 +69301,7 @@ }, { "name": "sentryId", - "description": "ID (Sentry ID) of the error", + "description": "ID (Sentry ID) of the error.", "args": [ ], @@ -65614,7 +69319,7 @@ }, { "name": "sentryProjectId", - "description": "ID of the project (Sentry project)", + "description": "ID of the project (Sentry project).", "args": [ ], @@ -65632,7 +69337,7 @@ }, { "name": "sentryProjectName", - "description": "Name of the project affected by the error", + "description": "Name of the project affected by the error.", "args": [ ], @@ -65650,7 +69355,7 @@ }, { "name": "sentryProjectSlug", - "description": "Slug of the project affected by the error", + "description": "Slug of the project affected by the error.", "args": [ ], @@ -65668,7 +69373,7 @@ }, { "name": "shortId", - "description": "Short ID (Sentry ID) of the error", + "description": "Short ID (Sentry ID) of the error.", "args": [ ], @@ -65686,7 +69391,7 @@ }, { "name": "status", - "description": "Status of the error", + "description": "Status of the error.", "args": [ ], @@ -65704,7 +69409,7 @@ }, { "name": "tags", - "description": "Tags associated with the Sentry Error", + "description": "Tags associated with the Sentry Error.", "args": [ ], @@ -65722,7 +69427,7 @@ }, { "name": "title", - "description": "Title of the error", + "description": "Title of the error.", "args": [ ], @@ -65740,7 +69445,7 @@ }, { "name": "type", - "description": "Type of the error", + "description": "Type of the error.", "args": [ ], @@ -65758,7 +69463,7 @@ }, { "name": "userCount", - "description": "Count of users affected by the error", + "description": "Count of users affected by the error.", "args": [ ], @@ -65789,7 +69494,7 @@ "fields": [ { "name": "count", - "description": "Count of occurrences", + "description": "Count of occurrences.", "args": [ ], @@ -65807,7 +69512,7 @@ }, { "name": "culprit", - "description": "Culprit of the error", + "description": "Culprit of the error.", "args": [ ], @@ -65825,7 +69530,7 @@ }, { "name": "externalUrl", - "description": "External URL of the error", + "description": "External URL of the error.", "args": [ ], @@ -65843,7 +69548,7 @@ }, { "name": "firstSeen", - "description": "Timestamp when the error was first seen", + "description": "Timestamp when the error was first seen.", "args": [ ], @@ -65861,7 +69566,7 @@ }, { "name": "frequency", - "description": "Last 24hr stats of the error", + "description": "Last 24hr stats of the error.", "args": [ ], @@ -65887,7 +69592,7 @@ }, { "name": "id", - "description": "ID (global ID) of the error", + "description": "ID (global ID) of the error.", "args": [ ], @@ -65905,7 +69610,7 @@ }, { "name": "lastSeen", - "description": "Timestamp when the error was last seen", + "description": "Timestamp when the error was last seen.", "args": [ ], @@ -65923,7 +69628,7 @@ }, { "name": "message", - "description": "Sentry metadata message of the error", + "description": "Sentry metadata message of the error.", "args": [ ], @@ -65937,7 +69642,7 @@ }, { "name": "sentryId", - "description": "ID (Sentry ID) of the error", + "description": "ID (Sentry ID) of the error.", "args": [ ], @@ -65955,7 +69660,7 @@ }, { "name": "sentryProjectId", - "description": "ID of the project (Sentry project)", + "description": "ID of the project (Sentry project).", "args": [ ], @@ -65973,7 +69678,7 @@ }, { "name": "sentryProjectName", - "description": "Name of the project affected by the error", + "description": "Name of the project affected by the error.", "args": [ ], @@ -65991,7 +69696,7 @@ }, { "name": "sentryProjectSlug", - "description": "Slug of the project affected by the error", + "description": "Slug of the project affected by the error.", "args": [ ], @@ -66009,7 +69714,7 @@ }, { "name": "shortId", - "description": "Short ID (Sentry ID) of the error", + "description": "Short ID (Sentry ID) of the error.", "args": [ ], @@ -66027,7 +69732,7 @@ }, { "name": "status", - "description": "Status of the error", + "description": "Status of the error.", "args": [ ], @@ -66045,7 +69750,7 @@ }, { "name": "title", - "description": "Title of the error", + "description": "Title of the error.", "args": [ ], @@ -66063,7 +69768,7 @@ }, { "name": "type", - "description": "Type of the error", + "description": "Type of the error.", "args": [ ], @@ -66081,7 +69786,7 @@ }, { "name": "userCount", - "description": "Count of users affected by the error", + "description": "Count of users affected by the error.", "args": [ ], @@ -66112,7 +69817,7 @@ "fields": [ { "name": "detailedError", - "description": "Detailed version of a Sentry error on the project", + "description": "Detailed version of a Sentry error on the project.", "args": [ { "name": "id", @@ -66139,7 +69844,7 @@ }, { "name": "errorStackTrace", - "description": "Stack Trace of Sentry Error", + "description": "Stack Trace of Sentry Error.", "args": [ { "name": "id", @@ -66166,7 +69871,7 @@ }, { "name": "errors", - "description": "Collection of Sentry Errors", + "description": "Collection of Sentry Errors.", "args": [ { "name": "searchTerm", @@ -66239,7 +69944,7 @@ }, { "name": "externalUrl", - "description": "External URL for Sentry", + "description": "External URL for Sentry.", "args": [ ], @@ -66378,7 +70083,7 @@ "fields": [ { "name": "count", - "description": "Count of errors received since the previously recorded time", + "description": "Count of errors received since the previously recorded time.", "args": [ ], @@ -66396,7 +70101,7 @@ }, { "name": "time", - "description": "Time the error frequency stats were recorded", + "description": "Time the error frequency stats were recorded.", "args": [ ], @@ -66427,7 +70132,7 @@ "fields": [ { "name": "dateReceived", - "description": "Time the stack trace was received by Sentry", + "description": "Time the stack trace was received by Sentry.", "args": [ ], @@ -66445,7 +70150,7 @@ }, { "name": "issueId", - "description": "ID of the Sentry error", + "description": "ID of the Sentry error.", "args": [ ], @@ -66463,7 +70168,7 @@ }, { "name": "stackTraceEntries", - "description": "Stack trace entries for the Sentry error", + "description": "Stack trace entries for the Sentry error.", "args": [ ], @@ -66502,7 +70207,7 @@ "fields": [ { "name": "code", - "description": "Code number of the context", + "description": "Code number of the context.", "args": [ ], @@ -66520,7 +70225,7 @@ }, { "name": "line", - "description": "Line number of the context", + "description": "Line number of the context.", "args": [ ], @@ -66551,7 +70256,7 @@ "fields": [ { "name": "col", - "description": "Function in which the Sentry error occurred", + "description": "Function in which the Sentry error occurred.", "args": [ ], @@ -66565,7 +70270,7 @@ }, { "name": "fileName", - "description": "File in which the Sentry error occurred", + "description": "File in which the Sentry error occurred.", "args": [ ], @@ -66579,7 +70284,7 @@ }, { "name": "function", - "description": "Function in which the Sentry error occurred", + "description": "Function in which the Sentry error occurred.", "args": [ ], @@ -66593,7 +70298,7 @@ }, { "name": "line", - "description": "Function in which the Sentry error occurred", + "description": "Function in which the Sentry error occurred.", "args": [ ], @@ -66607,7 +70312,7 @@ }, { "name": "traceContext", - "description": "Context of the Sentry error", + "description": "Context of the Sentry error.", "args": [ ], @@ -66677,7 +70382,7 @@ "fields": [ { "name": "level", - "description": "Severity level of the Sentry Error", + "description": "Severity level of the Sentry Error.", "args": [ ], @@ -66691,7 +70396,7 @@ }, { "name": "logger", - "description": "Logger of the Sentry Error", + "description": "Logger of the Sentry Error.", "args": [ ], @@ -66718,7 +70423,7 @@ "fields": [ { "name": "active", - "description": "Indicates if the service is active", + "description": "Indicates if the service is active.", "args": [ ], @@ -66732,7 +70437,7 @@ }, { "name": "type", - "description": "Class name of the service", + "description": "Class name of the service.", "args": [ ], @@ -66883,217 +70588,217 @@ "enumValues": [ { "name": "ASANA_SERVICE", - "description": null, + "description": "AsanaService type", "isDeprecated": false, "deprecationReason": null }, { "name": "ASSEMBLA_SERVICE", - "description": null, + "description": "AssemblaService type", "isDeprecated": false, "deprecationReason": null }, { "name": "BAMBOO_SERVICE", - "description": null, + "description": "BambooService type", "isDeprecated": false, "deprecationReason": null }, { "name": "BUGZILLA_SERVICE", - "description": null, + "description": "BugzillaService type", "isDeprecated": false, "deprecationReason": null }, { "name": "BUILDKITE_SERVICE", - "description": null, + "description": "BuildkiteService type", "isDeprecated": false, "deprecationReason": null }, { "name": "CAMPFIRE_SERVICE", - "description": null, + "description": "CampfireService type", "isDeprecated": false, "deprecationReason": null }, { "name": "CONFLUENCE_SERVICE", - "description": null, + "description": "ConfluenceService type", "isDeprecated": false, "deprecationReason": null }, { "name": "CUSTOM_ISSUE_TRACKER_SERVICE", - "description": null, + "description": "CustomIssueTrackerService type", "isDeprecated": false, "deprecationReason": null }, { "name": "DATADOG_SERVICE", - "description": null, + "description": "DatadogService type", "isDeprecated": false, "deprecationReason": null }, { "name": "DISCORD_SERVICE", - "description": null, + "description": "DiscordService type", "isDeprecated": false, "deprecationReason": null }, { "name": "DRONE_CI_SERVICE", - "description": null, + "description": "DroneCiService type", "isDeprecated": false, "deprecationReason": null }, { "name": "EMAILS_ON_PUSH_SERVICE", - "description": null, + "description": "EmailsOnPushService type", "isDeprecated": false, "deprecationReason": null }, { "name": "EWM_SERVICE", - "description": null, + "description": "EwmService type", "isDeprecated": false, "deprecationReason": null }, { "name": "EXTERNAL_WIKI_SERVICE", - "description": null, + "description": "ExternalWikiService type", "isDeprecated": false, "deprecationReason": null }, { "name": "FLOWDOCK_SERVICE", - "description": null, + "description": "FlowdockService type", "isDeprecated": false, "deprecationReason": null }, { "name": "GITHUB_SERVICE", - "description": null, + "description": "GithubService type", "isDeprecated": false, "deprecationReason": null }, { "name": "HANGOUTS_CHAT_SERVICE", - "description": null, + "description": "HangoutsChatService type", "isDeprecated": false, "deprecationReason": null }, { "name": "HIPCHAT_SERVICE", - "description": null, + "description": "HipchatService type", "isDeprecated": false, "deprecationReason": null }, { "name": "IRKER_SERVICE", - "description": null, + "description": "IrkerService type", "isDeprecated": false, "deprecationReason": null }, { "name": "JENKINS_SERVICE", - "description": null, + "description": "JenkinsService type", "isDeprecated": false, "deprecationReason": null }, { "name": "JIRA_SERVICE", - "description": null, + "description": "JiraService type", "isDeprecated": false, "deprecationReason": null }, { "name": "MATTERMOST_SERVICE", - "description": null, + "description": "MattermostService type", "isDeprecated": false, "deprecationReason": null }, { "name": "MATTERMOST_SLASH_COMMANDS_SERVICE", - "description": null, + "description": "MattermostSlashCommandsService type", "isDeprecated": false, "deprecationReason": null }, { "name": "MICROSOFT_TEAMS_SERVICE", - "description": null, + "description": "MicrosoftTeamsService type", "isDeprecated": false, "deprecationReason": null }, { "name": "PACKAGIST_SERVICE", - "description": null, + "description": "PackagistService type", "isDeprecated": false, "deprecationReason": null }, { "name": "PIPELINES_EMAIL_SERVICE", - "description": null, + "description": "PipelinesEmailService type", "isDeprecated": false, "deprecationReason": null }, { "name": "PIVOTALTRACKER_SERVICE", - "description": null, + "description": "PivotaltrackerService type", "isDeprecated": false, "deprecationReason": null }, { "name": "PROMETHEUS_SERVICE", - "description": null, + "description": "PrometheusService type", "isDeprecated": false, "deprecationReason": null }, { "name": "PUSHOVER_SERVICE", - "description": null, + "description": "PushoverService type", "isDeprecated": false, "deprecationReason": null }, { "name": "REDMINE_SERVICE", - "description": null, + "description": "RedmineService type", "isDeprecated": false, "deprecationReason": null }, { "name": "SLACK_SERVICE", - "description": null, + "description": "SlackService type", "isDeprecated": false, "deprecationReason": null }, { "name": "SLACK_SLASH_COMMANDS_SERVICE", - "description": null, + "description": "SlackSlashCommandsService type", "isDeprecated": false, "deprecationReason": null }, { "name": "TEAMCITY_SERVICE", - "description": null, + "description": "TeamcityService type", "isDeprecated": false, "deprecationReason": null }, { "name": "UNIFY_CIRCUIT_SERVICE", - "description": null, + "description": "UnifyCircuitService type", "isDeprecated": false, "deprecationReason": null }, { "name": "WEBEX_TEAMS_SERVICE", - "description": null, + "description": "WebexTeamsService type", "isDeprecated": false, "deprecationReason": null }, { "name": "YOUTRACK_SERVICE", - "description": null, + "description": "YoutrackService type", "isDeprecated": false, "deprecationReason": null } @@ -67107,7 +70812,7 @@ "fields": [ { "name": "author", - "description": "The owner of the snippet", + "description": "The owner of the snippet.", "args": [ ], @@ -67121,7 +70826,7 @@ }, { "name": "blob", - "description": "Snippet blob Deprecated in 13.3: Use `blobs`.", + "description": "Snippet blob. Deprecated in 13.3: Use `blobs`.", "args": [ ], @@ -67139,7 +70844,7 @@ }, { "name": "blobs", - "description": "Snippet blobs", + "description": "Snippet blobs.", "args": [ { "name": "paths", @@ -67210,7 +70915,7 @@ }, { "name": "createdAt", - "description": "Timestamp this snippet was created", + "description": "Timestamp this snippet was created.", "args": [ ], @@ -67228,7 +70933,7 @@ }, { "name": "description", - "description": "Description of the snippet", + "description": "Description of the snippet.", "args": [ ], @@ -67256,7 +70961,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -67313,7 +71018,7 @@ }, { "name": "fileName", - "description": "File Name of the snippet", + "description": "File Name of the snippet.", "args": [ ], @@ -67327,7 +71032,7 @@ }, { "name": "httpUrlToRepo", - "description": "HTTP URL to the snippet repository", + "description": "HTTP URL to the snippet repository.", "args": [ ], @@ -67341,7 +71046,7 @@ }, { "name": "id", - "description": "ID of the snippet", + "description": "ID of the snippet.", "args": [ ], @@ -67359,7 +71064,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -67416,7 +71121,7 @@ }, { "name": "project", - "description": "The project the snippet is associated with", + "description": "The project the snippet is associated with.", "args": [ ], @@ -67430,7 +71135,7 @@ }, { "name": "rawUrl", - "description": "Raw URL of the snippet", + "description": "Raw URL of the snippet.", "args": [ ], @@ -67448,7 +71153,7 @@ }, { "name": "sshUrlToRepo", - "description": "SSH URL to the snippet repository", + "description": "SSH URL to the snippet repository.", "args": [ ], @@ -67462,7 +71167,7 @@ }, { "name": "title", - "description": "Title of the snippet", + "description": "Title of the snippet.", "args": [ ], @@ -67480,7 +71185,7 @@ }, { "name": "updatedAt", - "description": "Timestamp this snippet was updated", + "description": "Timestamp this snippet was updated.", "args": [ ], @@ -67516,7 +71221,7 @@ }, { "name": "visibilityLevel", - "description": "Visibility Level of the snippet", + "description": "Visibility Level of the snippet.", "args": [ ], @@ -67534,7 +71239,7 @@ }, { "name": "webUrl", - "description": "Web URL of the snippet", + "description": "Web URL of the snippet.", "args": [ ], @@ -67569,7 +71274,7 @@ "fields": [ { "name": "binary", - "description": "Shows whether the blob is binary", + "description": "Shows whether the blob is binary.", "args": [ ], @@ -67587,7 +71292,7 @@ }, { "name": "externalStorage", - "description": "Blob external storage", + "description": "Blob external storage.", "args": [ ], @@ -67601,7 +71306,7 @@ }, { "name": "mode", - "description": "Blob mode", + "description": "Blob mode.", "args": [ ], @@ -67615,7 +71320,7 @@ }, { "name": "name", - "description": "Blob name", + "description": "Blob name.", "args": [ ], @@ -67629,7 +71334,7 @@ }, { "name": "path", - "description": "Blob path", + "description": "Blob path.", "args": [ ], @@ -67643,7 +71348,7 @@ }, { "name": "plainData", - "description": "Blob plain highlighted data", + "description": "Blob plain highlighted data.", "args": [ ], @@ -67657,7 +71362,7 @@ }, { "name": "rawPath", - "description": "Blob raw content endpoint path", + "description": "Blob raw content endpoint path.", "args": [ ], @@ -67675,7 +71380,7 @@ }, { "name": "renderedAsText", - "description": "Shows whether the blob is rendered as text", + "description": "Shows whether the blob is rendered as text.", "args": [ ], @@ -67693,7 +71398,7 @@ }, { "name": "richData", - "description": "Blob highlighted data", + "description": "Blob highlighted data.", "args": [ ], @@ -67707,7 +71412,7 @@ }, { "name": "richViewer", - "description": "Blob content rich viewer", + "description": "Blob content rich viewer.", "args": [ ], @@ -67721,7 +71426,7 @@ }, { "name": "simpleViewer", - "description": "Blob content simple viewer", + "description": "Blob content simple viewer.", "args": [ ], @@ -67739,7 +71444,7 @@ }, { "name": "size", - "description": "Blob size", + "description": "Blob size.", "args": [ ], @@ -67806,7 +71511,7 @@ "inputFields": [ { "name": "action", - "description": "Type of input action", + "description": "Type of input action.", "type": { "kind": "NON_NULL", "name": null, @@ -67820,7 +71525,7 @@ }, { "name": "previousPath", - "description": "Previous path of the snippet file", + "description": "Previous path of the snippet file.", "type": { "kind": "SCALAR", "name": "String", @@ -67830,7 +71535,7 @@ }, { "name": "filePath", - "description": "Path of the snippet file", + "description": "Path of the snippet file.", "type": { "kind": "NON_NULL", "name": null, @@ -67844,7 +71549,7 @@ }, { "name": "content", - "description": "Snippet file content", + "description": "Snippet file content.", "type": { "kind": "SCALAR", "name": "String", @@ -67976,7 +71681,7 @@ "fields": [ { "name": "collapsed", - "description": "Shows whether the blob should be displayed collapsed", + "description": "Shows whether the blob should be displayed collapsed.", "args": [ ], @@ -67994,7 +71699,7 @@ }, { "name": "fileType", - "description": "Content file type", + "description": "Content file type.", "args": [ ], @@ -68012,7 +71717,7 @@ }, { "name": "loadAsync", - "description": "Shows whether the blob content is loaded async", + "description": "Shows whether the blob content is loaded asynchronously.", "args": [ ], @@ -68030,7 +71735,7 @@ }, { "name": "loadingPartialName", - "description": "Loading partial name", + "description": "Loading partial name.", "args": [ ], @@ -68048,7 +71753,7 @@ }, { "name": "renderError", - "description": "Error rendering the blob content", + "description": "Error rendering the blob content.", "args": [ ], @@ -68062,7 +71767,7 @@ }, { "name": "tooLarge", - "description": "Shows whether the blob too large to be displayed", + "description": "Shows whether the blob too large to be displayed.", "args": [ ], @@ -68080,7 +71785,7 @@ }, { "name": "type", - "description": "Type of blob viewer", + "description": "Type of blob viewer.", "args": [ ], @@ -68219,7 +71924,7 @@ { "kind": "SCALAR", "name": "SnippetID", - "description": "Identifier of Snippet", + "description": "Identifier of Snippet.", "fields": null, "inputFields": null, "interfaces": null, @@ -68442,7 +72147,7 @@ }, { "name": "snippetRepositoryId", - "description": "ID of the Snippet Repository", + "description": "ID of the Snippet Repository.", "args": [ ], @@ -68658,7 +72363,7 @@ "fields": [ { "name": "buttonTitle", - "description": "Title for the button, for example: Retry this job", + "description": "Title for the button, for example: Retry this job.", "args": [ ], @@ -68672,7 +72377,7 @@ }, { "name": "icon", - "description": "Icon used in the action button", + "description": "Icon used in the action button.", "args": [ ], @@ -68686,7 +72391,7 @@ }, { "name": "method", - "description": "Method for the action, for example: :post", + "description": "Method for the action, for example: :post.", "args": [ ], @@ -68700,7 +72405,7 @@ }, { "name": "path", - "description": "Path for the action", + "description": "Path for the action.", "args": [ ], @@ -68714,7 +72419,7 @@ }, { "name": "title", - "description": "Title for the action, for example: Retry", + "description": "Title for the action, for example: Retry.", "args": [ ], @@ -68751,7 +72456,7 @@ "fields": [ { "name": "flatPath", - "description": "Flat path of the entry", + "description": "Flat path of the entry.", "args": [ ], @@ -68769,7 +72474,7 @@ }, { "name": "id", - "description": "ID of the entry", + "description": "ID of the entry.", "args": [ ], @@ -68787,7 +72492,7 @@ }, { "name": "name", - "description": "Name of the entry", + "description": "Name of the entry.", "args": [ ], @@ -68805,7 +72510,7 @@ }, { "name": "path", - "description": "Path of the entry", + "description": "Path of the entry.", "args": [ ], @@ -68823,7 +72528,7 @@ }, { "name": "sha", - "description": "Last commit sha for the entry", + "description": "Last commit SHA for the entry.", "args": [ ], @@ -68841,7 +72546,7 @@ }, { "name": "treeUrl", - "description": "Tree URL for the sub-module", + "description": "Tree URL for the sub-module.", "args": [ ], @@ -68855,7 +72560,7 @@ }, { "name": "type", - "description": "Type of tree entry", + "description": "Type of tree entry.", "args": [ ], @@ -68873,7 +72578,7 @@ }, { "name": "webUrl", - "description": "Web URL for the sub-module", + "description": "Web URL for the sub-module.", "args": [ ], @@ -69016,7 +72721,7 @@ "fields": [ { "name": "completedCount", - "description": "Number of completed tasks", + "description": "Number of completed tasks.", "args": [ ], @@ -69034,7 +72739,7 @@ }, { "name": "count", - "description": "Number of total tasks", + "description": "Number of total tasks.", "args": [ ], @@ -69065,7 +72770,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp the Terraform state was created", + "description": "Timestamp the Terraform state was created.", "args": [ ], @@ -69083,7 +72788,7 @@ }, { "name": "id", - "description": "ID of the Terraform state", + "description": "ID of the Terraform state.", "args": [ ], @@ -69101,7 +72806,7 @@ }, { "name": "latestVersion", - "description": "The latest version of the Terraform state", + "description": "The latest version of the Terraform state.", "args": [ ], @@ -69115,7 +72820,7 @@ }, { "name": "lockedAt", - "description": "Timestamp the Terraform state was locked", + "description": "Timestamp the Terraform state was locked.", "args": [ ], @@ -69129,7 +72834,7 @@ }, { "name": "lockedByUser", - "description": "The user currently holding a lock on the Terraform state", + "description": "The user currently holding a lock on the Terraform state.", "args": [ ], @@ -69143,7 +72848,7 @@ }, { "name": "name", - "description": "Name of the Terraform state", + "description": "Name of the Terraform state.", "args": [ ], @@ -69161,7 +72866,7 @@ }, { "name": "updatedAt", - "description": "Timestamp the Terraform state was updated", + "description": "Timestamp the Terraform state was updated.", "args": [ ], @@ -69192,7 +72897,7 @@ "fields": [ { "name": "count", - "description": "Total count of collection", + "description": "Total count of collection.", "args": [ ], @@ -69406,7 +73111,7 @@ { "kind": "SCALAR", "name": "TerraformStateID", - "description": "Identifier of Terraform::State", + "description": "Identifier of Terraform::State.", "fields": null, "inputFields": null, "interfaces": null, @@ -69596,7 +73301,7 @@ "fields": [ { "name": "createdAt", - "description": "Timestamp the version was created", + "description": "Timestamp the version was created.", "args": [ ], @@ -69614,7 +73319,7 @@ }, { "name": "createdByUser", - "description": "The user that created this version", + "description": "The user that created this version.", "args": [ ], @@ -69628,7 +73333,7 @@ }, { "name": "downloadPath", - "description": "URL for downloading the version's JSON file", + "description": "URL for downloading the version's JSON file.", "args": [ ], @@ -69642,7 +73347,7 @@ }, { "name": "id", - "description": "ID of the Terraform state version", + "description": "ID of the Terraform state version.", "args": [ ], @@ -69660,7 +73365,7 @@ }, { "name": "job", - "description": "The job that created this version", + "description": "The job that created this version.", "args": [ ], @@ -69674,7 +73379,7 @@ }, { "name": "serial", - "description": "Serial number of the version", + "description": "Serial number of the version.", "args": [ ], @@ -69688,7 +73393,7 @@ }, { "name": "updatedAt", - "description": "Timestamp the version was updated", + "description": "Timestamp the version was updated.", "args": [ ], @@ -69821,7 +73526,7 @@ }, { "name": "terraformStateVersionId", - "description": "ID of the terraform state version", + "description": "ID of the terraform state version.", "args": [ ], @@ -69964,7 +73669,7 @@ "fields": [ { "name": "author", - "description": "Author of the test report", + "description": "Author of the test report.", "args": [ ], @@ -69978,7 +73683,7 @@ }, { "name": "createdAt", - "description": "Timestamp of when the test report was created", + "description": "Timestamp of when the test report was created.", "args": [ ], @@ -69996,7 +73701,7 @@ }, { "name": "id", - "description": "ID of the test report", + "description": "ID of the test report.", "args": [ ], @@ -70014,7 +73719,7 @@ }, { "name": "state", - "description": "State of the test report", + "description": "State of the test report.", "args": [ ], @@ -70190,7 +73895,7 @@ "fields": [ { "name": "complete", - "description": "Completed issues metrics", + "description": "Completed issues metrics.", "args": [ ], @@ -70204,7 +73909,7 @@ }, { "name": "incomplete", - "description": "Incomplete issues metrics", + "description": "Incomplete issues metrics.", "args": [ ], @@ -70218,7 +73923,7 @@ }, { "name": "total", - "description": "Total issues metrics", + "description": "Total issues metrics.", "args": [ ], @@ -70245,7 +73950,7 @@ "fields": [ { "name": "count", - "description": "The count metric", + "description": "The count metric.", "args": [ ], @@ -70263,7 +73968,7 @@ }, { "name": "weight", - "description": "The weight metric", + "description": "The weight metric.", "args": [ ], @@ -70294,7 +73999,7 @@ "fields": [ { "name": "burnupTimeSeries", - "description": "Daily scope and completed totals for burnup charts", + "description": "Daily scope and completed totals for burnup charts.", "args": [ ], @@ -70316,7 +74021,7 @@ }, { "name": "stats", - "description": "Represents the time report stats for the timebox", + "description": "Represents the time report stats for the timebox.", "args": [ ], @@ -70343,7 +74048,7 @@ "fields": [ { "name": "report", - "description": "Historically accurate report about the timebox", + "description": "Historically accurate report about the timebox.", "args": [ ], @@ -70380,7 +74085,7 @@ "inputFields": [ { "name": "start", - "description": "The start of the range", + "description": "The start of the range.", "type": { "kind": "NON_NULL", "name": null, @@ -70394,7 +74099,7 @@ }, { "name": "end", - "description": "The end of the range", + "description": "The end of the range.", "type": { "kind": "NON_NULL", "name": null, @@ -70418,7 +74123,7 @@ "fields": [ { "name": "issue", - "description": "The issue that logged time was added to", + "description": "The issue that logged time was added to.", "args": [ ], @@ -70432,7 +74137,7 @@ }, { "name": "note", - "description": "The note where the quick action to add the logged time was executed", + "description": "The note where the quick action to add the logged time was executed.", "args": [ ], @@ -70446,7 +74151,7 @@ }, { "name": "spentAt", - "description": "Timestamp of when the time tracked was spent at", + "description": "Timestamp of when the time tracked was spent at.", "args": [ ], @@ -70460,7 +74165,7 @@ }, { "name": "timeSpent", - "description": "The time spent displayed in seconds", + "description": "The time spent displayed in seconds.", "args": [ ], @@ -70478,7 +74183,7 @@ }, { "name": "user", - "description": "The user that logged the time", + "description": "The user that logged the time.", "args": [ ], @@ -70617,11 +74322,11 @@ { "kind": "OBJECT", "name": "Todo", - "description": "Representing a todo entry", + "description": "Representing a to-do entry", "fields": [ { "name": "action", - "description": "Action of the todo", + "description": "Action of the to-do item.", "args": [ ], @@ -70639,7 +74344,7 @@ }, { "name": "author", - "description": "The author of this todo", + "description": "The author of this to-do item.", "args": [ ], @@ -70657,7 +74362,7 @@ }, { "name": "body", - "description": "Body of the todo", + "description": "Body of the to-do item.", "args": [ ], @@ -70675,7 +74380,7 @@ }, { "name": "createdAt", - "description": "Timestamp this todo was created", + "description": "Timestamp this to-do item was created.", "args": [ ], @@ -70693,7 +74398,7 @@ }, { "name": "group", - "description": "Group this todo is associated with", + "description": "Group this to-do item is associated with.", "args": [ ], @@ -70707,7 +74412,7 @@ }, { "name": "id", - "description": "ID of the todo", + "description": "ID of the to-do item.", "args": [ ], @@ -70725,7 +74430,7 @@ }, { "name": "project", - "description": "The project this todo is associated with", + "description": "The project this to-do item is associated with.", "args": [ ], @@ -70739,7 +74444,7 @@ }, { "name": "state", - "description": "State of the todo", + "description": "State of the to-do item.", "args": [ ], @@ -70757,7 +74462,7 @@ }, { "name": "targetType", - "description": "Target type of the todo", + "description": "Target type of the to-do item.", "args": [ ], @@ -70983,7 +74688,7 @@ }, { "name": "todo", - "description": "The to-do created.", + "description": "The to-do item created.", "args": [ ], @@ -71051,7 +74756,7 @@ { "kind": "SCALAR", "name": "TodoID", - "description": "Identifier of Todo", + "description": "Identifier of Todo.", "fields": null, "inputFields": null, "interfaces": null, @@ -71066,7 +74771,7 @@ "inputFields": [ { "name": "id", - "description": "The global ID of the todo to mark as done.", + "description": "The global ID of the to-do item to mark as done.", "type": { "kind": "NON_NULL", "name": null, @@ -71140,7 +74845,7 @@ }, { "name": "todo", - "description": "The requested todo.", + "description": "The requested to-do item.", "args": [ ], @@ -71172,7 +74877,7 @@ "inputFields": [ { "name": "id", - "description": "The global ID of the todo to restore.", + "description": "The global ID of the to-do item to restore.", "type": { "kind": "NON_NULL", "name": null, @@ -71207,7 +74912,7 @@ "inputFields": [ { "name": "ids", - "description": "The global IDs of the todos to restore (a maximum of 50 is supported at once).", + "description": "The global IDs of the to-do items to restore (a maximum of 50 is supported at once).", "type": { "kind": "NON_NULL", "name": null, @@ -71289,7 +74994,7 @@ }, { "name": "todos", - "description": "Updated todos.", + "description": "Updated to-do items.", "args": [ ], @@ -71315,7 +75020,7 @@ }, { "name": "updatedIds", - "description": "The IDs of the updated todo items. Deprecated in 13.2: Use todos.", + "description": "The IDs of the updated to-do items. Deprecated in 13.2: Use to-do items.", "args": [ ], @@ -71337,7 +75042,7 @@ } }, "isDeprecated": true, - "deprecationReason": "Use todos. Deprecated in 13.2." + "deprecationReason": "Use to-do items. Deprecated in 13.2." } ], "inputFields": null, @@ -71394,7 +75099,7 @@ }, { "name": "todo", - "description": "The requested todo.", + "description": "The requested to-do item.", "args": [ ], @@ -71491,7 +75196,7 @@ { "kind": "SCALAR", "name": "TodoableID", - "description": "Identifier of Todoable", + "description": "Identifier of Todoable.", "fields": null, "inputFields": null, "interfaces": null, @@ -71566,7 +75271,7 @@ }, { "name": "todos", - "description": "Updated todos.", + "description": "Updated to-do items.", "args": [ ], @@ -71592,7 +75297,7 @@ }, { "name": "updatedIds", - "description": "Ids of the updated todos. Deprecated in 13.2: Use todos.", + "description": "IDs of the updated to-do items. Deprecated in 13.2: Use to-do items.", "args": [ ], @@ -71614,7 +75319,7 @@ } }, "isDeprecated": true, - "deprecationReason": "Use todos. Deprecated in 13.2." + "deprecationReason": "Use to-do items. Deprecated in 13.2." } ], "inputFields": null, @@ -71646,7 +75351,7 @@ }, { "name": "name", - "description": "The emoji name", + "description": "The emoji name.", "type": { "kind": "NON_NULL", "name": null, @@ -71765,7 +75470,7 @@ "fields": [ { "name": "blobs", - "description": "Blobs of the tree", + "description": "Blobs of the tree.", "args": [ { "name": "after", @@ -71822,7 +75527,7 @@ }, { "name": "lastCommit", - "description": "Last commit for the tree", + "description": "Last commit for the tree.", "args": [ ], @@ -71836,7 +75541,7 @@ }, { "name": "submodules", - "description": "Sub-modules of the tree", + "description": "Sub-modules of the tree.", "args": [ { "name": "after", @@ -71893,7 +75598,7 @@ }, { "name": "trees", - "description": "Trees of the tree", + "description": "Trees of the tree.", "args": [ { "name": "after", @@ -71963,7 +75668,7 @@ "fields": [ { "name": "flatPath", - "description": "Flat path of the entry", + "description": "Flat path of the entry.", "args": [ ], @@ -71981,7 +75686,7 @@ }, { "name": "id", - "description": "ID of the entry", + "description": "ID of the entry.", "args": [ ], @@ -71999,7 +75704,7 @@ }, { "name": "name", - "description": "Name of the entry", + "description": "Name of the entry.", "args": [ ], @@ -72017,7 +75722,7 @@ }, { "name": "path", - "description": "Path of the entry", + "description": "Path of the entry.", "args": [ ], @@ -72035,7 +75740,7 @@ }, { "name": "sha", - "description": "Last commit sha for the entry", + "description": "Last commit SHA for the entry.", "args": [ ], @@ -72053,7 +75758,7 @@ }, { "name": "type", - "description": "Type of tree entry", + "description": "Type of tree entry.", "args": [ ], @@ -72071,7 +75776,7 @@ }, { "name": "webPath", - "description": "Web path for the tree entry (directory)", + "description": "Web path for the tree entry (directory).", "args": [ ], @@ -72085,7 +75790,7 @@ }, { "name": "webUrl", - "description": "Web URL for the tree entry (directory)", + "description": "Web URL for the tree entry (directory).", "args": [ ], @@ -72392,7 +76097,7 @@ }, { "name": "todo", - "description": "The todo after mutation.", + "description": "The to-do item after mutation.", "args": [ ], @@ -72560,7 +76265,7 @@ }, { "name": "hideBacklogList", - "description": "Whether or not backlog list is hidden", + "description": "Whether or not backlog list is hidden.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -72570,7 +76275,7 @@ }, { "name": "hideClosedList", - "description": "Whether or not closed list is hidden", + "description": "Whether or not closed list is hidden.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -72634,7 +76339,7 @@ }, { "name": "labels", - "description": "Labels of the issue", + "description": "Labels of the issue.", "type": { "kind": "LIST", "name": null, @@ -73010,7 +76715,7 @@ }, { "name": "enabled", - "description": "Indicates whether this container expiration policy is enabled", + "description": "Indicates whether this container expiration policy is enabled.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -73020,7 +76725,7 @@ }, { "name": "cadence", - "description": "This container expiration policy schedule", + "description": "This container expiration policy schedule.", "type": { "kind": "ENUM", "name": "ContainerExpirationPolicyCadenceEnum", @@ -73030,7 +76735,7 @@ }, { "name": "olderThan", - "description": "Tags older that this will expire", + "description": "Tags older that this will expire.", "type": { "kind": "ENUM", "name": "ContainerExpirationPolicyOlderThanEnum", @@ -73040,7 +76745,7 @@ }, { "name": "keepN", - "description": "Number of tags to retain", + "description": "Number of tags to retain.", "type": { "kind": "ENUM", "name": "ContainerExpirationPolicyKeepEnum", @@ -73050,7 +76755,7 @@ }, { "name": "nameRegex", - "description": "Tags with names matching this regex pattern will expire", + "description": "Tags with names matching this regex pattern will expire.", "type": { "kind": "SCALAR", "name": "UntrustedRegexp", @@ -73060,7 +76765,7 @@ }, { "name": "nameRegexKeep", - "description": "Tags with names matching this regex pattern will be preserved", + "description": "Tags with names matching this regex pattern will be preserved.", "type": { "kind": "SCALAR", "name": "UntrustedRegexp", @@ -73152,147 +76857,13 @@ }, { "kind": "INPUT_OBJECT", - "name": "UpdateDevopsAdoptionSegmentInput", - "description": "Autogenerated input type of UpdateDevopsAdoptionSegment", - "fields": null, - "inputFields": [ - { - "name": "name", - "description": "Name of the segment.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } - }, - "defaultValue": null - }, - { - "name": "groupIds", - "description": "The array of group IDs to set for the segment.", - "type": { - "kind": "LIST", - "name": null, - "ofType": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "GroupID", - "ofType": null - } - } - }, - "defaultValue": null - }, - { - "name": "id", - "description": "ID of the segment.", - "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "AnalyticsDevopsAdoptionSegmentID", - "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": "UpdateDevopsAdoptionSegmentPayload", - "description": "Autogenerated return type of UpdateDevopsAdoptionSegment", - "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": "Errors encountered during execution of the mutation.", - "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": "segment", - "description": "The segment after mutation.", - "args": [ - - ], - "type": { - "kind": "OBJECT", - "name": "DevopsAdoptionSegment", - "ofType": null - }, - "isDeprecated": false, - "deprecationReason": null - } - ], - "inputFields": null, - "interfaces": [ - - ], - "enumValues": null, - "possibleTypes": null - }, - { - "kind": "INPUT_OBJECT", "name": "UpdateDiffImagePositionInput", "description": null, "fields": null, "inputFields": [ { "name": "x", - "description": "X position of the note", + "description": "X position of the note.", "type": { "kind": "SCALAR", "name": "Int", @@ -73302,7 +76873,7 @@ }, { "name": "y", - "description": "Y position of the note", + "description": "Y position of the note.", "type": { "kind": "SCALAR", "name": "Int", @@ -73312,7 +76883,7 @@ }, { "name": "width", - "description": "Total width of the image", + "description": "Total width of the image.", "type": { "kind": "SCALAR", "name": "Int", @@ -73322,7 +76893,7 @@ }, { "name": "height", - "description": "Total height of the image", + "description": "Total height of the image.", "type": { "kind": "SCALAR", "name": "Int", @@ -73589,7 +77160,7 @@ }, { "name": "body", - "description": "Content of the note", + "description": "Content of the note.", "type": { "kind": "SCALAR", "name": "String", @@ -73599,7 +77170,7 @@ }, { "name": "position", - "description": "The position of this note on a diff", + "description": "The position of this note on a diff.", "type": { "kind": "INPUT_OBJECT", "name": "UpdateDiffImagePositionInput", @@ -73725,7 +77296,7 @@ }, { "name": "description", - "description": "Description of the issue", + "description": "Description of the issue.", "type": { "kind": "SCALAR", "name": "String", @@ -73735,7 +77306,7 @@ }, { "name": "dueDate", - "description": "Due date of the issue", + "description": "Due date of the issue.", "type": { "kind": "SCALAR", "name": "ISO8601Date", @@ -73745,7 +77316,7 @@ }, { "name": "confidential", - "description": "Indicates the issue is confidential", + "description": "Indicates the issue is confidential.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -73755,7 +77326,7 @@ }, { "name": "locked", - "description": "Indicates discussion is locked on the issue", + "description": "Indicates discussion is locked on the issue.", "type": { "kind": "SCALAR", "name": "Boolean", @@ -73765,7 +77336,7 @@ }, { "name": "title", - "description": "Title of the issue", + "description": "Title of the issue.", "type": { "kind": "SCALAR", "name": "String", @@ -74241,7 +77812,7 @@ }, { "name": "body", - "description": "Content of the note", + "description": "Content of the note.", "type": { "kind": "SCALAR", "name": "String", @@ -74504,6 +78075,26 @@ "fields": null, "inputFields": [ { + "name": "captchaResponse", + "description": "A valid CAPTCHA response value obtained by using the provided captchaSiteKey with a CAPTCHA API to present a challenge to be solved on the client. Required to resubmit if the previous operation returned \"NeedsCaptchaResponse: true\".", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "spamLogId", + "description": "The spam log ID which must be passed along with a valid CAPTCHA response for the operation to be completed. Required to resubmit if the previous operation returned \"NeedsCaptchaResponse: true\".", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { "name": "id", "description": "The global ID of the snippet to update.", "type": { @@ -74586,6 +78177,20 @@ "description": "Autogenerated return type of UpdateSnippet", "fields": [ { + "name": "captchaSiteKey", + "description": "The CAPTCHA site key which must be used to render a challenge for the user to solve to obtain a valid captchaResponse value. Included only when an operation was not completed because \"NeedsCaptchaResponse\" is true.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "clientMutationId", "description": "A unique identifier for the client performing the mutation.", "args": [ @@ -74626,6 +78231,20 @@ "deprecationReason": null }, { + "name": "needsCaptchaResponse", + "description": "Indicates whether the operation was detected as possible spam and not completed. If CAPTCHA is enabled, the request must be resubmitted with a valid CAPTCHA response and spam_log_id included for the operation to be completed. Included only when an operation was not completed because \"NeedsCaptchaResponse\" is true.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "snippet", "description": "The snippet after mutation.", "args": [ @@ -74641,7 +78260,7 @@ }, { "name": "spam", - "description": "Indicates whether the operation returns a record detected as spam.", + "description": "Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response.", "args": [ ], @@ -74652,6 +78271,20 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "spamLogId", + "description": "The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because \"NeedsCaptchaResponse\" is true.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -74678,7 +78311,7 @@ "fields": [ { "name": "assignedMergeRequests", - "description": "Merge Requests assigned to the user", + "description": "Merge Requests assigned to the user.", "args": [ { "name": "iids", @@ -74893,7 +78526,7 @@ }, { "name": "authoredMergeRequests", - "description": "Merge Requests authored by the user", + "description": "Merge Requests authored by the user.", "args": [ { "name": "iids", @@ -75108,7 +78741,7 @@ }, { "name": "avatarUrl", - "description": "URL of the user's avatar", + "description": "URL of the user's avatar.", "args": [ ], @@ -75121,8 +78754,26 @@ "deprecationReason": null }, { + "name": "bot", + "description": "Indicates if the user is a bot.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "email", - "description": "User email Deprecated in 13.7: Use public_email.", + "description": "User email. Deprecated in 13.7: Use public_email.", "args": [ ], @@ -75136,7 +78787,7 @@ }, { "name": "groupCount", - "description": "Group count for the user Available only when feature flag `user_group_counts` is enabled.", + "description": "Group count for the user. Available only when feature flag `user_group_counts` is enabled.", "args": [ ], @@ -75150,7 +78801,7 @@ }, { "name": "groupMemberships", - "description": "Group memberships of the user", + "description": "Group memberships of the user.", "args": [ { "name": "after", @@ -75203,7 +78854,7 @@ }, { "name": "id", - "description": "ID of the user", + "description": "ID of the user.", "args": [ ], @@ -75235,7 +78886,7 @@ }, { "name": "name", - "description": "Human-readable name of the user", + "description": "Human-readable name of the user.", "args": [ ], @@ -75253,7 +78904,7 @@ }, { "name": "projectMemberships", - "description": "Project memberships of the user", + "description": "Project memberships of the user.", "args": [ { "name": "after", @@ -75306,7 +78957,7 @@ }, { "name": "publicEmail", - "description": "User's public email", + "description": "User's public email.", "args": [ ], @@ -75320,7 +78971,7 @@ }, { "name": "reviewRequestedMergeRequests", - "description": "Merge Requests assigned to the user for review", + "description": "Merge Requests assigned to the user for review.", "args": [ { "name": "iids", @@ -75535,7 +79186,7 @@ }, { "name": "snippets", - "description": "Snippets authored by the user", + "description": "Snippets authored by the user.", "args": [ { "name": "ids", @@ -75626,7 +79277,7 @@ }, { "name": "starredProjects", - "description": "Projects starred by the user", + "description": "Projects starred by the user.", "args": [ { "name": "search", @@ -75689,7 +79340,7 @@ }, { "name": "state", - "description": "State of the user", + "description": "State of the user.", "args": [ ], @@ -75707,7 +79358,7 @@ }, { "name": "status", - "description": "User status", + "description": "User status.", "args": [ ], @@ -75721,7 +79372,7 @@ }, { "name": "todos", - "description": "Todos of the user", + "description": "To-do items of the user.", "args": [ { "name": "action", @@ -75904,7 +79555,7 @@ }, { "name": "username", - "description": "Username of the user. Unique within this instance of GitLab", + "description": "Username of the user. Unique within this instance of GitLab.", "args": [ ], @@ -75922,7 +79573,7 @@ }, { "name": "webPath", - "description": "Web path of the user", + "description": "Web path of the user.", "args": [ ], @@ -75940,7 +79591,7 @@ }, { "name": "webUrl", - "description": "Web URL of the user", + "description": "Web URL of the user.", "args": [ ], @@ -76079,7 +79730,7 @@ { "kind": "SCALAR", "name": "UserID", - "description": "Identifier of User", + "description": "Identifier of User.", "fields": null, "inputFields": null, "interfaces": null, @@ -76153,7 +79804,7 @@ "fields": [ { "name": "availability", - "description": "User availability status", + "description": "User availability status.", "args": [ ], @@ -76171,7 +79822,7 @@ }, { "name": "emoji", - "description": "String representation of emoji", + "description": "String representation of emoji.", "args": [ ], @@ -76185,7 +79836,7 @@ }, { "name": "message", - "description": "User status message", + "description": "User status message.", "args": [ ], @@ -76302,7 +79953,7 @@ }, { "name": "date", - "description": "Date for the count", + "description": "Date for the count.", "args": [ ], @@ -76392,7 +80043,7 @@ }, { "name": "total", - "description": "Total number of vulnerabilities on a particular day", + "description": "Total number of vulnerabilities on a particular day.", "args": [ ], @@ -76441,7 +80092,7 @@ "fields": [ { "name": "count", - "description": "Number of vulnerabilities", + "description": "Number of vulnerabilities.", "args": [ ], @@ -76455,7 +80106,7 @@ }, { "name": "day", - "description": "Date for the count", + "description": "Date for the count.", "args": [ ], @@ -76469,7 +80120,7 @@ }, { "name": "severity", - "description": "Severity of the counted vulnerabilities", + "description": "Severity of the counted vulnerabilities.", "args": [ ], @@ -76716,7 +80367,7 @@ { "kind": "SCALAR", "name": "VulnerabilitiesExternalIssueLinkID", - "description": "Identifier of Vulnerabilities::ExternalIssueLink", + "description": "Identifier of Vulnerabilities::ExternalIssueLink.", "fields": null, "inputFields": null, "interfaces": null, @@ -76730,7 +80381,7 @@ "fields": [ { "name": "confirmedAt", - "description": "Timestamp of when the vulnerability state was changed to confirmed", + "description": "Timestamp of when the vulnerability state was changed to confirmed.", "args": [ ], @@ -76758,7 +80409,7 @@ }, { "name": "description", - "description": "Description of the vulnerability", + "description": "Description of the vulnerability.", "args": [ ], @@ -76771,8 +80422,34 @@ "deprecationReason": null }, { + "name": "details", + "description": "Details of the vulnerability.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "VulnerabilityDetail", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "detectedAt", - "description": "Timestamp of when the vulnerability was first detected", + "description": "Timestamp of when the vulnerability was first detected.", "args": [ ], @@ -76790,7 +80467,7 @@ }, { "name": "discussions", - "description": "All discussions on this noteable", + "description": "All discussions on this noteable.", "args": [ { "name": "after", @@ -76847,7 +80524,7 @@ }, { "name": "dismissedAt", - "description": "Timestamp of when the vulnerability state was changed to dismissed", + "description": "Timestamp of when the vulnerability state was changed to dismissed.", "args": [ ], @@ -76875,7 +80552,7 @@ }, { "name": "externalIssueLinks", - "description": "List of external issue links related to the vulnerability", + "description": "List of external issue links related to the vulnerability.", "args": [ { "name": "after", @@ -76946,7 +80623,7 @@ }, { "name": "id", - "description": "GraphQL ID of the vulnerability", + "description": "GraphQL ID of the vulnerability.", "args": [ ], @@ -76990,7 +80667,7 @@ }, { "name": "issueLinks", - "description": "List of issue links related to the vulnerability", + "description": "List of issue links related to the vulnerability.", "args": [ { "name": "linkType", @@ -77057,7 +80734,7 @@ }, { "name": "location", - "description": "Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability", + "description": "Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability.", "args": [ ], @@ -77085,7 +80762,7 @@ }, { "name": "notes", - "description": "All notes on this noteable", + "description": "All notes on this noteable.", "args": [ { "name": "after", @@ -77156,7 +80833,7 @@ }, { "name": "project", - "description": "The project on which the vulnerability was found", + "description": "The project on which the vulnerability was found.", "args": [ ], @@ -77184,7 +80861,7 @@ }, { "name": "resolvedAt", - "description": "Timestamp of when the vulnerability state was changed to resolved", + "description": "Timestamp of when the vulnerability state was changed to resolved.", "args": [ ], @@ -77212,7 +80889,7 @@ }, { "name": "resolvedOnDefaultBranch", - "description": "Indicates whether the vulnerability is fixed on the default branch or not", + "description": "Indicates whether the vulnerability is fixed on the default branch or not.", "args": [ ], @@ -77272,7 +80949,7 @@ }, { "name": "title", - "description": "Title of the vulnerability", + "description": "Title of the vulnerability.", "args": [ ], @@ -77286,7 +80963,7 @@ }, { "name": "userNotesCount", - "description": "Number of user notes attached to the vulnerability", + "description": "Number of user notes attached to the vulnerability.", "args": [ ], @@ -77322,7 +80999,7 @@ }, { "name": "vulnerabilityPath", - "description": "URL to the vulnerability's details page", + "description": "URL to the vulnerability's details page.", "args": [ ], @@ -77516,6 +81193,1259 @@ "possibleTypes": null }, { + "kind": "UNION", + "name": "VulnerabilityDetail", + "description": "Represents a vulnerability detail field. The fields with data will depend on the vulnerability detail type", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "VulnerabilityDetailBase", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailBoolean", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailCode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailCommit", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailDiff", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailFileLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailInt", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailList", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailMarkdown", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailModuleLocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailTable", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailText", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailUrl", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailBase", + "description": "Represents the vulnerability details base", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailBoolean", + "description": "Represents the vulnerability details boolean value", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailCode", + "description": "Represents the vulnerability details code field", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lang", + "description": "Language of the code.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Source code.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailCommit", + "description": "Represents the vulnerability details commit field", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The commit SHA value.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailDiff", + "description": "Represents the vulnerability details diff field", + "fields": [ + { + "name": "after", + "description": "Value of the field after the change.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "before", + "description": "Value of the field before the change.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailFileLocation", + "description": "Represents the vulnerability details location within a file in the project", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fileName", + "description": "File name.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineEnd", + "description": "End line number of the file location.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineStart", + "description": "Start line number of the file location.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailInt", + "description": "Represents the vulnerability details integer value", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailList", + "description": "Represents the vulnerability details list value", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "List of details.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "VulnerabilityDetail", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailMarkdown", + "description": "Represents the vulnerability details Markdown field", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the Markdown field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailModuleLocation", + "description": "Represents the vulnerability details location within a file in the project", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moduleName", + "description": "Module name.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "offset", + "description": "Offset of the module location.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailTable", + "description": "Represents the vulnerability details table value", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "headers", + "description": "Table headers.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "VulnerabilityDetail", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rows", + "description": "Table rows.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "VulnerabilityDetail", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailText", + "description": "Represents the vulnerability details text field", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the text field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VulnerabilityDetailUrl", + "description": "Represents the vulnerability details URL field", + "fields": [ + { + "name": "description", + "description": "Description of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "href", + "description": "Href of the URL.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the field.", + "args": [ + + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "Text of the URL.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { "kind": "INPUT_OBJECT", "name": "VulnerabilityDismissInput", "description": "Autogenerated input type of VulnerabilityDismiss", @@ -77730,7 +82660,7 @@ "fields": [ { "name": "externalIssue", - "description": "The external issue attached to the issue link", + "description": "The external issue attached to the issue link.", "args": [ ], @@ -77744,7 +82674,7 @@ }, { "name": "id", - "description": "GraphQL ID of the external issue link", + "description": "GraphQL ID of the external issue link.", "args": [ ], @@ -77762,7 +82692,7 @@ }, { "name": "linkType", - "description": "Type of the external issue link", + "description": "Type of the external issue link.", "args": [ ], @@ -78194,7 +83124,7 @@ { "kind": "SCALAR", "name": "VulnerabilityID", - "description": "Identifier of Vulnerability", + "description": "Identifier of Vulnerability.", "fields": null, "inputFields": null, "interfaces": null, @@ -78208,7 +83138,7 @@ "fields": [ { "name": "externalId", - "description": "External ID of the vulnerability identifier", + "description": "External ID of the vulnerability identifier.", "args": [ ], @@ -78222,7 +83152,7 @@ }, { "name": "externalType", - "description": "External type of the vulnerability identifier", + "description": "External type of the vulnerability identifier.", "args": [ ], @@ -78236,7 +83166,7 @@ }, { "name": "name", - "description": "Name of the vulnerability identifier", + "description": "Name of the vulnerability identifier.", "args": [ ], @@ -78250,7 +83180,7 @@ }, { "name": "url", - "description": "URL of the vulnerability identifier", + "description": "URL of the vulnerability identifier.", "args": [ ], @@ -78277,7 +83207,7 @@ "fields": [ { "name": "id", - "description": "GraphQL ID of the vulnerability", + "description": "GraphQL ID of the vulnerability.", "args": [ ], @@ -78295,7 +83225,7 @@ }, { "name": "issue", - "description": "The issue attached to issue link", + "description": "The issue attached to issue link.", "args": [ ], @@ -78313,7 +83243,7 @@ }, { "name": "linkType", - "description": "Type of the issue link", + "description": "Type of the issue link.", "args": [ ], @@ -78520,7 +83450,7 @@ "fields": [ { "name": "dependency", - "description": "Dependency containing the vulnerability", + "description": "Dependency containing the vulnerability.", "args": [ ], @@ -78534,7 +83464,7 @@ }, { "name": "image", - "description": "Name of the vulnerable container image", + "description": "Name of the vulnerable container image.", "args": [ ], @@ -78548,7 +83478,7 @@ }, { "name": "operatingSystem", - "description": "Operating system that runs on the vulnerable container image", + "description": "Operating system that runs on the vulnerable container image.", "args": [ ], @@ -78574,8 +83504,22 @@ "description": "Represents the location of a vulnerability found by a Coverage Fuzzing scan", "fields": [ { + "name": "blobPath", + "description": "Blob path to the vulnerable file.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "endLine", - "description": "Number of the last relevant line in the vulnerable file", + "description": "Number of the last relevant line in the vulnerable file.", "args": [ ], @@ -78589,7 +83533,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -78603,7 +83547,7 @@ }, { "name": "startLine", - "description": "Number of the first relevant line in the vulnerable file", + "description": "Number of the first relevant line in the vulnerable file.", "args": [ ], @@ -78617,7 +83561,7 @@ }, { "name": "vulnerableClass", - "description": "Class containing the vulnerability", + "description": "Class containing the vulnerability.", "args": [ ], @@ -78631,7 +83575,7 @@ }, { "name": "vulnerableMethod", - "description": "Method containing the vulnerability", + "description": "Method containing the vulnerability.", "args": [ ], @@ -78658,7 +83602,7 @@ "fields": [ { "name": "hostname", - "description": "Domain name of the vulnerable request", + "description": "Domain name of the vulnerable request.", "args": [ ], @@ -78672,7 +83616,7 @@ }, { "name": "param", - "description": "Query parameter for the URL on which the vulnerability occurred", + "description": "Query parameter for the URL on which the vulnerability occurred.", "args": [ ], @@ -78686,7 +83630,7 @@ }, { "name": "path", - "description": "URL path and query string of the vulnerable request", + "description": "URL path and query string of the vulnerable request.", "args": [ ], @@ -78700,7 +83644,7 @@ }, { "name": "requestMethod", - "description": "HTTP method of the vulnerable request", + "description": "HTTP method of the vulnerable request.", "args": [ ], @@ -78726,8 +83670,22 @@ "description": "Represents the location of a vulnerability found by a dependency security scan", "fields": [ { + "name": "blobPath", + "description": "Blob path to the vulnerable file.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "dependency", - "description": "Dependency containing the vulnerability", + "description": "Dependency containing the vulnerability.", "args": [ ], @@ -78741,7 +83699,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -78767,8 +83725,22 @@ "description": "Represents the location of a vulnerability found by a SAST scan", "fields": [ { + "name": "blobPath", + "description": "Blob path to the vulnerable file.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "endLine", - "description": "Number of the last relevant line in the vulnerable file", + "description": "Number of the last relevant line in the vulnerable file.", "args": [ ], @@ -78782,7 +83754,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -78796,7 +83768,7 @@ }, { "name": "startLine", - "description": "Number of the first relevant line in the vulnerable file", + "description": "Number of the first relevant line in the vulnerable file.", "args": [ ], @@ -78810,7 +83782,7 @@ }, { "name": "vulnerableClass", - "description": "Class containing the vulnerability", + "description": "Class containing the vulnerability.", "args": [ ], @@ -78824,7 +83796,7 @@ }, { "name": "vulnerableMethod", - "description": "Method containing the vulnerability", + "description": "Method containing the vulnerability.", "args": [ ], @@ -78850,8 +83822,22 @@ "description": "Represents the location of a vulnerability found by a secret detection scan", "fields": [ { + "name": "blobPath", + "description": "Blob path to the vulnerable file.", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "endLine", - "description": "Number of the last relevant line in the vulnerable file", + "description": "Number of the last relevant line in the vulnerable file.", "args": [ ], @@ -78865,7 +83851,7 @@ }, { "name": "file", - "description": "Path to the vulnerable file", + "description": "Path to the vulnerable file.", "args": [ ], @@ -78879,7 +83865,7 @@ }, { "name": "startLine", - "description": "Number of the first relevant line in the vulnerable file", + "description": "Number of the first relevant line in the vulnerable file.", "args": [ ], @@ -78893,7 +83879,7 @@ }, { "name": "vulnerableClass", - "description": "Class containing the vulnerability", + "description": "Class containing the vulnerability.", "args": [ ], @@ -78907,7 +83893,7 @@ }, { "name": "vulnerableMethod", - "description": "Method containing the vulnerability", + "description": "Method containing the vulnerability.", "args": [ ], @@ -79366,7 +84352,7 @@ "fields": [ { "name": "externalId", - "description": "External ID of the vulnerability scanner", + "description": "External ID of the vulnerability scanner.", "args": [ ], @@ -79380,7 +84366,7 @@ }, { "name": "name", - "description": "Name of the vulnerability scanner", + "description": "Name of the vulnerability scanner.", "args": [ ], @@ -79394,7 +84380,7 @@ }, { "name": "reportType", - "description": "Type of the vulnerability report", + "description": "Type of the vulnerability report.", "args": [ ], @@ -79408,7 +84394,7 @@ }, { "name": "vendor", - "description": "Vendor of the vulnerability scanner", + "description": "Vendor of the vulnerability scanner.", "args": [ ], @@ -79797,7 +84783,7 @@ "fields": [ { "name": "package", - "description": "The package associated with the vulnerable dependency", + "description": "The package associated with the vulnerable dependency.", "args": [ ], @@ -79811,7 +84797,7 @@ }, { "name": "version", - "description": "The version of the vulnerable dependency", + "description": "The version of the vulnerable dependency.", "args": [ ], @@ -79838,7 +84824,7 @@ "fields": [ { "name": "name", - "description": "The name of the vulnerable package", + "description": "The name of the vulnerable package.", "args": [ ], @@ -79865,7 +84851,7 @@ "fields": [ { "name": "count", - "description": "Number of projects within this grade", + "description": "Number of projects within this grade.", "args": [ ], @@ -79883,7 +84869,7 @@ }, { "name": "grade", - "description": "Grade based on the highest severity vulnerability present", + "description": "Grade based on the highest severity vulnerability present.", "args": [ ], @@ -79901,7 +84887,7 @@ }, { "name": "projects", - "description": "Projects within this grade", + "description": "Projects within this grade.", "args": [ { "name": "after", diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index c098de16ef6..f49a12568ed 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -24,6 +24,8 @@ Fields that are deprecated are marked with **{warning-solid}**. Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-process) can be found in [Removed Items](../removed_items.md). +<!-- vale gitlab.Spelling = NO --> + ## Object types Object types represent the resources that the GitLab GraphQL API can return. @@ -41,8 +43,8 @@ Represents the access level of a relationship between a User and object that it | Field | Type | Description | | ----- | ---- | ----------- | -| `integerValue` | Int | Integer representation of access level | -| `stringValue` | AccessLevelEnum | String representation of access level | +| `integerValue` | Int | Integer representation of access level. | +| `stringValue` | AccessLevelEnum | String representation of access level. | ### AddAwardEmojiPayload @@ -80,30 +82,30 @@ Describes an alert from the project's Alert Management. | Field | Type | Description | | ----- | ---- | ----------- | -| `assignees` | UserConnection | Assignees of the alert | -| `createdAt` | Time | Timestamp the alert was created | -| `description` | String | Description of the alert | -| `details` | JSON | Alert details | -| `detailsUrl` | String! | The URL of the alert detail page | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `endedAt` | Time | Timestamp the alert ended | -| `environment` | Environment | Environment for the alert | -| `eventCount` | Int | Number of events of this alert | -| `hosts` | String! => Array | List of hosts the alert came from | -| `iid` | ID! | Internal ID of the alert | -| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert | -| `metricsDashboardUrl` | String | URL for metrics embed for the alert | -| `monitoringTool` | String | Monitoring tool the alert came from | -| `notes` | NoteConnection! | All notes on this noteable | -| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus | -| `runbook` | String | Runbook for the alert as defined in alert details | -| `service` | String | Service the alert came from | -| `severity` | AlertManagementSeverity | Severity of the alert | -| `startedAt` | Time | Timestamp the alert was raised | -| `status` | AlertManagementStatus | Status of the alert | -| `title` | String | Title of the alert | -| `todos` | TodoConnection | Todos of the current user for the alert | -| `updatedAt` | Time | Timestamp the alert was last updated | +| `assignees` | UserConnection | Assignees of the alert. | +| `createdAt` | Time | Timestamp the alert was created. | +| `description` | String | Description of the alert. | +| `details` | JSON | Alert details. | +| `detailsUrl` | String! | The URL of the alert detail page. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `endedAt` | Time | Timestamp the alert ended. | +| `environment` | Environment | Environment for the alert. | +| `eventCount` | Int | Number of events of this alert. | +| `hosts` | String! => Array | List of hosts the alert came from. | +| `iid` | ID! | Internal ID of the alert. | +| `issueIid` | ID | Internal ID of the GitLab issue attached to the alert. | +| `metricsDashboardUrl` | String | URL for metrics embed for the alert. | +| `monitoringTool` | String | Monitoring tool the alert came from. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `prometheusAlert` | PrometheusAlert | The alert condition for Prometheus. | +| `runbook` | String | Runbook for the alert as defined in alert details. | +| `service` | String | Service the alert came from. | +| `severity` | AlertManagementSeverity | Severity of the alert. | +| `startedAt` | Time | Timestamp the alert was raised. | +| `status` | AlertManagementStatus | Status of the alert. | +| `title` | String | Title of the alert. | +| `todos` | TodoConnection | To-do items of the current user for the alert. | +| `updatedAt` | Time | Timestamp the alert was last updated. | ### AlertManagementAlertStatusCountsType @@ -112,9 +114,9 @@ Represents total number of alerts for the represented categories. | Field | Type | Description | | ----- | ---- | ----------- | | `acknowledged` | Int | Number of alerts with status ACKNOWLEDGED for the project | -| `all` | Int | Total number of alerts for the project | +| `all` | Int | Total number of alerts for the project. | | `ignored` | Int | Number of alerts with status IGNORED for the project | -| `open` | Int | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project | +| `open` | Int | Number of alerts with status TRIGGERED or ACKNOWLEDGED for the project. | | `resolved` | Int | Number of alerts with status RESOLVED for the project | | `triggered` | Int | Number of alerts with status TRIGGERED for the project | @@ -124,13 +126,23 @@ An endpoint and credentials used to accept alerts for a project. | Field | Type | Description | | ----- | ---- | ----------- | -| `active` | Boolean | Whether the endpoint is currently accepting alerts | -| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard | -| `id` | ID! | ID of the integration | -| `name` | String | Name of the integration | -| `token` | String | Token used to authenticate alert notification requests | -| `type` | AlertManagementIntegrationType! | Type of integration | -| `url` | String | Endpoint which accepts alert notifications | +| `active` | Boolean | Whether the endpoint is currently accepting alerts. | +| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | +| `id` | ID! | ID of the integration. | +| `name` | String | Name of the integration. | +| `token` | String | Token used to authenticate alert notification requests. | +| `type` | AlertManagementIntegrationType! | Type of integration. | +| `url` | String | Endpoint which accepts alert notifications. | + +### AlertManagementPayloadAlertField + +Parsed field from an alert used for custom mappings. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `label` | String | Human-readable label of the payload path. | +| `path` | String! => Array | Path to value inside payload JSON. | +| `type` | AlertManagementPayloadAlertFieldType | Type of the parsed value. | ### AlertManagementPrometheusIntegration @@ -138,13 +150,13 @@ An endpoint and credentials used to accept Prometheus alerts for a project. | Field | Type | Description | | ----- | ---- | ----------- | -| `active` | Boolean | Whether the endpoint is currently accepting alerts | -| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard | -| `id` | ID! | ID of the integration | -| `name` | String | Name of the integration | -| `token` | String | Token used to authenticate alert notification requests | -| `type` | AlertManagementIntegrationType! | Type of integration | -| `url` | String | Endpoint which accepts alert notifications | +| `active` | Boolean | Whether the endpoint is currently accepting alerts. | +| `apiUrl` | String | URL at which Prometheus metrics can be queried to populate the metrics dashboard. | +| `id` | ID! | ID of the integration. | +| `name` | String | Name of the integration. | +| `token` | String | Token used to authenticate alert notification requests. | +| `type` | AlertManagementIntegrationType! | Type of integration. | +| `url` | String | Endpoint which accepts alert notifications. | ### AlertSetAssigneesPayload @@ -156,7 +168,7 @@ Autogenerated return type of AlertSetAssignees. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue created after mutation. | -| `todo` | Todo | The todo after mutation. | +| `todo` | Todo | The to-do item after mutation. | ### AlertTodoCreatePayload @@ -168,7 +180,37 @@ Autogenerated return type of AlertTodoCreate. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue created after mutation. | -| `todo` | Todo | The todo after mutation. | +| `todo` | Todo | The to-do item after mutation. | + +### ApiFuzzingCiConfiguration + +Data associated with configuring API fuzzing scans in GitLab CI. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `scanModes` | ApiFuzzingScanMode! => Array | All available scan modes. | +| `scanProfiles` | ApiFuzzingScanProfile! => Array | All default scan profiles. | + +### ApiFuzzingCiConfigurationCreatePayload + +Autogenerated return type of ApiFuzzingCiConfigurationCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `configurationYaml` | String | A YAML snippet that can be inserted into the project's `.gitlab-ci.yml` to set up API fuzzing scans. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `gitlabCiYamlEditPath` | String | The location at which the project's `.gitlab-ci.yml` file can be edited in the browser. | + +### ApiFuzzingScanProfile + +An API Fuzzing scan profile.. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String | A short description of the profile. | +| `name` | String | The unique name of the profile. | +| `yaml` | String | A syntax highlit HTML representation of the YAML. | ### AwardEmoji @@ -176,12 +218,12 @@ An emoji awarded by a user. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String! | The emoji description | -| `emoji` | String! | The emoji as an icon | -| `name` | String! | The emoji name | -| `unicode` | String! | The emoji in unicode | -| `unicodeVersion` | String! | The unicode version for this emoji | -| `user` | User! | The user who awarded the emoji | +| `description` | String! | The emoji description. | +| `emoji` | String! | The emoji as an icon. | +| `name` | String! | The emoji name. | +| `unicode` | String! | The emoji in Unicode. | +| `unicodeVersion` | String! | The Unicode version for this emoji. | +| `user` | User! | The user who awarded the emoji. | ### AwardEmojiAddPayload @@ -218,23 +260,23 @@ Autogenerated return type of AwardEmojiToggle. | Field | Type | Description | | ----- | ---- | ----------- | -| `active` | Boolean | Indicates if the service is active | -| `type` | String | Class name of the service | +| `active` | Boolean | Indicates if the service is active. | +| `type` | String | Class name of the service. | ### Blob | Field | Type | Description | | ----- | ---- | ----------- | -| `flatPath` | String! | Flat path of the entry | -| `id` | ID! | ID of the entry | -| `lfsOid` | String | LFS ID of the blob | -| `mode` | String | Blob mode in numeric format | -| `name` | String! | Name of the entry | -| `path` | String! | Path of the entry | -| `sha` | String! | Last commit sha for the entry | -| `type` | EntryType! | Type of tree entry | -| `webPath` | String | Web path of the blob | -| `webUrl` | String | Web URL of the blob | +| `flatPath` | String! | Flat path of the entry. | +| `id` | ID! | ID of the entry. | +| `lfsOid` | String | LFS ID of the blob. | +| `mode` | String | Blob mode in numeric format. | +| `name` | String! | Name of the entry. | +| `path` | String! | Path of the entry. | +| `sha` | String! | Last commit SHA for the entry. | +| `type` | EntryType! | Type of tree entry. | +| `webPath` | String | Web path of the blob. | +| `webUrl` | String | Web URL of the blob. | ### Board @@ -242,19 +284,19 @@ Represents a project or group board. | Field | Type | Description | | ----- | ---- | ----------- | -| `assignee` | User | The board assignee | -| `epics` | BoardEpicConnection | Epics associated with board issues | -| `hideBacklogList` | Boolean | Whether or not backlog list is hidden | -| `hideClosedList` | Boolean | Whether or not closed list is hidden | -| `id` | ID! | ID (global ID) of the board | +| `assignee` | User | The board assignee. | +| `epics` | BoardEpicConnection | Epics associated with board issues. | +| `hideBacklogList` | Boolean | Whether or not backlog list is hidden. | +| `hideClosedList` | Boolean | Whether or not closed list is hidden. | +| `id` | ID! | ID (global ID) of the board. | | `iteration` | Iteration | The board iteration. | -| `labels` | LabelConnection | Labels of the board | -| `lists` | BoardListConnection | Lists of the board | -| `milestone` | Milestone | The board milestone | -| `name` | String | Name of the board | +| `labels` | LabelConnection | Labels of the board. | +| `lists` | BoardListConnection | Lists of the board. | +| `milestone` | Milestone | The board milestone. | +| `name` | String | Name of the board. | | `webPath` | String! | Web path of the board. | | `webUrl` | String! | Web URL of the board. | -| `weight` | Int | Weight of the board | +| `weight` | Int | Weight of the board. | ### BoardEpic @@ -262,51 +304,53 @@ Represents an epic on an issue board. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User! | Author of the epic | -| `children` | EpicConnection | Children (sub-epics) of the epic | -| `closedAt` | Time | Timestamp of when the epic was closed | -| `confidential` | Boolean | Indicates if the epic is confidential | -| `createdAt` | Time | Timestamp of when the epic was created | -| `currentUserTodos` | TodoConnection! | Todos for the current user | -| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues | -| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants | -| `description` | String | Description of the epic | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `downvotes` | Int! | Number of downvotes the epic has received | -| `dueDate` | Time | Due date of the epic | -| `dueDateFixed` | Time | Fixed due date of the epic | -| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones | -| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set | -| `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 | -| `hasParent` | Boolean! | Indicates if the epic has a parent epic | -| `healthStatus` | EpicHealthStatus | Current health status of the epic | -| `id` | ID! | ID of the epic | -| `iid` | ID! | Internal ID of the epic | -| `issues` | EpicIssueConnection | A list of issues associated with the epic | -| `labels` | LabelConnection | Labels assigned to the epic | -| `notes` | NoteConnection! | All notes on this noteable | -| `parent` | Epic | Parent epic of the epic | -| `participants` | UserConnection | List of participants for the epic | -| `reference` | String! | Internal reference of the epic. Returned in shortened format by default | -| `relationPath` | String | URI path of the epic-issue relationship | -| `relativePosition` | Int | The relative position of the epic in the epic tree | -| `startDate` | Time | Start date of the epic | -| `startDateFixed` | Time | Fixed start date of the epic | -| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones | -| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set | -| `state` | EpicState! | State of the epic | -| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic | -| `title` | String | Title of the epic | -| `updatedAt` | Time | Timestamp of when the epic was updated | -| `upvotes` | Int! | Number of upvotes the epic has received | -| `userDiscussionsCount` | Int! | Number of user discussions in the epic | -| `userNotesCount` | Int! | Number of user notes of the epic | +| `author` | User! | Author of the epic. | +| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic. | +| `children` | EpicConnection | Children (sub-epics) of the epic. | +| `closedAt` | Time | Timestamp of when the epic was closed. | +| `confidential` | Boolean | Indicates if the epic is confidential. | +| `createdAt` | Time | Timestamp of when the epic was created. | +| `currentUserTodos` | TodoConnection! | To-do items for the current user. | +| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues. | +| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants. | +| `description` | String | Description of the epic. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `downvotes` | Int! | Number of downvotes the epic has received. | +| `dueDate` | Time | Due date of the epic. | +| `dueDateFixed` | Time | Fixed due date of the epic. | +| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones. | +| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set. | +| `events` | EventConnection | A list of events associated with the object. | +| `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. | +| `hasParent` | Boolean! | Indicates if the epic has a parent epic. | +| `healthStatus` | EpicHealthStatus | Current health status of the epic. | +| `id` | ID! | ID of the epic. | +| `iid` | ID! | Internal ID of the epic. | +| `issues` | EpicIssueConnection | A list of issues associated with the epic. | +| `labels` | LabelConnection | Labels assigned to the epic. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `parent` | Epic | Parent epic of the epic. | +| `participants` | UserConnection | List of participants for the epic. | +| `reference` | String! | Internal reference of the epic. Returned in shortened format by default. | +| `relationPath` | String | URI path of the epic-issue relationship. | +| `relativePosition` | Int | The relative position of the epic in the epic tree. | +| `startDate` | Time | Start date of the epic. | +| `startDateFixed` | Time | Fixed start date of the epic. | +| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones. | +| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set. | +| `state` | EpicState! | State of the epic. | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic. | +| `title` | String | Title of the epic. | +| `updatedAt` | Time | Timestamp of when the epic was updated. | +| `upvotes` | Int! | Number of upvotes the epic has received. | +| `userDiscussionsCount` | Int! | Number of user discussions in the epic. | +| `userNotesCount` | Int! | Number of user notes of the epic. | | `userPermissions` | EpicPermissions! | Permissions for the current user on the resource | -| `userPreferences` | BoardEpicUserPreferences | User preferences for the epic on the issue board | -| `webPath` | String! | Web path of the epic | -| `webUrl` | String! | Web URL of the epic | +| `userPreferences` | BoardEpicUserPreferences | User preferences for the epic on the issue board. | +| `webPath` | String! | Web path of the epic. | +| `webUrl` | String! | Web URL of the epic. | ### BoardEpicUserPreferences @@ -314,7 +358,7 @@ Represents user preferences for a board epic. | Field | Type | Description | | ----- | ---- | ----------- | -| `collapsed` | Boolean! | Indicates epic should be displayed as collapsed | +| `collapsed` | Boolean! | Indicates epic should be displayed as collapsed. | ### BoardList @@ -322,21 +366,21 @@ Represents a list for an issue board. | Field | Type | Description | | ----- | ---- | ----------- | -| `assignee` | User | Assignee in the list | -| `collapsed` | Boolean | Indicates if list is collapsed for this user | -| `id` | ID! | ID (global ID) of the list | -| `issues` | IssueConnection | Board issues | -| `issuesCount` | Int | Count of issues in the list | -| `iteration` | Iteration | Iteration of the list | -| `label` | Label | Label of the list | -| `limitMetric` | ListLimitMetric | The current limit metric for the list | -| `listType` | String! | Type of the list | -| `maxIssueCount` | Int | Maximum number of issues in the list | -| `maxIssueWeight` | Int | Maximum weight of issues in the list | -| `milestone` | Milestone | Milestone of the list | -| `position` | Int | Position of list within the board | -| `title` | String! | Title of the list | -| `totalWeight` | Int | Total weight of all issues in the list | +| `assignee` | User | Assignee in the list. | +| `collapsed` | Boolean | Indicates if list is collapsed for this user. | +| `id` | ID! | ID (global ID) of the list. | +| `issues` | IssueConnection | Board issues. | +| `issuesCount` | Int | Count of issues in the list. | +| `iteration` | Iteration | Iteration of the list. | +| `label` | Label | Label of the list. | +| `limitMetric` | ListLimitMetric | The current limit metric for the list. | +| `listType` | String! | Type of the list. | +| `maxIssueCount` | Int | Maximum number of issues in the list. | +| `maxIssueWeight` | Int | Maximum weight of issues in the list. | +| `milestone` | Milestone | Milestone of the list. | +| `position` | Int | Position of list within the board. | +| `title` | String! | Title of the list. | +| `totalWeight` | Int | Total weight of all issues in the list. | ### BoardListCreatePayload @@ -346,7 +390,7 @@ Autogenerated return type of BoardListCreate. | ----- | ---- | ----------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `list` | BoardList | List of the issue board. | +| `list` | BoardList | Issue list in the issue board. | ### BoardListUpdateLimitMetricsPayload @@ -362,8 +406,8 @@ Autogenerated return type of BoardListUpdateLimitMetrics. | Field | Type | Description | | ----- | ---- | ----------- | -| `commit` | Commit | Commit for the branch | -| `name` | String! | Name of the branch | +| `commit` | Commit | Commit for the branch. | +| `name` | String! | Name of the branch. | ### BurnupChartDailyTotals @@ -371,11 +415,17 @@ Represents the total number of issues and their weights for a particular day. | Field | Type | Description | | ----- | ---- | ----------- | -| `completedCount` | Int! | Number of closed issues as of this day | -| `completedWeight` | Int! | Total weight of closed issues as of this day | -| `date` | ISO8601Date! | Date for burnup totals | -| `scopeCount` | Int! | Number of issues as of this day | -| `scopeWeight` | Int! | Total weight of issues as of this day | +| `completedCount` | Int! | Number of closed issues as of this day. | +| `completedWeight` | Int! | Total weight of closed issues as of this day. | +| `date` | ISO8601Date! | Date for burnup totals. | +| `scopeCount` | Int! | Number of issues as of this day. | +| `scopeWeight` | Int! | Total weight of issues as of this day. | + +### CiApplicationSettings + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `keepLatestArtifact` | Boolean | Whether to keep the latest jobs artifacts. | ### CiBuildNeed @@ -396,18 +446,18 @@ Autogenerated return type of CiCdSettingsUpdate. | Field | Type | Description | | ----- | ---- | ----------- | -| `errors` | String! => Array | Linting errors | -| `mergedYaml` | String | Merged CI config YAML | -| `stages` | CiConfigStageConnection | Stages of the pipeline | -| `status` | CiConfigStatus | Status of linting, can be either valid or invalid | +| `errors` | String! => Array | Linting errors. | +| `mergedYaml` | String | Merged CI configuration YAML. | +| `stages` | CiConfigStageConnection | Stages of the pipeline. | +| `status` | CiConfigStatus | Status of linting, can be either valid or invalid. | ### CiConfigGroup | Field | Type | Description | | ----- | ---- | ----------- | -| `jobs` | CiConfigJobConnection | Jobs in group | -| `name` | String | Name of the job group | -| `size` | Int | Size of the job group | +| `jobs` | CiConfigJobConnection | Jobs in group. | +| `name` | String | Name of the job group. | +| `size` | Int | Size of the job group. | ### CiConfigJob @@ -437,60 +487,61 @@ Autogenerated return type of CiCdSettingsUpdate. | Field | Type | Description | | ----- | ---- | ----------- | -| `name` | String | Name of the need | +| `name` | String | Name of the need. | ### CiConfigStage | Field | Type | Description | | ----- | ---- | ----------- | -| `groups` | CiConfigGroupConnection | Groups of jobs for the stage | -| `name` | String | Name of the stage | +| `groups` | CiConfigGroupConnection | Groups of jobs for the stage. | +| `name` | String | Name of the stage. | ### CiGroup | Field | Type | Description | | ----- | ---- | ----------- | -| `detailedStatus` | DetailedStatus | Detailed status of the group | -| `jobs` | CiJobConnection | Jobs in group | -| `name` | String | Name of the job group | -| `size` | Int | Size of the group | +| `detailedStatus` | DetailedStatus | Detailed status of the group. | +| `jobs` | CiJobConnection | Jobs in group. | +| `name` | String | Name of the job group. | +| `size` | Int | Size of the group. | ### CiJob | Field | Type | Description | | ----- | ---- | ----------- | -| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job | -| `detailedStatus` | DetailedStatus | Detailed status of the job | -| `name` | String | Name of the job | -| `needs` | CiBuildNeedConnection | References to builds that must complete before the jobs run | -| `pipeline` | Pipeline | Pipeline the job belongs to | -| `scheduledAt` | Time | Schedule for the build | +| `artifacts` | CiJobArtifactConnection | Artifacts generated by the job. | +| `detailedStatus` | DetailedStatus | Detailed status of the job. | +| `name` | String | Name of the job. | +| `needs` | CiBuildNeedConnection | References to builds that must complete before the jobs run. | +| `pipeline` | Pipeline | Pipeline the job belongs to. | +| `scheduledAt` | Time | Schedule for the build. | ### CiJobArtifact | Field | Type | Description | | ----- | ---- | ----------- | -| `downloadPath` | String | URL for downloading the artifact's file | -| `fileType` | JobArtifactFileType | File type of the artifact | +| `downloadPath` | String | URL for downloading the artifact's file. | +| `fileType` | JobArtifactFileType | File type of the artifact. | ### CiStage | Field | Type | Description | | ----- | ---- | ----------- | -| `detailedStatus` | DetailedStatus | Detailed status of the stage | -| `groups` | CiGroupConnection | Group of jobs for the stage | -| `name` | String | Name of the stage | +| `detailedStatus` | DetailedStatus | Detailed status of the stage. | +| `groups` | CiGroupConnection | Group of jobs for the stage. | +| `name` | String | Name of the stage. | ### ClusterAgent | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time | Timestamp the cluster agent was created | -| `id` | ID! | ID of the cluster agent | -| `name` | String | Name of the cluster agent | -| `project` | Project | The project this cluster agent is associated with | -| `tokens` | ClusterAgentTokenConnection | Tokens associated with the cluster agent | -| `updatedAt` | Time | Timestamp the cluster agent was updated | +| `createdAt` | Time | Timestamp the cluster agent was created. | +| `createdByUser` | User | User object, containing information about the person who created the agent. | +| `id` | ID! | ID of the cluster agent. | +| `name` | String | Name of the cluster agent. | +| `project` | Project | The project this cluster agent is associated with. | +| `tokens` | ClusterAgentTokenConnection | Tokens associated with the cluster agent. | +| `updatedAt` | Time | Timestamp the cluster agent was updated. | ### ClusterAgentDeletePayload @@ -505,9 +556,10 @@ Autogenerated return type of ClusterAgentDelete. | Field | Type | Description | | ----- | ---- | ----------- | -| `clusterAgent` | ClusterAgent | Cluster agent this token is associated with | -| `createdAt` | Time | Timestamp the token was created | -| `id` | ClustersAgentTokenID! | Global ID of the token | +| `clusterAgent` | ClusterAgent | Cluster agent this token is associated with. | +| `createdAt` | Time | Timestamp the token was created. | +| `createdByUser` | User | The user who created the token. | +| `id` | ClustersAgentTokenID! | Global ID of the token. | ### ClusterAgentTokenCreatePayload @@ -554,22 +606,22 @@ Represents the code coverage summary for a project. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User | Author of the commit | -| `authorGravatar` | String | Commit authors gravatar | -| `authorName` | String | Commit authors name | -| `authoredDate` | Time | Timestamp of when the commit was authored | -| `description` | String | Description of the commit message | +| `author` | User | Author of the commit. | +| `authorGravatar` | String | Commit authors gravatar. | +| `authorName` | String | Commit authors name. | +| `authoredDate` | Time | Timestamp of when the commit was authored. | +| `description` | String | Description of the commit message. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `id` | ID! | ID (global ID) of the commit | -| `message` | String | Raw commit message | -| `pipelines` | PipelineConnection | Pipelines of the commit ordered latest first | -| `sha` | String! | SHA1 ID of the commit | -| `shortId` | String! | Short SHA1 ID of the commit | -| `signatureHtml` | String | Rendered HTML of the commit signature | -| `title` | String | Title of the commit message | +| `id` | ID! | ID (global ID) of the commit. | +| `message` | String | Raw commit message. | +| `pipelines` | PipelineConnection | Pipelines of the commit ordered latest first. | +| `sha` | String! | SHA1 ID of the commit. | +| `shortId` | String! | Short SHA1 ID of the commit. | +| `signatureHtml` | String | Rendered HTML of the commit signature. | +| `title` | String | Title of the commit message. | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `webPath` | String! | Web path of the commit | -| `webUrl` | String! | Web URL of the commit | +| `webPath` | String! | Web path of the commit. | +| `webUrl` | String! | Web URL of the commit. | ### CommitCreatePayload @@ -587,10 +639,20 @@ Represents a ComplianceFramework associated with a Project. | Field | Type | Description | | ----- | ---- | ----------- | -| `color` | String! | Hexadecimal representation of compliance framework's label color | -| `description` | String! | Description of the compliance framework | -| `id` | ID! | Compliance framework ID | -| `name` | String! | Name of the compliance framework | +| `color` | String! | Hexadecimal representation of compliance framework's label color. | +| `description` | String! | Description of the compliance framework. | +| `id` | ID! | Compliance framework ID. | +| `name` | String! | Name of the compliance framework. | +| `pipelineConfigurationFullPath` | String | Full path of the compliance pipeline configuration stored in a project repository, such as `.gitlab/.compliance-gitlab-ci.yml@compliance/hippa`. | + +### ComposerMetadata + +Composer metadata. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `composerJson` | PackageComposerJsonType! | Data of the Composer JSON file. | +| `targetSha` | String! | Target SHA of the package. | ### ConfigureSastPayload @@ -609,15 +671,15 @@ A tag expiration policy designed to keep only the images that matter most. | Field | Type | Description | | ----- | ---- | ----------- | -| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule | -| `createdAt` | Time! | Timestamp of when the container expiration policy was created | -| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled | -| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain | -| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire | -| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved | -| `nextRunAt` | Time | Next time that this container expiration policy will get executed | -| `olderThan` | ContainerExpirationPolicyOlderThanEnum | Tags older that this will expire | -| `updatedAt` | Time! | Timestamp of when the container expiration policy was updated | +| `cadence` | ContainerExpirationPolicyCadenceEnum! | This container expiration policy schedule. | +| `createdAt` | Time! | Timestamp of when the container expiration policy was created. | +| `enabled` | Boolean! | Indicates whether this container expiration policy is enabled. | +| `keepN` | ContainerExpirationPolicyKeepEnum | Number of tags to retain. | +| `nameRegex` | UntrustedRegexp | Tags with names matching this regex pattern will expire. | +| `nameRegexKeep` | UntrustedRegexp | Tags with names matching this regex pattern will be preserved. | +| `nextRunAt` | Time | Next time that this container expiration policy will get executed. | +| `olderThan` | ContainerExpirationPolicyOlderThanEnum | Tags older that this will expire. | +| `updatedAt` | Time! | Timestamp of when the container expiration policy was updated. | ### ContainerRepository @@ -633,7 +695,7 @@ A container repository. | `location` | String! | URL of the container repository. | | `name` | String! | Name of the container repository. | | `path` | String! | Path of the container repository. | -| `project` | Project! | Project of the container registry | +| `project` | Project! | Project of the container registry. | | `status` | ContainerRepositoryStatus | Status of the container repository. | | `tagsCount` | Int! | Number of tags associated with this image. | | `updatedAt` | Time! | Timestamp when the container repository was updated. | @@ -652,9 +714,9 @@ Details of a container repository. | `location` | String! | URL of the container repository. | | `name` | String! | Name of the container repository. | | `path` | String! | Path of the container repository. | -| `project` | Project! | Project of the container registry | +| `project` | Project! | Project of the container registry. | | `status` | ContainerRepositoryStatus | Status of the container repository. | -| `tags` | ContainerRepositoryTagConnection | Tags of the container repository | +| `tags` | ContainerRepositoryTagConnection | Tags of the container repository. | | `tagsCount` | Int! | Number of tags associated with this image. | | `updatedAt` | Time! | Timestamp when the container repository was updated. | @@ -684,7 +746,7 @@ Autogenerated return type of CreateAlertIssue. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue created after mutation. | -| `todo` | Todo | The todo after mutation. | +| `todo` | Todo | The to-do item after mutation. | ### CreateAnnotationPayload @@ -832,10 +894,13 @@ Autogenerated return type of CreateSnippet. | Field | Type | Description | | ----- | ---- | ----------- | +| `captchaSiteKey` | String | The CAPTCHA site key which must be used to render a challenge for the user to solve to obtain a valid captchaResponse value. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `needsCaptchaResponse` | Boolean | Indicates whether the operation was detected as possible spam and not completed. If CAPTCHA is enabled, the request must be resubmitted with a valid CAPTCHA response and spam_log_id included for the operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | | `snippet` | Snippet | The snippet after mutation. | -| `spam` | Boolean | Indicates whether the operation returns a record detected as spam. | +| `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. | +| `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | ### CreateTestCasePayload @@ -853,10 +918,10 @@ A custom emoji uploaded by user. | Field | Type | Description | | ----- | ---- | ----------- | -| `external` | Boolean! | Whether the emoji is an external link | -| `id` | CustomEmojiID! | The ID of the emoji | -| `name` | String! | The name of the emoji | -| `url` | String! | The link to file of the emoji | +| `external` | Boolean! | Whether the emoji is an external link. | +| `id` | CustomEmojiID! | The ID of the emoji. | +| `name` | String! | The name of the emoji. | +| `url` | String! | The link to file of the emoji. | ### DastOnDemandScanCreatePayload @@ -868,20 +933,74 @@ Autogenerated return type of DastOnDemandScanCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `pipelineUrl` | String | URL of the pipeline that was created. | +### DastProfile + +Represents a DAST Profile. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `dastScannerProfile` | DastScannerProfile | The associated scanner profile. | +| `dastSiteProfile` | DastSiteProfile | The associated site profile. | +| `description` | String | The description of the scan. | +| `editPath` | String | Relative web path to the edit page of a profile. | +| `id` | DastProfileID! | ID of the profile. | +| `name` | String | The name of the profile. | + +### DastProfileCreatePayload + +Autogenerated return type of DastProfileCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `dastProfile` | DastProfile | The created profile. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `pipelineUrl` | String | The URL of the pipeline that was created. Requires `runAfterCreate` to be set to `true`. | + +### DastProfileDeletePayload + +Autogenerated return type of DastProfileDelete. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +### DastProfileRunPayload + +Autogenerated return type of DastProfileRun. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `pipelineUrl` | String | URL of the pipeline that was created. | + +### DastProfileUpdatePayload + +Autogenerated return type of DastProfileUpdate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `dastProfile` | DastProfile | The updated profile. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `pipelineUrl` | String | The URL of the pipeline that was created. Requires the input argument `runAfterUpdate` to be set to `true` when calling the mutation, otherwise no pipeline will be created. | + ### DastScannerProfile Represents a DAST scanner profile. | Field | Type | Description | | ----- | ---- | ----------- | -| `editPath` | String | Relative web path to the edit page of a scanner profile | +| `editPath` | String | Relative web path to the edit page of a scanner profile. | | `globalId` **{warning-solid}** | DastScannerProfileID! | **Deprecated:** Use `id`. Deprecated in 13.6. | -| `id` | DastScannerProfileID! | ID of the DAST scanner profile | -| `profileName` | String | Name of the DAST scanner profile | +| `id` | DastScannerProfileID! | ID of the DAST scanner profile. | +| `profileName` | String | Name of the DAST scanner profile. | | `scanType` | DastScanTypeEnum | Indicates the type of DAST scan that will run. Either a Passive Scan or an Active Scan. | | `showDebugMessages` | Boolean! | Indicates if debug messages should be included in DAST console output. True to include the debug messages. | -| `spiderTimeout` | Int | The maximum number of minutes allowed for the spider to traverse the site | -| `targetTimeout` | Int | The maximum number of seconds allowed for the site under test to respond to a request | +| `spiderTimeout` | Int | The maximum number of minutes allowed for the spider to traverse the site. | +| `targetTimeout` | Int | The maximum number of seconds allowed for the site under test to respond to a request. | | `useAjaxSpider` | Boolean! | Indicates if the AJAX spider should be used to crawl the target site. True to run the AJAX spider in addition to the traditional spider, and false to run only the traditional spider. | ### DastScannerProfileCreatePayload @@ -920,13 +1039,13 @@ Represents a DAST Site Profile. | Field | Type | Description | | ----- | ---- | ----------- | -| `editPath` | String | Relative web path to the edit page of a site profile | -| `id` | DastSiteProfileID! | ID of the site profile | -| `normalizedTargetUrl` | String | Normalized URL of the target to be scanned | -| `profileName` | String | The name of the site profile | -| `targetUrl` | String | The URL of the target to be scanned | +| `editPath` | String | Relative web path to the edit page of a site profile. | +| `id` | DastSiteProfileID! | ID of the site profile. | +| `normalizedTargetUrl` | String | Normalized URL of the target to be scanned. | +| `profileName` | String | The name of the site profile. | +| `targetUrl` | String | The URL of the target to be scanned. | | `userPermissions` | DastSiteProfilePermissions! | Permissions for the current user on the resource | -| `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile | +| `validationStatus` | DastSiteProfileValidationStatusEnum | The current validation status of the site profile. | ### DastSiteProfileCreatePayload @@ -983,9 +1102,9 @@ Represents a DAST Site Validation. | Field | Type | Description | | ----- | ---- | ----------- | -| `id` | DastSiteValidationID! | Global ID of the site validation | -| `normalizedTargetUrl` | String | Normalized URL of the target to be validated | -| `status` | DastSiteProfileValidationStatusEnum! | Status of the site validation | +| `id` | DastSiteValidationID! | Global ID of the site validation. | +| `normalizedTargetUrl` | String | Normalized URL of the target to be validated. | +| `status` | DastSiteProfileValidationStatusEnum! | Status of the site validation. | ### DastSiteValidationCreatePayload @@ -998,6 +1117,15 @@ Autogenerated return type of DastSiteValidationCreate. | `id` | DastSiteValidationID | ID of the site validation. | | `status` | DastSiteProfileValidationStatusEnum | The current validation status. | +### DastSiteValidationRevokePayload + +Autogenerated return type of DastSiteValidationRevoke. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + ### DeleteAnnotationPayload Autogenerated return type of DeleteAnnotation. @@ -1022,9 +1150,9 @@ The response from the AdminSidekiqQueuesDeleteJobs mutation. | Field | Type | Description | | ----- | ---- | ----------- | -| `completed` | Boolean | Whether or not the entire queue was processed in time; if not, retrying the same request is safe | -| `deletedJobs` | Int | The number of matching jobs deleted | -| `queueSize` | Int | The queue size after processing | +| `completed` | Boolean | Whether or not the entire queue was processed in time; if not, retrying the same request is safe. | +| `deletedJobs` | Int | The number of matching jobs deleted. | +| `queueSize` | Int | The queue size after processing. | ### Design @@ -1032,20 +1160,20 @@ A single design. | Field | Type | Description | | ----- | ---- | ----------- | -| `currentUserTodos` | TodoConnection! | Todos for the current user | -| `diffRefs` | DiffRefs! | The diff refs for this design | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `event` | DesignVersionEvent! | How this design was changed in the current version | -| `filename` | String! | The filename of the design | -| `fullPath` | String! | The full path to the design file | -| `id` | ID! | The ID of this design | -| `image` | String! | The URL of the full-sized image | +| `currentUserTodos` | TodoConnection! | To-do items for the current user. | +| `diffRefs` | DiffRefs! | The diff refs for this design. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `event` | DesignVersionEvent! | How this design was changed in the current version. | +| `filename` | String! | The filename of the design. | +| `fullPath` | String! | The full path to the design file. | +| `id` | ID! | The ID of this design. | +| `image` | String! | The URL of the full-sized image. | | `imageV432x230` | String | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated | -| `issue` | Issue! | The issue the design belongs to | -| `notes` | NoteConnection! | All notes on this noteable | -| `notesCount` | Int! | The total count of user-created notes for this design | -| `project` | Project! | The project the design belongs to | -| `versions` | DesignVersionConnection! | All versions related to this design ordered newest first | +| `issue` | Issue! | The issue the design belongs to. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `notesCount` | Int! | The total count of user-created notes for this design. | +| `project` | Project! | The project the design belongs to. | +| `versions` | DesignVersionConnection! | All versions related to this design ordered newest first. | ### DesignAtVersion @@ -1053,18 +1181,18 @@ A design pinned to a specific version. The image field reflects the design as of | Field | Type | Description | | ----- | ---- | ----------- | -| `design` | Design! | The underlying design | -| `diffRefs` | DiffRefs! | The diff refs for this design | -| `event` | DesignVersionEvent! | How this design was changed in the current version | -| `filename` | String! | The filename of the design | -| `fullPath` | String! | The full path to the design file | -| `id` | ID! | The ID of this design | -| `image` | String! | The URL of the full-sized image | +| `design` | Design! | The underlying design. | +| `diffRefs` | DiffRefs! | The diff refs for this design. | +| `event` | DesignVersionEvent! | How this design was changed in the current version. | +| `filename` | String! | The filename of the design. | +| `fullPath` | String! | The full path to the design file. | +| `id` | ID! | The ID of this design. | +| `image` | String! | The URL of the full-sized image. | | `imageV432x230` | String | The URL of the design resized to fit within the bounds of 432x230. This will be `null` if the image has not been generated | -| `issue` | Issue! | The issue the design belongs to | -| `notesCount` | Int! | The total count of user-created notes for this design | -| `project` | Project! | The project the design belongs to | -| `version` | DesignVersion! | The version this design-at-versions is pinned to | +| `issue` | Issue! | The issue the design belongs to. | +| `notesCount` | Int! | The total count of user-created notes for this design. | +| `project` | Project! | The project the design belongs to. | +| `version` | DesignVersion! | The version this design-at-versions is pinned to. | ### DesignCollection @@ -1072,21 +1200,21 @@ A collection of designs. | Field | Type | Description | | ----- | ---- | ----------- | -| `copyState` | DesignCollectionCopyState | Copy state of the design collection | -| `design` | Design | Find a specific design | -| `designAtVersion` | DesignAtVersion | Find a design as of a version | -| `designs` | DesignConnection! | All designs for the design collection | -| `issue` | Issue! | Issue associated with the design collection | -| `project` | Project! | Project associated with the design collection | -| `version` | DesignVersion | A specific version | -| `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first | +| `copyState` | DesignCollectionCopyState | Copy state of the design collection. | +| `design` | Design | Find a specific design. | +| `designAtVersion` | DesignAtVersion | Find a design as of a version. | +| `designs` | DesignConnection! | All designs for the design collection. | +| `issue` | Issue! | Issue associated with the design collection. | +| `project` | Project! | Project associated with the design collection. | +| `version` | DesignVersion | A specific version. | +| `versions` | DesignVersionConnection! | All versions related to all designs, ordered newest first. | ### DesignManagement | Field | Type | Description | | ----- | ---- | ----------- | -| `designAtVersion` | DesignAtVersion | Find a design as of a version | -| `version` | DesignVersion | Find a version | +| `designAtVersion` | DesignAtVersion | Find a design as of a version. | +| `version` | DesignVersion | Find a version. | ### DesignManagementDeletePayload @@ -1125,11 +1253,11 @@ A specific version in which designs were added, modified or deleted. | Field | Type | Description | | ----- | ---- | ----------- | -| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version | -| `designs` | DesignConnection! | All designs that were changed in the version | -| `designsAtVersion` | DesignAtVersionConnection! | All designs that are visible at this version, as of this version | -| `id` | ID! | ID of the design version | -| `sha` | ID! | SHA of the design version | +| `designAtVersion` | DesignAtVersion! | A particular design as of this version, provided it is visible at this version. | +| `designs` | DesignConnection! | All designs that were changed in the version. | +| `designsAtVersion` | DesignAtVersionConnection! | All designs that are visible at this version, as of this version. | +| `id` | ID! | ID of the design version. | +| `sha` | ID! | SHA of the design version. | ### DestroyBoardListPayload @@ -1204,15 +1332,15 @@ Autogenerated return type of DestroySnippet. | Field | Type | Description | | ----- | ---- | ----------- | -| `action` | StatusAction | Action information for the status. This includes method, button title, icon, path, and title | -| `detailsPath` | String | Path of the details for the status | -| `favicon` | String | Favicon of the status | -| `group` | String | Group of the status | -| `hasDetails` | Boolean | Indicates if the status has further details | -| `icon` | String | Icon of the status | -| `label` | String | Label of the status | -| `text` | String | Text of the status | -| `tooltip` | String | Tooltip associated with the status | +| `action` | StatusAction | Action information for the status. This includes method, button title, icon, path, and title. | +| `detailsPath` | String | Path of the details for the status. | +| `favicon` | String | Favicon of the status. | +| `group` | String | Group of the status. | +| `hasDetails` | Boolean | Indicates if the status has further details. | +| `icon` | String | Icon of the status. | +| `label` | String | Label of the status. | +| `text` | String | Text of the status. | +| `tooltip` | String | Tooltip associated with the status. | ### DevopsAdoptionSegment @@ -1220,10 +1348,9 @@ Segment. | Field | Type | Description | | ----- | ---- | ----------- | -| `groups` | Group! => Array | Assigned groups | -| `id` | ID! | ID of the segment | -| `latestSnapshot` | DevopsAdoptionSnapshot | The latest adoption metrics for the segment | -| `name` | String! | Name of the segment | +| `id` | ID! | ID of the segment. | +| `latestSnapshot` | DevopsAdoptionSnapshot | The latest adoption metrics for the segment. | +| `namespace` | Namespace | Segment namespace. | ### DevopsAdoptionSnapshot @@ -1231,40 +1358,40 @@ Snapshot. | Field | Type | Description | | ----- | ---- | ----------- | -| `deploySucceeded` | Boolean! | At least one deployment succeeded | -| `endTime` | Time! | The end time for the snapshot where the data points were collected | -| `issueOpened` | Boolean! | At least one issue was opened | -| `mergeRequestApproved` | Boolean! | At least one merge request was approved | -| `mergeRequestOpened` | Boolean! | At least one merge request was opened | -| `pipelineSucceeded` | Boolean! | At least one pipeline succeeded | -| `recordedAt` | Time! | The time the snapshot was recorded | -| `runnerConfigured` | Boolean! | At least one runner was used | -| `securityScanSucceeded` | Boolean! | At least one security scan succeeded | -| `startTime` | Time! | The start time for the snapshot where the data points were collected | +| `deploySucceeded` | Boolean! | At least one deployment succeeded. | +| `endTime` | Time! | The end time for the snapshot where the data points were collected. | +| `issueOpened` | Boolean! | At least one issue was opened. | +| `mergeRequestApproved` | Boolean! | At least one merge request was approved. | +| `mergeRequestOpened` | Boolean! | At least one merge request was opened. | +| `pipelineSucceeded` | Boolean! | At least one pipeline succeeded. | +| `recordedAt` | Time! | The time the snapshot was recorded. | +| `runnerConfigured` | Boolean! | At least one runner was used. | +| `securityScanSucceeded` | Boolean! | At least one security scan succeeded. | +| `startTime` | Time! | The start time for the snapshot where the data points were collected. | ### DiffPosition | Field | Type | Description | | ----- | ---- | ----------- | -| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting | -| `filePath` | String! | Path of the file that was changed | -| `height` | Int | Total height of the image | -| `newLine` | Int | Line on HEAD SHA that was changed | -| `newPath` | String | Path of the file on the HEAD SHA | -| `oldLine` | Int | Line on start SHA that was changed | -| `oldPath` | String | Path of the file on the start SHA | -| `positionType` | DiffPositionType! | Type of file the position refers to | -| `width` | Int | Total width of the image | -| `x` | Int | X position of the note | -| `y` | Int | Y position of the note | +| `diffRefs` | DiffRefs! | Information about the branch, HEAD, and base at the time of commenting. | +| `filePath` | String! | Path of the file that was changed. | +| `height` | Int | Total height of the image. | +| `newLine` | Int | Line on HEAD SHA that was changed. | +| `newPath` | String | Path of the file on the HEAD SHA. | +| `oldLine` | Int | Line on start SHA that was changed. | +| `oldPath` | String | Path of the file on the start SHA. | +| `positionType` | DiffPositionType! | Type of file the position refers to. | +| `width` | Int | Total width of the image. | +| `x` | Int | X position of the note. | +| `y` | Int | Y position of the note. | ### DiffRefs | Field | Type | Description | | ----- | ---- | ----------- | -| `baseSha` | String | Merge base of the branch the comment was made on | -| `headSha` | String! | SHA of the HEAD at the time the comment was made | -| `startSha` | String! | SHA of the branch being compared against | +| `baseSha` | String | Merge base of the branch the comment was made on. | +| `headSha` | String! | SHA of the HEAD at the time the comment was made. | +| `startSha` | String! | SHA of the branch being compared against. | ### DiffStats @@ -1272,9 +1399,9 @@ Changes to a single file. | Field | Type | Description | | ----- | ---- | ----------- | -| `additions` | Int! | Number of lines added to this file | -| `deletions` | Int! | Number of lines deleted from this file | -| `path` | String! | File path, relative to repository root | +| `additions` | Int! | Number of lines added to this file. | +| `deletions` | Int! | Number of lines deleted from this file. | +| `path` | String! | File path, relative to repository root. | ### DiffStatsSummary @@ -1282,23 +1409,23 @@ Aggregated summary of changes. | Field | Type | Description | | ----- | ---- | ----------- | -| `additions` | Int! | Number of lines added | -| `changes` | Int! | Number of lines changed | -| `deletions` | Int! | Number of lines deleted | -| `fileCount` | Int! | Number of files changed | +| `additions` | Int! | Number of lines added. | +| `changes` | Int! | Number of lines changed. | +| `deletions` | Int! | Number of lines deleted. | +| `fileCount` | Int! | Number of files changed. | ### Discussion | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp of the discussion's creation | -| `id` | ID! | ID of this discussion | -| `notes` | NoteConnection! | All notes in the discussion | -| `replyId` | ID! | ID used to reply to this discussion | -| `resolvable` | Boolean! | Indicates if the object can be resolved | -| `resolved` | Boolean! | Indicates if the object is resolved | -| `resolvedAt` | Time | Timestamp of when the object was resolved | -| `resolvedBy` | User | User who resolved the object | +| `createdAt` | Time! | Timestamp of the discussion's creation. | +| `id` | DiscussionID! | ID of this discussion. | +| `notes` | NoteConnection! | All notes in the discussion. | +| `replyId` | DiscussionID! | ID used to reply to this discussion. | +| `resolvable` | Boolean! | Indicates if the object can be resolved. | +| `resolved` | Boolean! | Indicates if the object is resolved. | +| `resolvedAt` | Time | Timestamp of when the object was resolved. | +| `resolvedBy` | User | User who resolved the object. | ### DiscussionToggleResolvePayload @@ -1326,12 +1453,12 @@ Describes where code is deployed for a project. | Field | Type | Description | | ----- | ---- | ----------- | -| `id` | ID! | ID of the environment | -| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned | -| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment | -| `name` | String! | Human-readable name of the environment | +| `id` | ID! | ID of the environment. | +| `latestOpenedMostSevereAlert` | AlertManagementAlert | The most severe open alert for the environment. If multiple alerts have equal severity, the most recent is returned. | +| `metricsDashboard` | MetricsDashboard | Metrics dashboard schema for the environment. | +| `name` | String! | Human-readable name of the environment. | | `path` | String! | The path to the environment. | -| `state` | String! | State of the environment, for example: available/stopped | +| `state` | String! | State of the environment, for example: available/stopped. | ### EnvironmentsCanaryIngressUpdatePayload @@ -1348,50 +1475,52 @@ Represents an epic. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User! | Author of the epic | -| `children` | EpicConnection | Children (sub-epics) of the epic | -| `closedAt` | Time | Timestamp of when the epic was closed | -| `confidential` | Boolean | Indicates if the epic is confidential | -| `createdAt` | Time | Timestamp of when the epic was created | -| `currentUserTodos` | TodoConnection! | Todos for the current user | -| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues | -| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants | -| `description` | String | Description of the epic | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `downvotes` | Int! | Number of downvotes the epic has received | -| `dueDate` | Time | Due date of the epic | -| `dueDateFixed` | Time | Fixed due date of the epic | -| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones | -| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set | -| `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 | -| `hasParent` | Boolean! | Indicates if the epic has a parent epic | -| `healthStatus` | EpicHealthStatus | Current health status of the epic | -| `id` | ID! | ID of the epic | -| `iid` | ID! | Internal ID of the epic | -| `issues` | EpicIssueConnection | A list of issues associated with the epic | -| `labels` | LabelConnection | Labels assigned to the epic | -| `notes` | NoteConnection! | All notes on this noteable | -| `parent` | Epic | Parent epic of the epic | -| `participants` | UserConnection | List of participants for the epic | -| `reference` | String! | Internal reference of the epic. Returned in shortened format by default | -| `relationPath` | String | URI path of the epic-issue relationship | -| `relativePosition` | Int | The relative position of the epic in the epic tree | -| `startDate` | Time | Start date of the epic | -| `startDateFixed` | Time | Fixed start date of the epic | -| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones | -| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set | -| `state` | EpicState! | State of the epic | -| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic | -| `title` | String | Title of the epic | -| `updatedAt` | Time | Timestamp of when the epic was updated | -| `upvotes` | Int! | Number of upvotes the epic has received | -| `userDiscussionsCount` | Int! | Number of user discussions in the epic | -| `userNotesCount` | Int! | Number of user notes of the epic | +| `author` | User! | Author of the epic. | +| `awardEmoji` | AwardEmojiConnection | A list of award emojis associated with the epic. | +| `children` | EpicConnection | Children (sub-epics) of the epic. | +| `closedAt` | Time | Timestamp of when the epic was closed. | +| `confidential` | Boolean | Indicates if the epic is confidential. | +| `createdAt` | Time | Timestamp of when the epic was created. | +| `currentUserTodos` | TodoConnection! | To-do items for the current user. | +| `descendantCounts` | EpicDescendantCount | Number of open and closed descendant epics and issues. | +| `descendantWeightSum` | EpicDescendantWeights | Total weight of open and closed issues in the epic and its descendants. | +| `description` | String | Description of the epic. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `downvotes` | Int! | Number of downvotes the epic has received. | +| `dueDate` | Time | Due date of the epic. | +| `dueDateFixed` | Time | Fixed due date of the epic. | +| `dueDateFromMilestones` | Time | Inherited due date of the epic from milestones. | +| `dueDateIsFixed` | Boolean | Indicates if the due date has been manually set. | +| `events` | EventConnection | A list of events associated with the object. | +| `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. | +| `hasParent` | Boolean! | Indicates if the epic has a parent epic. | +| `healthStatus` | EpicHealthStatus | Current health status of the epic. | +| `id` | ID! | ID of the epic. | +| `iid` | ID! | Internal ID of the epic. | +| `issues` | EpicIssueConnection | A list of issues associated with the epic. | +| `labels` | LabelConnection | Labels assigned to the epic. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `parent` | Epic | Parent epic of the epic. | +| `participants` | UserConnection | List of participants for the epic. | +| `reference` | String! | Internal reference of the epic. Returned in shortened format by default. | +| `relationPath` | String | URI path of the epic-issue relationship. | +| `relativePosition` | Int | The relative position of the epic in the epic tree. | +| `startDate` | Time | Start date of the epic. | +| `startDateFixed` | Time | Fixed start date of the epic. | +| `startDateFromMilestones` | Time | Inherited start date of the epic from milestones. | +| `startDateIsFixed` | Boolean | Indicates if the start date has been manually set. | +| `state` | EpicState! | State of the epic. | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the epic. | +| `title` | String | Title of the epic. | +| `updatedAt` | Time | Timestamp of when the epic was updated. | +| `upvotes` | Int! | Number of upvotes the epic has received. | +| `userDiscussionsCount` | Int! | Number of user discussions in the epic. | +| `userNotesCount` | Int! | Number of user notes of the epic. | | `userPermissions` | EpicPermissions! | Permissions for the current user on the resource | -| `webPath` | String! | Web path of the epic | -| `webUrl` | String! | Web URL of the epic | +| `webPath` | String! | Web path of the epic. | +| `webUrl` | String! | Web URL of the epic. | ### EpicAddIssuePayload @@ -1414,16 +1543,36 @@ Represents an epic board. | `lists` | EpicListConnection | Epic board lists. | | `name` | String | Name of the board. | +### EpicBoardCreatePayload + +Autogenerated return type of EpicBoardCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `epicBoard` | EpicBoard | The created epic board. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | + +### EpicBoardListCreatePayload + +Autogenerated return type of EpicBoardListCreate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `list` | EpicList | Epic list in the epic board. | + ### EpicDescendantCount Counts of descendent epics. | Field | Type | Description | | ----- | ---- | ----------- | -| `closedEpics` | Int | Number of closed child epics | -| `closedIssues` | Int | Number of closed epic issues | -| `openedEpics` | Int | Number of opened child epics | -| `openedIssues` | Int | Number of opened epic issues | +| `closedEpics` | Int | Number of closed child epics. | +| `closedIssues` | Int | Number of closed epic issues. | +| `openedEpics` | Int | Number of opened child epics. | +| `openedIssues` | Int | Number of opened epic issues. | ### EpicDescendantWeights @@ -1431,8 +1580,8 @@ Total weight of open and closed descendant issues. | Field | 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 | +| `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. | ### EpicHealthStatus @@ -1440,9 +1589,9 @@ Health status of child issues. | Field | Type | Description | | ----- | ---- | ----------- | -| `issuesAtRisk` | Int | Number of issues at risk | -| `issuesNeedingAttention` | Int | Number of issues that need attention | -| `issuesOnTrack` | Int | Number of issues on track | +| `issuesAtRisk` | Int | Number of issues at risk. | +| `issuesNeedingAttention` | Int | Number of issues that need attention. | +| `issuesOnTrack` | Int | Number of issues on track. | ### EpicIssue @@ -1450,61 +1599,61 @@ Relationship between an epic and an issue. | Field | Type | Description | | ----- | ---- | ----------- | -| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue | -| `assignees` | UserConnection | Assignees of the issue | -| `author` | User! | User that created the issue | +| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue. | +| `assignees` | UserConnection | Assignees of the issue. | +| `author` | User! | User that created the issue. | | `blocked` | Boolean! | Indicates the issue is blocked. | | `blockedByCount` | Int | Count of issues blocking this issue. | -| `closedAt` | Time | Timestamp of when the issue was closed | -| `confidential` | Boolean! | Indicates the issue is confidential | -| `createNoteEmail` | String | User specific email address for the issue | -| `createdAt` | Time! | Timestamp of when the issue was created | -| `currentUserTodos` | TodoConnection! | Todos for the current user | -| `description` | String | Description of the issue | +| `closedAt` | Time | Timestamp of when the issue was closed. | +| `confidential` | Boolean! | Indicates the issue is confidential. | +| `createNoteEmail` | String | User specific email address for the issue. | +| `createdAt` | Time! | Timestamp of when the issue was created. | +| `currentUserTodos` | TodoConnection! | To-do items for the current user. | +| `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 | -| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `downvotes` | Int! | Number of downvotes the issue has received | -| `dueDate` | Time | Due date of the issue | -| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled | +| `designCollection` | DesignCollection | Collection of design images associated with this issue. | +| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `downvotes` | Int! | Number of downvotes the issue has received. | +| `dueDate` | Time | Due date of the issue. | +| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. | | `epic` | Epic | Epic to which this issue belongs. | -| `epicIssueId` | ID! | ID of the epic-issue relation | +| `epicIssueId` | ID! | ID of the epic-issue relation. | | `healthStatus` | HealthStatus | Current health status. | -| `humanTimeEstimate` | String | Human-readable time estimate of the issue | -| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue | -| `id` | ID | Global ID of the epic-issue relation | -| `iid` | ID! | Internal ID of the issue | +| `humanTimeEstimate` | String | Human-readable time estimate of the issue. | +| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue. | +| `id` | ID | Global ID of the epic-issue relation. | +| `iid` | ID! | Internal ID of the issue. | | `iteration` | Iteration | Iteration of the issue. | -| `labels` | LabelConnection | Labels of the issue | +| `labels` | LabelConnection | Labels of the issue. | | `metricImages` | MetricImage! => Array | Metric images associated to the issue. | -| `milestone` | Milestone | Milestone of the issue | -| `moved` | Boolean | Indicates if issue got moved from other project | -| `movedTo` | Issue | Updated Issue after it got moved to another project | -| `notes` | NoteConnection! | All notes on this noteable | -| `participants` | UserConnection | List of participants in the issue | -| `reference` | String! | Internal reference of the issue. Returned in shortened format by default | -| `relationPath` | String | URI path of the epic-issue relation | -| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) | -| `severity` | IssuableSeverity | Severity level of the incident | +| `milestone` | Milestone | Milestone of the issue. | +| `moved` | Boolean | Indicates if issue got moved from other project. | +| `movedTo` | Issue | Updated Issue after it got moved to another project. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `participants` | UserConnection | List of participants in the issue. | +| `reference` | String! | Internal reference of the issue. Returned in shortened format by default. | +| `relationPath` | String | URI path of the epic-issue relation. | +| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards). | +| `severity` | IssuableSeverity | Severity level of the incident. | | `slaDueAt` | Time | Timestamp of when the issue SLA expires. | -| `state` | IssueState! | State of the issue | +| `state` | IssueState! | State of the issue. | | `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. | -| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue | -| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue | -| `timeEstimate` | Int! | Time estimate of the issue | -| `title` | String! | Title of the issue | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue. | +| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue. | +| `timeEstimate` | Int! | Time estimate of the issue. | +| `title` | String! | Title of the issue. | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `totalTimeSpent` | Int! | Total time reported as spent on the issue | -| `type` | IssueType | Type of the issue | -| `updatedAt` | Time! | Timestamp of when the issue was last updated | -| `updatedBy` | User | User that last updated the issue | -| `upvotes` | Int! | Number of upvotes the issue has received | -| `userDiscussionsCount` | Int! | Number of user discussions in the issue | -| `userNotesCount` | Int! | Number of user notes of the issue | +| `totalTimeSpent` | Int! | Total time reported as spent on the issue. | +| `type` | IssueType | Type of the issue. | +| `updatedAt` | Time! | Timestamp of when the issue was last updated. | +| `updatedBy` | User | User that last updated the issue. | +| `upvotes` | Int! | Number of upvotes the issue has received. | +| `userDiscussionsCount` | Int! | Number of user discussions in the issue. | +| `userNotesCount` | Int! | Number of user notes of the issue. | | `userPermissions` | IssuePermissions! | Permissions for the current user on the resource | -| `webPath` | String! | Web path of the issue | -| `webUrl` | String! | Web URL of the issue | +| `webPath` | String! | Web path of the issue. | +| `webUrl` | String! | Web URL of the issue. | | `weight` | Int | Weight of the issue. | ### EpicList @@ -1554,6 +1703,18 @@ Autogenerated return type of EpicTreeReorder. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | +### Event + +Representing an event. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `action` | EventAction! | Action of the event. | +| `author` | User! | Author of this event. | +| `createdAt` | Time! | When this event was created. | +| `id` | ID! | ID of the event. | +| `updatedAt` | Time! | When this event was updated. | + ### ExportRequirementsPayload Autogenerated return type of ExportRequirements. @@ -1569,114 +1730,123 @@ Represents an external issue. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time | Timestamp of when the issue was created | -| `externalTracker` | String | Type of external tracker | -| `relativeReference` | String | Relative reference of the issue in the external tracker | -| `status` | String | Status of the issue in the external tracker | -| `title` | String | Title of the issue in the external tracker | -| `updatedAt` | Time | Timestamp of when the issue was updated | -| `webUrl` | String | URL to the issue in the external tracker | +| `createdAt` | Time | Timestamp of when the issue was created. | +| `externalTracker` | String | Type of external tracker. | +| `relativeReference` | String | Relative reference of the issue in the external tracker. | +| `status` | String | Status of the issue in the external tracker. | +| `title` | String | Title of the issue in the external tracker. | +| `updatedAt` | Time | Timestamp of when the issue was updated. | +| `webUrl` | String | URL to the issue in the external tracker. | ### GeoNode | Field | Type | Description | | ----- | ---- | ----------- | -| `containerRepositoriesMaxCapacity` | Int | The maximum concurrency of container repository sync for this secondary node | -| `enabled` | Boolean | Indicates whether this Geo node is enabled | -| `filesMaxCapacity` | Int | The maximum concurrency of LFS/attachment backfill for this secondary node | -| `id` | ID! | ID of this GeoNode | -| `internalUrl` | String | The URL defined on the primary node that secondary nodes should use to contact it | -| `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node | -| `minimumReverificationInterval` | Int | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified | -| `name` | String | The unique identifier for this Geo node | -| `packageFileRegistries` | PackageFileRegistryConnection | Package file registries of the GeoNode | -| `primary` | Boolean | Indicates whether this Geo node is the primary | -| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node | -| `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces` | -| `selectiveSyncShards` | String! => Array | The repository storages whose projects should be synced, if `selective_sync_type` == `shards` | -| `selectiveSyncType` | String | Indicates if syncing is limited to only specific groups, or shards | -| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node | -| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage | -| `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node | -| `url` | String | The user-facing URL for this Geo node | -| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node | +| `containerRepositoriesMaxCapacity` | Int | The maximum concurrency of container repository sync for this secondary node. | +| `enabled` | Boolean | Indicates whether this Geo node is enabled. | +| `filesMaxCapacity` | Int | The maximum concurrency of LFS/attachment backfill for this secondary node. | +| `id` | ID! | ID of this GeoNode. | +| `internalUrl` | String | The URL defined on the primary node that secondary nodes should use to contact it. | +| `mergeRequestDiffRegistries` | MergeRequestDiffRegistryConnection | Find merge request diff registries on this Geo node. | +| `minimumReverificationInterval` | Int | The interval (in days) in which the repository verification is valid. Once expired, it will be reverified. | +| `name` | String | The unique identifier for this Geo node. | +| `packageFileRegistries` | PackageFileRegistryConnection | Package file registries of the GeoNode. | +| `primary` | Boolean | Indicates whether this Geo node is the primary. | +| `reposMaxCapacity` | Int | The maximum concurrency of repository backfill for this secondary node. | +| `selectiveSyncNamespaces` | NamespaceConnection | The namespaces that should be synced, if `selective_sync_type` == `namespaces`. | +| `selectiveSyncShards` | String! => Array | The repository storages whose projects should be synced, if `selective_sync_type` == `shards`. | +| `selectiveSyncType` | String | Indicates if syncing is limited to only specific groups, or shards. | +| `snippetRepositoryRegistries` | SnippetRepositoryRegistryConnection | Find snippet repository registries on this Geo node. | +| `syncObjectStorage` | Boolean | Indicates if this secondary node will replicate blobs in Object Storage. | +| `terraformStateVersionRegistries` | TerraformStateVersionRegistryConnection | Find terraform state version registries on this Geo node. | +| `url` | String | The user-facing URL for this Geo node. | +| `verificationMaxCapacity` | Int | The maximum concurrency of repository verification for this secondary node. | + +### GitlabSubscriptionActivatePayload + +Autogenerated return type of GitlabSubscriptionActivate. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | ### GrafanaIntegration | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp of the issue's creation | -| `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 | -| `updatedAt` | Time! | Timestamp of the issue's last activity | +| `createdAt` | Time! | Timestamp of the issue's creation. | +| `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. | +| `updatedAt` | Time! | Timestamp of the issue's last activity. | ### Group | Field | Type | Description | | ----- | ---- | ----------- | -| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes | -| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes | -| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group | -| `avatarUrl` | String | Avatar URL of the group | -| `board` | Board | A single board of the group | -| `boards` | BoardConnection | Boards of the group | -| `codeCoverageActivities` | CodeCoverageActivityConnection | Represents the code coverage activity for this group | +| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes. | +| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes. | +| `autoDevopsEnabled` | Boolean | Indicates whether Auto DevOps is enabled for all projects within this group. | +| `avatarUrl` | String | Avatar URL of the group. | +| `board` | Board | A single board of the group. | +| `boards` | BoardConnection | Boards of the group. | +| `codeCoverageActivities` | CodeCoverageActivityConnection | Represents the code coverage activity for this group. | | `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. | -| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the group | -| `containerRepositoriesCount` | Int! | Number of container repositories in the group | -| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit | -| `customEmoji` | CustomEmojiConnection | Custom emoji within this namespace Available only when feature flag `custom_emoji` is enabled. | -| `description` | String | Description of the namespace | +| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the group. | +| `containerRepositoriesCount` | Int! | Number of container repositories in the group. | +| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit. | +| `customEmoji` | CustomEmojiConnection | Custom emoji within this namespace. Available only when feature flag `custom_emoji` is enabled. | +| `description` | String | Description of the namespace. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled | -| `epic` | Epic | Find a single epic | -| `epicBoard` | EpicBoard | Find a single epic board | -| `epicBoards` | EpicBoardConnection | Find epic boards | -| `epics` | EpicConnection | Find epics | +| `emailsDisabled` | Boolean | Indicates if a group has email notifications disabled. | +| `epic` | Epic | Find a single epic. | +| `epicBoard` | EpicBoard | Find a single epic board. | +| `epicBoards` | EpicBoardConnection | Find epic boards. | +| `epics` | EpicConnection | Find epics. | | `epicsEnabled` | Boolean | Indicates if Epics are enabled for namespace | -| `fullName` | String! | Full name of the namespace | -| `fullPath` | ID! | Full path of the namespace | -| `groupMembers` | GroupMemberConnection | A membership of a user within this group | +| `fullName` | String! | Full name of the namespace. | +| `fullPath` | ID! | Full path of the namespace. | +| `groupMembers` | GroupMemberConnection | A membership of a user within this group. | | `groupTimelogsEnabled` | Boolean | Indicates if Group timelogs are enabled for namespace | -| `id` | ID! | ID of the namespace | -| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase | -| `issues` | IssueConnection | Issues for projects in this group | -| `iterations` | IterationConnection | Find iterations | -| `label` | Label | A label available on this group | -| `labels` | LabelConnection | Labels available on this group | -| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace | -| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned | -| `mergeRequests` | MergeRequestConnection | Merge requests for projects in this group | -| `milestones` | MilestoneConnection | Milestones of the group | -| `name` | String! | Name of the namespace | -| `packageSettings` | PackageSettings | The package settings for the namespace | -| `parent` | Group | Parent group | -| `path` | String! | Path of the namespace | -| `projectCreationLevel` | String | The permission level required to create projects in the group | -| `projects` | ProjectConnection! | Projects within this namespace | -| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit | -| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace | -| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication | -| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces | -| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented | -| `stats` | GroupStats | Group statistics | -| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes | -| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group | -| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active | -| `timelogs` | TimelogConnection! | Time logged in issues by group members | -| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes | -| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes | -| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced | +| `id` | ID! | ID of the namespace. | +| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase. | +| `issues` | IssueConnection | Issues for projects in this group. | +| `iterations` | IterationConnection | Find iterations. | +| `label` | Label | A label available on this group. | +| `labels` | LabelConnection | Labels available on this group. | +| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace. | +| `mentionsDisabled` | Boolean | Indicates if a group is disabled from getting mentioned. | +| `mergeRequests` | MergeRequestConnection | Merge requests for projects in this group. | +| `milestones` | MilestoneConnection | Milestones of the group. | +| `name` | String! | Name of the namespace. | +| `packageSettings` | PackageSettings | The package settings for the namespace. | +| `parent` | Group | Parent group. | +| `path` | String! | Path of the namespace. | +| `projectCreationLevel` | String | The permission level required to create projects in the group. | +| `projects` | ProjectConnection! | Projects within this namespace. | +| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit. | +| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace. | +| `requireTwoFactorAuthentication` | Boolean | Indicates if all users in this group are required to set up two-factor authentication. | +| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces. | +| `shareWithGroupLock` | Boolean | Indicates if sharing a project with another group within this group is prevented. | +| `stats` | GroupStats | Group statistics. | +| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes. | +| `subgroupCreationLevel` | String | The permission level required to create subgroups within the group. | +| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active. | +| `timelogs` | TimelogConnection! | Time logged in issues by group members. | +| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes. | +| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes. | +| `twoFactorGracePeriod` | Int | Time before two-factor authentication is enforced. | | `userPermissions` | GroupPermissions! | Permissions for the current user on the resource | -| `visibility` | String | Visibility of the namespace | -| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the projects in the group and its subgroups | -| `vulnerabilitiesCountByDay` | VulnerabilitiesCountByDayConnection | Number of vulnerabilities per day for the projects in the group and its subgroups | +| `visibility` | String | Visibility of the namespace. | +| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the projects in the group and its subgroups. | +| `vulnerabilitiesCountByDay` | VulnerabilitiesCountByDayConnection | Number of vulnerabilities per day for the projects in the group and its subgroups. | | `vulnerabilitiesCountByDayAndSeverity` **{warning-solid}** | VulnerabilitiesCountByDayAndSeverityConnection | **Deprecated:** Use `vulnerabilitiesCountByDay`. Deprecated in 13.3. | -| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade | -| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilties of the group and its subgroups | -| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups | -| `webUrl` | String! | Web URL of the group | +| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade. | +| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilities of the group and its subgroups. | +| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the group and its subgroups. | +| `webUrl` | String! | Web URL of the group. | ### GroupMember @@ -1684,14 +1854,14 @@ Represents a Group Membership. | Field | Type | Description | | ----- | ---- | ----------- | -| `accessLevel` | AccessLevel | GitLab::Access level | -| `createdAt` | Time | Date and time the membership was created | -| `createdBy` | User | User that authorized membership | -| `expiresAt` | Time | Date and time the membership expires | -| `group` | Group | Group that a User is a member of | -| `id` | ID! | ID of the member | -| `updatedAt` | Time | Date and time the membership was last updated | -| `user` | User! | User that is associated with the member object | +| `accessLevel` | AccessLevel | GitLab::Access level. | +| `createdAt` | Time | Date and time the membership was created. | +| `createdBy` | User | User that authorized membership. | +| `expiresAt` | Time | Date and time the membership expires. | +| `group` | Group | Group that a User is a member of. | +| `id` | ID! | ID of the member. | +| `updatedAt` | Time | Date and time the membership was last updated. | +| `user` | User! | User that is associated with the member object. | | `userPermissions` | GroupPermissions! | Permissions for the current user on the resource | ### GroupPermissions @@ -1715,7 +1885,7 @@ Contains statistics about a group. | Field | Type | Description | | ----- | ---- | ----------- | -| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group | +| `releaseStats` | GroupReleaseStats | Statistics related to releases within the group. | ### HttpIntegrationCreatePayload @@ -1768,6 +1938,7 @@ Describes an incident management on-call rotation. | `lengthUnit` | OncallRotationUnitEnum | Unit of the on-call rotation length. | | `name` | String! | Name of the on-call rotation. | | `participants` | OncallParticipantTypeConnection | Participants of the on-call rotation. | +| `shifts` | IncidentManagementOncallShiftConnection | Blocks of time for which a participant is on-call within a given time frame. Time frame cannot exceed one month. | | `startsAt` | Time | Start date of the on-call rotation. | ### IncidentManagementOncallSchedule @@ -1776,20 +1947,30 @@ Describes an incident management on-call schedule. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String | Description of the on-call schedule | -| `iid` | ID! | Internal ID of the on-call schedule | -| `name` | String! | Name of the on-call schedule | -| `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule | -| `timezone` | String! | Time zone of the on-call schedule | +| `description` | String | Description of the on-call schedule. | +| `iid` | ID! | Internal ID of the on-call schedule. | +| `name` | String! | Name of the on-call schedule. | +| `rotations` | IncidentManagementOncallRotationConnection! | On-call rotations for the on-call schedule. | +| `timezone` | String! | Time zone of the on-call schedule. | + +### IncidentManagementOncallShift + +A block of time for which a participant is on-call.. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `endsAt` | Time | End time of the on-call shift. | +| `participant` | OncallParticipantType | Participant assigned to the on-call shift. | +| `startsAt` | Time | Start time of the on-call shift. | ### InstanceSecurityDashboard | Field | Type | Description | | ----- | ---- | ----------- | -| `projects` | ProjectConnection! | Projects selected in Instance Security Dashboard | -| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade | -| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilties from projects selected in Instance Security Dashboard | -| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard | +| `projects` | ProjectConnection! | Projects selected in Instance Security Dashboard. | +| `vulnerabilityGrades` | VulnerableProjectsByGrade! => Array | Represents vulnerable project counts for each grade. | +| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the vulnerabilities from projects selected in Instance Security Dashboard. | +| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity from projects selected in Instance Security Dashboard. | ### InstanceStatisticsMeasurement @@ -1797,67 +1978,67 @@ Represents a recorded measurement (object count) for the Admins. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | Object count | -| `identifier` | MeasurementIdentifier! | The type of objects being measured | -| `recordedAt` | Time | The time the measurement was recorded | +| `count` | Int! | Object count. | +| `identifier` | MeasurementIdentifier! | The type of objects being measured. | +| `recordedAt` | Time | The time the measurement was recorded. | ### Issue | Field | Type | Description | | ----- | ---- | ----------- | -| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue | -| `assignees` | UserConnection | Assignees of the issue | -| `author` | User! | User that created the issue | +| `alertManagementAlert` | AlertManagementAlert | Alert associated to this issue. | +| `assignees` | UserConnection | Assignees of the issue. | +| `author` | User! | User that created the issue. | | `blocked` | Boolean! | Indicates the issue is blocked. | | `blockedByCount` | Int | Count of issues blocking this issue. | -| `closedAt` | Time | Timestamp of when the issue was closed | -| `confidential` | Boolean! | Indicates the issue is confidential | -| `createNoteEmail` | String | User specific email address for the issue | -| `createdAt` | Time! | Timestamp of when the issue was created | -| `currentUserTodos` | TodoConnection! | Todos for the current user | -| `description` | String | Description of the issue | +| `closedAt` | Time | Timestamp of when the issue was closed. | +| `confidential` | Boolean! | Indicates the issue is confidential. | +| `createNoteEmail` | String | User specific email address for the issue. | +| `createdAt` | Time! | Timestamp of when the issue was created. | +| `currentUserTodos` | TodoConnection! | To-do items for the current user. | +| `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 | -| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `downvotes` | Int! | Number of downvotes the issue has received | -| `dueDate` | Time | Due date of the issue | -| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled | +| `designCollection` | DesignCollection | Collection of design images associated with this issue. | +| `discussionLocked` | Boolean! | Indicates discussion is locked on the issue. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `downvotes` | Int! | Number of downvotes the issue has received. | +| `dueDate` | Time | Due date of the issue. | +| `emailsDisabled` | Boolean! | Indicates if a project has email notifications disabled: `true` if email notifications are disabled. | | `epic` | Epic | Epic to which this issue belongs. | | `healthStatus` | HealthStatus | Current health status. | -| `humanTimeEstimate` | String | Human-readable time estimate of the issue | -| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue | -| `id` | ID! | ID of the issue | -| `iid` | ID! | Internal ID of the issue | +| `humanTimeEstimate` | String | Human-readable time estimate of the issue. | +| `humanTotalTimeSpent` | String | Human-readable total time reported as spent on the issue. | +| `id` | ID! | ID of the issue. | +| `iid` | ID! | Internal ID of the issue. | | `iteration` | Iteration | Iteration of the issue. | -| `labels` | LabelConnection | Labels of the issue | +| `labels` | LabelConnection | Labels of the issue. | | `metricImages` | MetricImage! => Array | Metric images associated to the issue. | -| `milestone` | Milestone | Milestone of the issue | -| `moved` | Boolean | Indicates if issue got moved from other project | -| `movedTo` | Issue | Updated Issue after it got moved to another project | -| `notes` | NoteConnection! | All notes on this noteable | -| `participants` | UserConnection | List of participants in the issue | -| `reference` | String! | Internal reference of the issue. Returned in shortened format by default | -| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards) | -| `severity` | IssuableSeverity | Severity level of the incident | +| `milestone` | Milestone | Milestone of the issue. | +| `moved` | Boolean | Indicates if issue got moved from other project. | +| `movedTo` | Issue | Updated Issue after it got moved to another project. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `participants` | UserConnection | List of participants in the issue. | +| `reference` | String! | Internal reference of the issue. Returned in shortened format by default. | +| `relativePosition` | Int | Relative position of the issue (used for positioning in epic tree and issue boards). | +| `severity` | IssuableSeverity | Severity level of the incident. | | `slaDueAt` | Time | Timestamp of when the issue SLA expires. | -| `state` | IssueState! | State of the issue | +| `state` | IssueState! | State of the issue. | | `statusPagePublishedIncident` | Boolean | Indicates whether an issue is published to the status page. | -| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue | -| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue | -| `timeEstimate` | Int! | Time estimate of the issue | -| `title` | String! | Title of the issue | +| `subscribed` | Boolean! | Indicates the currently logged in user is subscribed to the issue. | +| `taskCompletionStatus` | TaskCompletionStatus! | Task completion status of the issue. | +| `timeEstimate` | Int! | Time estimate of the issue. | +| `title` | String! | Title of the issue. | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `totalTimeSpent` | Int! | Total time reported as spent on the issue | -| `type` | IssueType | Type of the issue | -| `updatedAt` | Time! | Timestamp of when the issue was last updated | -| `updatedBy` | User | User that last updated the issue | -| `upvotes` | Int! | Number of upvotes the issue has received | -| `userDiscussionsCount` | Int! | Number of user discussions in the issue | -| `userNotesCount` | Int! | Number of user notes of the issue | +| `totalTimeSpent` | Int! | Total time reported as spent on the issue. | +| `type` | IssueType | Type of the issue. | +| `updatedAt` | Time! | Timestamp of when the issue was last updated. | +| `updatedBy` | User | User that last updated the issue. | +| `upvotes` | Int! | Number of upvotes the issue has received. | +| `userDiscussionsCount` | Int! | Number of user discussions in the issue. | +| `userNotesCount` | Int! | Number of user notes of the issue. | | `userPermissions` | IssuePermissions! | Permissions for the current user on the resource | -| `webPath` | String! | Web path of the issue | -| `webUrl` | String! | Web URL of the issue | +| `webPath` | String! | Web path of the issue. | +| `webUrl` | String! | Web URL of the issue. | | `weight` | Int | Weight of the issue. | ### IssueMoveListPayload @@ -2001,33 +2182,33 @@ Represents an iteration object. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp of iteration creation | -| `description` | String | Description of the iteration | +| `createdAt` | Time! | Timestamp of iteration creation. | +| `description` | String | Description of the iteration. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `dueDate` | Time | Timestamp of the iteration due date | -| `id` | ID! | ID of the iteration | -| `iid` | ID! | Internal ID of the iteration | -| `report` | TimeboxReport | Historically accurate report about the timebox | -| `scopedPath` | String | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts | -| `scopedUrl` | String | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts | -| `startDate` | Time | Timestamp of the iteration start date | -| `state` | IterationState! | State of the iteration | -| `title` | String! | Title of the iteration | -| `updatedAt` | Time! | Timestamp of last iteration update | -| `webPath` | String! | Web path of the iteration | -| `webUrl` | String! | Web URL of the iteration | +| `dueDate` | Time | Timestamp of the iteration due date. | +| `id` | ID! | ID of the iteration. | +| `iid` | ID! | Internal ID of the iteration. | +| `report` | TimeboxReport | Historically accurate report about the timebox. | +| `scopedPath` | String | Web path of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | +| `scopedUrl` | String | Web URL of the iteration, scoped to the query parent. Only valid for Project parents. Returns null in other contexts. | +| `startDate` | Time | Timestamp of the iteration start date. | +| `state` | IterationState! | State of the iteration. | +| `title` | String! | Title of the iteration. | +| `updatedAt` | Time! | Timestamp of last iteration update. | +| `webPath` | String! | Web path of the iteration. | +| `webUrl` | String! | Web URL of the iteration. | ### JiraImport | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time | Timestamp of when the Jira import was created | -| `failedToImportCount` | Int! | Count of issues that failed to import | -| `importedIssuesCount` | Int! | Count of issues that were successfully imported | -| `jiraProjectKey` | String! | Project key for the imported Jira project | -| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled | -| `scheduledBy` | User | User that started the Jira import | -| `totalIssueCount` | Int! | Total count of issues that were attempted to import | +| `createdAt` | Time | Timestamp of when the Jira import was created. | +| `failedToImportCount` | Int! | Count of issues that failed to import. | +| `importedIssuesCount` | Int! | Count of issues that were successfully imported. | +| `jiraProjectKey` | String! | Project key for the imported Jira project. | +| `scheduledAt` | Time | Timestamp of when the Jira import was scheduled. | +| `scheduledBy` | User | User that started the Jira import. | +| `totalIssueCount` | Int! | Total count of issues that were attempted to import. | ### JiraImportStartPayload @@ -2053,39 +2234,39 @@ Autogenerated return type of JiraImportUsers. | Field | Type | Description | | ----- | ---- | ----------- | -| `key` | String! | Key of the Jira project | -| `name` | String | Name of the Jira project | -| `projectId` | Int! | ID of the Jira project | +| `key` | String! | Key of the Jira project. | +| `name` | String | Name of the Jira project. | +| `projectId` | Int! | ID of the Jira project. | ### JiraService | Field | Type | Description | | ----- | ---- | ----------- | -| `active` | Boolean | Indicates if the service is active | -| `projects` | JiraProjectConnection | List of all Jira projects fetched through Jira REST API | -| `type` | String | Class name of the service | +| `active` | Boolean | Indicates if the service is active. | +| `projects` | JiraProjectConnection | List of all Jira projects fetched through Jira REST API. | +| `type` | String | Class name of the service. | ### JiraUser | Field | Type | Description | | ----- | ---- | ----------- | -| `gitlabId` | Int | ID of the matched GitLab user | -| `gitlabName` | String | Name of the matched GitLab user | -| `gitlabUsername` | String | Username of the matched GitLab user | -| `jiraAccountId` | String! | Account ID of the Jira user | -| `jiraDisplayName` | String! | Display name of the Jira user | -| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails | +| `gitlabId` | Int | ID of the matched GitLab user. | +| `gitlabName` | String | Name of the matched GitLab user. | +| `gitlabUsername` | String | Username of the matched GitLab user. | +| `jiraAccountId` | String! | Account ID of the Jira user. | +| `jiraDisplayName` | String! | Display name of the Jira user. | +| `jiraEmail` | String | Email of the Jira user, returned only for users with public emails. | ### Label | Field | Type | Description | | ----- | ---- | ----------- | -| `color` | String! | Background color of the label | -| `description` | String | Description of the label (Markdown rendered as HTML for caching) | +| `color` | String! | Background color of the label. | +| `description` | String | Description of the label (Markdown rendered as HTML for caching). | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `id` | ID! | Label ID | -| `textColor` | String! | Text color of the label | -| `title` | String! | Content of the label | +| `id` | ID! | Label ID. | +| `textColor` | String! | Text color of the label. | +| `title` | String! | Content of the label. | ### LabelCreatePayload @@ -2111,88 +2292,89 @@ Autogenerated return type of MarkAsSpamSnippet. | Field | Type | Description | | ----- | ---- | ----------- | -| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork | -| `approvalsLeft` | Int | Number of approvals left | -| `approvalsRequired` | Int | Number of approvals required | +| `allowCollaboration` | Boolean | Indicates if members of the target project can push to the fork. | +| `approvalsLeft` | Int | Number of approvals left. | +| `approvalsRequired` | Int | Number of approvals required. | | `approved` | Boolean! | Indicates if the merge request has all the required approvals. Returns true if no required approvals are configured. | -| `approvedBy` | UserConnection | Users who approved the merge request | -| `assignees` | UserConnection | Assignees of the merge request | -| `author` | User | User who created this merge request | -| `autoMergeEnabled` | Boolean! | Indicates if auto merge is enabled for the merge request | -| `autoMergeStrategy` | String | Selected auto merge strategy | -| `availableAutoMergeStrategies` | String! => Array | Array of available auto merge strategies | -| `commitCount` | Int | Number of commits in the merge request | -| `commitsWithoutMergeCommits` | CommitConnection | Merge request commits excluding merge commits | -| `conflicts` | Boolean! | Indicates if the merge request has conflicts | -| `createdAt` | Time! | Timestamp of when the merge request was created | -| `currentUserTodos` | TodoConnection! | Todos for the current user | -| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request | -| `defaultMergeCommitMessageWithDescription` | String | Default merge commit message of the merge request with description | -| `defaultSquashCommitMessage` | String | Default squash commit message of the merge request | -| `description` | String | Description of the merge request (Markdown rendered as HTML for caching) | +| `approvedBy` | UserConnection | Users who approved the merge request. | +| `assignees` | UserConnection | Assignees of the merge request. | +| `author` | User | User who created this merge request. | +| `autoMergeEnabled` | Boolean! | Indicates if auto merge is enabled for the merge request. | +| `autoMergeStrategy` | String | Selected auto merge strategy. | +| `availableAutoMergeStrategies` | String! => Array | Array of available auto merge strategies. | +| `commitCount` | Int | Number of commits in the merge request. | +| `commitsWithoutMergeCommits` | CommitConnection | Merge request commits excluding merge commits. | +| `conflicts` | Boolean! | Indicates if the merge request has conflicts. | +| `createdAt` | Time! | Timestamp of when the merge request was created. | +| `currentUserTodos` | TodoConnection! | To-do items for the current user. | +| `defaultMergeCommitMessage` | String | Default merge commit message of the merge request. | +| `defaultMergeCommitMessageWithDescription` | String | Default merge commit message of the merge request with description. | +| `defaultSquashCommitMessage` | String | Default squash commit message of the merge request. | +| `description` | String | Description of the merge request (Markdown rendered as HTML for caching). | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `diffHeadSha` | String | Diff head SHA of the merge request | -| `diffRefs` | DiffRefs | References of the base SHA, the head SHA, and the start SHA for this merge request | -| `diffStats` | DiffStats! => Array | Details about which files were changed in this merge request | -| `diffStatsSummary` | DiffStatsSummary | Summary of which files were changed in this merge request | -| `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `downvotes` | Int! | Number of downvotes for the merge request | -| `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge | -| `hasCi` | Boolean! | Indicates if the merge request has CI | -| `headPipeline` | Pipeline | The pipeline running on the branch HEAD of the merge request | -| `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 | -| `labels` | LabelConnection | Labels of the merge request | -| `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 | -| `mergeStatus` | String | Status of the merge request | -| `mergeTrainsCount` | Int | | -| `mergeUser` | User | User who merged this merge request | -| `mergeWhenPipelineSucceeds` | Boolean | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS) | -| `mergeable` | Boolean! | Indicates if the merge request is mergeable | -| `mergeableDiscussionsState` | Boolean | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged | -| `mergedAt` | Time | Timestamp of when the merge request was merged, null if not merged | -| `milestone` | Milestone | The milestone of the merge request | -| `notes` | NoteConnection! | All notes on this noteable | +| `diffHeadSha` | String | Diff head SHA of the merge request. | +| `diffRefs` | DiffRefs | References of the base SHA, the head SHA, and the start SHA for this merge request. | +| `diffStats` | DiffStats! => Array | Details about which files were changed in this merge request. | +| `diffStatsSummary` | DiffStatsSummary | Summary of which files were changed in this merge request. | +| `discussionLocked` | Boolean! | Indicates if comments on the merge request are locked to members only. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `downvotes` | Int! | Number of downvotes for the merge request. | +| `forceRemoveSourceBranch` | Boolean | Indicates if the project settings will lead to source branch deletion after merge. | +| `hasCi` | Boolean! | Indicates if the merge request has CI. | +| `hasSecurityReports` | Boolean! | Indicates if the source branch has any security reports. | +| `headPipeline` | Pipeline | The pipeline running on the branch HEAD of the merge request. | +| `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. | +| `labels` | LabelConnection | Labels of the merge request. | +| `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. | +| `mergeStatus` | String | Status of the merge request. | +| `mergeTrainsCount` | Int | Number of merge requests in the merge train. | +| `mergeUser` | User | User who merged this merge request. | +| `mergeWhenPipelineSucceeds` | Boolean | Indicates if the merge has been set to be merged when its pipeline succeeds (MWPS). | +| `mergeable` | Boolean! | Indicates if the merge request is mergeable. | +| `mergeableDiscussionsState` | Boolean | Indicates if all discussions in the merge request have been resolved, allowing the merge request to be merged. | +| `mergedAt` | Time | Timestamp of when the merge request was merged, null if not merged. | +| `milestone` | Milestone | The milestone of the merge request. | +| `notes` | NoteConnection! | All notes on this noteable. | | `participants` | UserConnection | Participants in the merge request. This includes the author, assignees, reviewers, and users mentioned in notes. | | `pipelines` | PipelineConnection | Pipelines for the merge request. Note: for performance reasons, no more than the most recent 500 pipelines will be returned. | -| `project` | Project! | Alias for target_project | -| `projectId` | Int! | ID of the merge request project | -| `rebaseCommitSha` | String | Rebase commit SHA of the merge request | -| `rebaseInProgress` | Boolean! | Indicates if there is a rebase currently in progress for the merge request | -| `reference` | String! | Internal reference of the merge request. Returned in shortened format by default | +| `project` | Project! | Alias for target_project. | +| `projectId` | Int! | ID of the merge request project. | +| `rebaseCommitSha` | String | Rebase commit SHA of the merge request. | +| `rebaseInProgress` | Boolean! | Indicates if there is a rebase currently in progress for the merge request. | +| `reference` | String! | Internal reference of the merge request. Returned in shortened format by default. | | `reviewers` | UserConnection | Users from whom a review has been requested. | | `securityAutoFix` | Boolean | Indicates if the merge request is created by @GitLab-Security-Bot. | -| `shouldBeRebased` | Boolean! | Indicates if the merge request will be rebased | -| `shouldRemoveSourceBranch` | Boolean | Indicates if the source branch of the merge request will be deleted after merge | -| `sourceBranch` | String! | Source branch of the merge request | -| `sourceBranchExists` | Boolean! | Indicates if the source branch of the merge request exists | -| `sourceBranchProtected` | Boolean! | Indicates if the source branch is protected | -| `sourceProject` | Project | Source project of the merge request | -| `sourceProjectId` | Int | ID of the merge request source project | -| `squash` | Boolean! | Indicates if squash on merge is enabled | -| `squashOnMerge` | Boolean! | Indicates if squash on merge is enabled | -| `state` | MergeRequestState! | State of the merge request | -| `subscribed` | Boolean! | Indicates if the currently logged in user is subscribed to this merge request | -| `targetBranch` | String! | Target branch of the merge request | -| `targetBranchExists` | Boolean! | Indicates if the target branch of the merge request exists | -| `targetProject` | Project! | Target project of the merge request | -| `targetProjectId` | Int! | ID of the merge request target project | +| `shouldBeRebased` | Boolean! | Indicates if the merge request will be rebased. | +| `shouldRemoveSourceBranch` | Boolean | Indicates if the source branch of the merge request will be deleted after merge. | +| `sourceBranch` | String! | Source branch of the merge request. | +| `sourceBranchExists` | Boolean! | Indicates if the source branch of the merge request exists. | +| `sourceBranchProtected` | Boolean! | Indicates if the source branch is protected. | +| `sourceProject` | Project | Source project of the merge request. | +| `sourceProjectId` | Int | ID of the merge request source project. | +| `squash` | Boolean! | Indicates if squash on merge is enabled. | +| `squashOnMerge` | Boolean! | Indicates if squash on merge is enabled. | +| `state` | MergeRequestState! | State of the merge request. | +| `subscribed` | Boolean! | Indicates if the currently logged in user is subscribed to this merge request. | +| `targetBranch` | String! | Target branch of the merge request. | +| `targetBranchExists` | Boolean! | Indicates if the target branch of the merge request exists. | +| `targetProject` | Project! | Target project of the merge request. | +| `targetProjectId` | Int! | ID of the merge request target project. | | `taskCompletionStatus` | TaskCompletionStatus! | Completion status of tasks | -| `timeEstimate` | Int! | Time estimate of the merge request | -| `title` | String! | Title of the merge request | +| `timeEstimate` | Int! | Time estimate of the merge request. | +| `title` | String! | Title of the merge request. | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `totalTimeSpent` | Int! | Total time reported as spent on the merge request | -| `updatedAt` | Time! | Timestamp of when the merge request was last updated | -| `upvotes` | Int! | Number of upvotes for the merge request | -| `userDiscussionsCount` | Int | Number of user discussions in the merge request | -| `userNotesCount` | Int | User notes count of the merge request | +| `totalTimeSpent` | Int! | Total time reported as spent on the merge request. | +| `updatedAt` | Time! | Timestamp of when the merge request was last updated. | +| `upvotes` | Int! | Number of upvotes for the merge request. | +| `userDiscussionsCount` | Int | Number of user discussions in the merge request. | +| `userNotesCount` | Int | User notes count of the merge request. | | `userPermissions` | MergeRequestPermissions! | Permissions for the current user on the resource | -| `webUrl` | String | Web URL of the merge request | -| `workInProgress` | Boolean! | Indicates if the merge request is a work in progress (WIP) | +| `webUrl` | String | Web URL of the merge request. | +| `workInProgress` | Boolean! | Indicates if the merge request is a work in progress (WIP). | ### MergeRequestCreatePayload @@ -2214,7 +2396,7 @@ Represents the Geo sync and verification state of a Merge Request diff. | `id` | ID! | ID of the MergeRequestDiffRegistry | | `lastSyncFailure` | String | Error message during sync of the MergeRequestDiffRegistry | | `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the MergeRequestDiffRegistry | -| `mergeRequestDiffId` | ID! | ID of the Merge Request diff | +| `mergeRequestDiffId` | ID! | ID of the Merge Request diff. | | `retryAt` | Time | Timestamp after which the MergeRequestDiffRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the MergeRequestDiffRegistry | | `state` | RegistryState | Sync state of the MergeRequestDiffRegistry | @@ -2235,6 +2417,16 @@ Check permissions for the current user on a merge request. | `revertOnCurrentMergeRequest` | Boolean! | Indicates the user can perform `revert_on_current_merge_request` on this resource | | `updateMergeRequest` | Boolean! | Indicates the user can perform `update_merge_request` on this resource | +### MergeRequestReviewerRereviewPayload + +Autogenerated return type of MergeRequestReviewerRereview. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `mergeRequest` | MergeRequest | The merge request after mutation. | + ### MergeRequestSetAssigneesPayload Autogenerated return type of MergeRequestSetAssignees. @@ -2309,8 +2501,8 @@ Autogenerated return type of MergeRequestUpdate. | Field | Type | Description | | ----- | ---- | ----------- | -| `revision` | String! | Revision | -| `version` | String! | Version | +| `revision` | String! | Revision. | +| `version` | String! | Version. | ### MetricImage @@ -2318,29 +2510,29 @@ Represents a metric image upload. | Field | Type | Description | | ----- | ---- | ----------- | -| `fileName` | String | File name of the metric image | -| `filePath` | String | File path of the metric image | -| `id` | ID! | ID of the metric upload | -| `iid` | ID! | Internal ID of the metric upload | -| `url` | String! | URL of the metric source | +| `fileName` | String | File name of the metric image. | +| `filePath` | String | File path of the metric image. | +| `id` | ID! | ID of the metric upload. | +| `iid` | ID! | Internal ID of the metric upload. | +| `url` | String! | URL of the metric source. | ### MetricsDashboard | Field | Type | Description | | ----- | ---- | ----------- | -| `annotations` | MetricsDashboardAnnotationConnection | Annotations added to the dashboard | -| `path` | String | Path to a file with the dashboard definition | -| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings | +| `annotations` | MetricsDashboardAnnotationConnection | Annotations added to the dashboard. | +| `path` | String | Path to a file with the dashboard definition. | +| `schemaValidationWarnings` | String! => Array | Dashboard schema validation warnings. | ### MetricsDashboardAnnotation | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String | Description of the annotation | -| `endingAt` | Time | 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` | Time | Timestamp marking start of annotated time span | +| `description` | String | Description of the annotation. | +| `endingAt` | Time | 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` | Time | Timestamp marking start of annotated time span. | ### Milestone @@ -2348,20 +2540,20 @@ Represents a milestone. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp of milestone creation | -| `description` | String | Description of the milestone | -| `dueDate` | Time | Timestamp of the milestone due date | -| `groupMilestone` | Boolean! | Indicates if milestone is at group level | -| `id` | ID! | ID of the milestone | -| `projectMilestone` | Boolean! | Indicates if milestone is at project level | -| `report` | TimeboxReport | Historically accurate report about the timebox | -| `startDate` | Time | Timestamp of the milestone start date | -| `state` | MilestoneStateEnum! | State of the milestone | -| `stats` | MilestoneStats | Milestone statistics | -| `subgroupMilestone` | Boolean! | Indicates if milestone is at subgroup level | -| `title` | String! | Title of the milestone | -| `updatedAt` | Time! | Timestamp of last milestone update | -| `webPath` | String! | Web path of the milestone | +| `createdAt` | Time! | Timestamp of milestone creation. | +| `description` | String | Description of the milestone. | +| `dueDate` | Time | Timestamp of the milestone due date. | +| `groupMilestone` | Boolean! | Indicates if milestone is at group level. | +| `id` | ID! | ID of the milestone. | +| `projectMilestone` | Boolean! | Indicates if milestone is at project level. | +| `report` | TimeboxReport | Historically accurate report about the timebox. | +| `startDate` | Time | Timestamp of the milestone start date. | +| `state` | MilestoneStateEnum! | State of the milestone. | +| `stats` | MilestoneStats | Milestone statistics. | +| `subgroupMilestone` | Boolean! | Indicates if milestone is at subgroup level. | +| `title` | String! | Title of the milestone. | +| `updatedAt` | Time! | Timestamp of last milestone update. | +| `webPath` | String! | Web path of the milestone. | ### MilestoneStats @@ -2369,36 +2561,36 @@ Contains statistics about a milestone. | Field | Type | Description | | ----- | ---- | ----------- | -| `closedIssuesCount` | Int | Number of closed issues associated with the milestone | -| `totalIssuesCount` | Int | Total number of issues associated with the milestone | +| `closedIssuesCount` | Int | Number of closed issues associated with the milestone. | +| `totalIssuesCount` | Int | Total number of issues associated with the milestone. | ### Namespace | Field | Type | Description | | ----- | ---- | ----------- | -| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes | -| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes | +| `actualRepositorySizeLimit` | Float | Size limit for repositories in the namespace in bytes. | +| `additionalPurchasedStorageSize` | Float | Additional storage purchased for the root namespace in bytes. | | `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks available to projects in this namespace. Available only when feature flag `ff_custom_compliance_frameworks` is enabled. | -| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit | -| `description` | String | Description of the namespace | +| `containsLockedProjects` | Boolean! | Includes at least one project where the repository size exceeds the limit. | +| `description` | String | Description of the namespace. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `fullName` | String! | Full name of the namespace | -| `fullPath` | ID! | Full path of the namespace | -| `id` | ID! | ID of the namespace | -| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase | -| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace | -| `name` | String! | Name of the namespace | -| `packageSettings` | PackageSettings | The package settings for the namespace | -| `path` | String! | Path of the namespace | -| `projects` | ProjectConnection! | Projects within this namespace | -| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit | -| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace | -| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces | -| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes | -| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active | -| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes | -| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes | -| `visibility` | String | Visibility of the namespace | +| `fullName` | String! | Full name of the namespace. | +| `fullPath` | ID! | Full path of the namespace. | +| `id` | ID! | ID of the namespace. | +| `isTemporaryStorageIncreaseEnabled` | Boolean! | Status of the temporary storage increase. | +| `lfsEnabled` | Boolean | Indicates if Large File Storage (LFS) is enabled for namespace. | +| `name` | String! | Name of the namespace. | +| `packageSettings` | PackageSettings | The package settings for the namespace. | +| `path` | String! | Path of the namespace. | +| `projects` | ProjectConnection! | Projects within this namespace. | +| `repositorySizeExcessProjectCount` | Int! | Number of projects in the root namespace where the repository size exceeds the limit. | +| `requestAccessEnabled` | Boolean | Indicates if users can request access to namespace. | +| `rootStorageStatistics` | RootStorageStatistics | Aggregated storage statistics of the namespace. Only available for root namespaces. | +| `storageSizeLimit` | Float | Total storage limit of the root namespace in bytes. | +| `temporaryStorageIncreaseEndsOn` | Time | Date until the temporary storage increase is active. | +| `totalRepositorySize` | Float | Total repository size of all projects in the root namespace in bytes. | +| `totalRepositorySizeExcess` | Float | Total excess repository size of all projects in the root namespace in bytes. | +| `visibility` | String | Visibility of the namespace. | ### NamespaceIncreaseStorageTemporarilyPayload @@ -2414,23 +2606,23 @@ Autogenerated return type of NamespaceIncreaseStorageTemporarily. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User! | User who wrote this note | -| `body` | String! | Content of the note | +| `author` | User! | User who wrote this note. | +| `body` | String! | Content of the note. | | `bodyHtml` | String | The GitLab Flavored Markdown rendering of `note` | -| `confidential` | Boolean | Indicates if this note is confidential | -| `createdAt` | Time! | Timestamp of the note creation | -| `discussion` | Discussion | The discussion this note is a part of | -| `id` | ID! | ID of the note | -| `position` | DiffPosition | The position of this note on a diff | -| `project` | Project | Project associated with the note | -| `resolvable` | Boolean! | Indicates if the object can be resolved | -| `resolved` | Boolean! | Indicates if the object is resolved | -| `resolvedAt` | Time | Timestamp of when the object was resolved | -| `resolvedBy` | User | User who resolved the object | -| `system` | Boolean! | Indicates whether this note was created by the system or by a user | -| `systemNoteIconName` | String | Name of the icon corresponding to a system note | -| `updatedAt` | Time! | Timestamp of the note's last activity | -| `url` | String | URL to view this Note in the Web UI | +| `confidential` | Boolean | Indicates if this note is confidential. | +| `createdAt` | Time! | Timestamp of the note creation. | +| `discussion` | Discussion | The discussion this note is a part of. | +| `id` | NoteID! | ID of the note. | +| `position` | DiffPosition | The position of this note on a diff. | +| `project` | Project | Project associated with the note. | +| `resolvable` | Boolean! | Indicates if the object can be resolved. | +| `resolved` | Boolean! | Indicates if the object is resolved. | +| `resolvedAt` | Time | Timestamp of when the object was resolved. | +| `resolvedBy` | User | User who resolved the object. | +| `system` | Boolean! | Indicates whether this note was created by the system or by a user. | +| `systemNoteIconName` | String | Name of the icon corresponding to a system note. | +| `updatedAt` | Time! | Timestamp of the note's last activity. | +| `url` | String | URL to view this Note in the Web UI. | | `userPermissions` | NotePermissions! | Permissions for the current user on the resource | ### NotePermissions @@ -2465,6 +2657,16 @@ Autogenerated return type of OncallRotationCreate. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. | +### OncallRotationDestroyPayload + +Autogenerated return type of OncallRotationDestroy. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `clientMutationId` | String | A unique identifier for the client performing the mutation. | +| `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `oncallRotation` | IncidentManagementOncallRotation | The on-call rotation. | + ### OncallScheduleCreatePayload Autogenerated return type of OncallScheduleCreate. @@ -2501,34 +2703,17 @@ Represents a package in the Package Registry. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | The created date. | -| `id` | ID! | The ID of the package. | -| `name` | String! | The name of the package. | -| `packageType` | PackageTypeEnum! | The type of the package. | +| `createdAt` | Time! | Date of creation. | +| `id` | PackagesPackageID! | ID of the package. | +| `metadata` | PackageMetadata | Package metadata. | +| `name` | String! | Name of the package. | +| `packageType` | PackageTypeEnum! | Package type. | | `pipelines` | PipelineConnection | Pipelines that built the package. | | `project` | Project! | Project where the package is stored. | -| `tags` | PackageTagConnection | The package tags. | -| `updatedAt` | Time! | The updated date. | -| `version` | String | The version of the package. | -| `versions` | PackageConnection | The other versions of the package. | - -### PackageComposerDetails - -Details of a Composer package. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `composerMetadatum` | PackageComposerMetadatumType! | The Composer metadatum. | -| `createdAt` | Time! | The created date. | -| `id` | ID! | The ID of the package. | -| `name` | String! | The name of the package. | -| `packageType` | PackageTypeEnum! | The type of the package. | -| `pipelines` | PipelineConnection | Pipelines that built the package. | -| `project` | Project! | Project where the package is stored. | -| `tags` | PackageTagConnection | The package tags. | -| `updatedAt` | Time! | The updated date. | -| `version` | String | The version of the package. | -| `versions` | PackageConnection | The other versions of the package. | +| `tags` | PackageTagConnection | Package tags. | +| `updatedAt` | Time! | Date of most recent update. | +| `version` | String | Version string. | +| `versions` | PackageWithoutVersionsConnection | The other versions of the package. | ### PackageComposerJsonType @@ -2541,15 +2726,6 @@ Represents a composer JSON file. | `type` | String | The type set in the Composer JSON file. | | `version` | String | The version set in the Composer JSON file. | -### PackageComposerMetadatumType - -Composer metadatum. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `composerJson` | PackageComposerJsonType! | Data of the Composer JSON file. | -| `targetSha` | String! | Target SHA of the package. | - ### PackageFileRegistry Represents the Geo sync and verification state of a package file. @@ -2560,7 +2736,7 @@ Represents the Geo sync and verification state of a package file. | `id` | ID! | ID of the PackageFileRegistry | | `lastSyncFailure` | String | Error message during sync of the PackageFileRegistry | | `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the PackageFileRegistry | -| `packageFileId` | ID! | ID of the PackageFile | +| `packageFileId` | ID! | ID of the PackageFile. | | `retryAt` | Time | Timestamp after which the PackageFileRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the PackageFileRegistry | | `state` | RegistryState | Sync state of the PackageFileRegistry | @@ -2585,6 +2761,23 @@ Represents a package tag. | `name` | String! | The name of the tag. | | `updatedAt` | Time! | The updated date. | +### PackageWithoutVersions + +Represents a version of a package in the Package Registry. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `createdAt` | Time! | Date of creation. | +| `id` | PackagesPackageID! | ID of the package. | +| `metadata` | PackageMetadata | Package metadata. | +| `name` | String! | Name of the package. | +| `packageType` | PackageTypeEnum! | Package type. | +| `pipelines` | PipelineConnection | Pipelines that built the package. | +| `project` | Project! | Project where the package is stored. | +| `tags` | PackageTagConnection | Package tags. | +| `updatedAt` | Time! | Date of most recent update. | +| `version` | String | Version string. | + ### PageInfo Information about pagination in a connection.. @@ -2600,49 +2793,50 @@ Information about pagination in a connection.. | Field | Type | Description | | ----- | ---- | ----------- | -| `active` | Boolean! | Indicates if the pipeline is active | -| `beforeSha` | String | Base SHA of the source branch | -| `cancelable` | Boolean! | Specifies if a pipeline can be canceled | -| `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) | -| `coverage` | Float | Coverage percentage | -| `createdAt` | Time! | Timestamp of the pipeline's creation | -| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline | -| `downstream` | PipelineConnection | Pipelines this pipeline will trigger | -| `duration` | Int | Duration of the pipeline in seconds | -| `finishedAt` | Time | Timestamp of the pipeline's completion | -| `id` | ID! | ID of the pipeline | -| `iid` | String! | Internal ID of the pipeline | -| `jobs` | CiJobConnection | Jobs belonging to the pipeline | -| `path` | String | Relative path to the pipeline's page | -| `project` | Project | Project the pipeline belongs to | -| `retryable` | Boolean! | Specifies if a pipeline can be retried | -| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline | -| `sha` | String! | SHA of the pipeline's commit | -| `sourceJob` | CiJob | Job where pipeline was triggered from | -| `stages` | CiStageConnection | Stages of the pipeline | -| `startedAt` | Time | Timestamp when the pipeline was started | +| `active` | Boolean! | Indicates if the pipeline is active. | +| `beforeSha` | String | Base SHA of the source branch. | +| `cancelable` | Boolean! | Specifies if a pipeline can be canceled. | +| `committedAt` | Time | Timestamp of the pipeline's commit. | +| `configSource` | PipelineConfigSourceEnum | Configuration source of the pipeline (UNKNOWN_SOURCE, REPOSITORY_SOURCE, AUTO_DEVOPS_SOURCE, WEBIDE_SOURCE, REMOTE_SOURCE, EXTERNAL_PROJECT_SOURCE, BRIDGE_SOURCE, PARAMETER_SOURCE, COMPLIANCE_SOURCE) | +| `coverage` | Float | Coverage percentage. | +| `createdAt` | Time! | Timestamp of the pipeline's creation. | +| `detailedStatus` | DetailedStatus! | Detailed status of the pipeline. | +| `downstream` | PipelineConnection | Pipelines this pipeline will trigger. | +| `duration` | Int | Duration of the pipeline in seconds. | +| `finishedAt` | Time | Timestamp of the pipeline's completion. | +| `id` | ID! | ID of the pipeline. | +| `iid` | String! | Internal ID of the pipeline. | +| `jobs` | CiJobConnection | Jobs belonging to the pipeline. | +| `path` | String | Relative path to the pipeline's page. | +| `project` | Project | Project the pipeline belongs to. | +| `retryable` | Boolean! | Specifies if a pipeline can be retried. | +| `securityReportSummary` | SecurityReportSummary | Vulnerability and scanned resource counts for each security scanner of the pipeline. | +| `sha` | String! | SHA of the pipeline's commit. | +| `sourceJob` | CiJob | Job where pipeline was triggered from. | +| `stages` | CiStageConnection | Stages of the pipeline. | +| `startedAt` | Time | Timestamp when the pipeline was started. | | `status` | PipelineStatusEnum! | Status of the pipeline (CREATED, WAITING_FOR_RESOURCE, PREPARING, PENDING, RUNNING, FAILED, SUCCESS, CANCELED, SKIPPED, MANUAL, SCHEDULED) | -| `updatedAt` | Time! | Timestamp of the pipeline's last activity | -| `upstream` | Pipeline | Pipeline that triggered the pipeline | -| `user` | User | Pipeline user | +| `updatedAt` | Time! | Timestamp of the pipeline's last activity. | +| `upstream` | Pipeline | Pipeline that triggered the pipeline. | +| `user` | User | Pipeline user. | | `userPermissions` | PipelinePermissions! | Permissions for the current user on the resource | +| `warnings` | Boolean! | Indicates if a pipeline has warnings. | ### PipelineAnalytics | Field | Type | Description | | ----- | ---- | ----------- | -| `monthPipelinesLabels` | String! => Array | Labels for the monthly pipeline count | -| `monthPipelinesSuccessful` | Int! => Array | Total monthly successful pipeline count | -| `monthPipelinesTotals` | Int! => Array | Total monthly pipeline count | -| `pipelineTimesLabels` | String! => Array | Pipeline times labels | -| `pipelineTimesValues` | Int! => Array | Pipeline times | -| `weekPipelinesLabels` | String! => Array | Labels for the weekly pipeline count | -| `weekPipelinesSuccessful` | Int! => Array | Total weekly successful pipeline count | -| `weekPipelinesTotals` | Int! => Array | Total weekly pipeline count | -| `yearPipelinesLabels` | String! => Array | Labels for the yearly pipeline count | -| `yearPipelinesSuccessful` | Int! => Array | Total yearly successful pipeline count | -| `yearPipelinesTotals` | Int! => Array | Total yearly pipeline count | +| `monthPipelinesLabels` | String! => Array | Labels for the monthly pipeline count. | +| `monthPipelinesSuccessful` | Int! => Array | Total monthly successful pipeline count. | +| `monthPipelinesTotals` | Int! => Array | Total monthly pipeline count. | +| `pipelineTimesLabels` | String! => Array | Pipeline times labels. | +| `pipelineTimesValues` | Int! => Array | Pipeline times. | +| `weekPipelinesLabels` | String! => Array | Labels for the weekly pipeline count. | +| `weekPipelinesSuccessful` | Int! => Array | Total weekly successful pipeline count. | +| `weekPipelinesTotals` | Int! => Array | Total weekly pipeline count. | +| `yearPipelinesLabels` | String! => Array | Labels for the yearly pipeline count. | +| `yearPipelinesSuccessful` | Int! => Array | Total yearly successful pipeline count. | +| `yearPipelinesTotals` | Int! => Array | Total yearly pipeline count. | ### PipelineCancelPayload @@ -2684,108 +2878,112 @@ Autogenerated return type of PipelineRetry. | Field | Type | Description | | ----- | ---- | ----------- | -| `actualRepositorySizeLimit` | Float | Size limit for the repository in bytes | -| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project | -| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project | -| `alertManagementAlerts` | AlertManagementAlertConnection | Alert Management alerts of the project | -| `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project | -| `allowMergeOnSkippedPipeline` | Boolean | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs | -| `archived` | Boolean | Indicates the archived status of the project | -| `autocloseReferencedIssues` | Boolean | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically | -| `avatarUrl` | String | URL to avatar image file of the project | -| `board` | Board | A single board of the project | -| `boards` | BoardConnection | Boards of the project | -| `ciCdSettings` | ProjectCiCdSetting | CI/CD settings for the project | -| `clusterAgent` | ClusterAgent | Find a single cluster agent by name | -| `clusterAgents` | ClusterAgentConnection | Cluster agents associated with the project | -| `codeCoverageSummary` | CodeCoverageSummary | Code coverage summary associated with the project | -| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks associated with the project | -| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy of the project | -| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry | -| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the project | -| `containerRepositoriesCount` | Int! | Number of container repositories in the project | -| `createdAt` | Time | Timestamp of the project creation | -| `dastScannerProfiles` | DastScannerProfileConnection | The DAST scanner profiles associated with the project | -| `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project | -| `dastSiteProfiles` | DastSiteProfileConnection | DAST Site Profiles associated with the project | -| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations associated with the project. Will always return no nodes if `security_on_demand_scans_site_validation` is disabled | -| `description` | String | Short description of the project | +| `actualRepositorySizeLimit` | Float | Size limit for the repository in bytes. | +| `alertManagementAlert` | AlertManagementAlert | A single Alert Management alert of the project. | +| `alertManagementAlertStatusCounts` | AlertManagementAlertStatusCountsType | Counts of alerts by status for the project. | +| `alertManagementAlerts` | AlertManagementAlertConnection | Alert Management alerts of the project. | +| `alertManagementIntegrations` | AlertManagementIntegrationConnection | Integrations which can receive alerts for the project. | +| `alertManagementPayloadFields` | AlertManagementPayloadAlertField! => Array | Extract alert fields from payload for custom mapping. | +| `allowMergeOnSkippedPipeline` | Boolean | If `only_allow_merge_if_pipeline_succeeds` is true, indicates if merge requests of the project can also be merged with skipped jobs. | +| `apiFuzzingCiConfiguration` | ApiFuzzingCiConfiguration | API fuzzing configuration for the project. Available only when feature flag `api_fuzzing_configuration_ui` is enabled. | +| `archived` | Boolean | Indicates the archived status of the project. | +| `autocloseReferencedIssues` | Boolean | Indicates if issues referenced by merge requests and commits within the default branch are closed automatically. | +| `avatarUrl` | String | URL to avatar image file of the project. | +| `board` | Board | A single board of the project. | +| `boards` | BoardConnection | Boards of the project. | +| `ciCdSettings` | ProjectCiCdSetting | CI/CD settings for the project. | +| `clusterAgent` | ClusterAgent | Find a single cluster agent by name. | +| `clusterAgents` | ClusterAgentConnection | Cluster agents associated with the project. | +| `codeCoverageSummary` | CodeCoverageSummary | Code coverage summary associated with the project. | +| `complianceFrameworks` | ComplianceFrameworkConnection | Compliance frameworks associated with the project. | +| `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy of the project. | +| `containerRegistryEnabled` | Boolean | Indicates if the project stores Docker container images in a container registry. | +| `containerRepositories` | ContainerRepositoryConnection | Container repositories of the project. | +| `containerRepositoriesCount` | Int! | Number of container repositories in the project. | +| `createdAt` | Time | Timestamp of the project creation. | +| `dastProfiles` | DastProfileConnection | DAST Profiles associated with the project. Always returns no nodes if `dast_saved_scans` is disabled. | +| `dastScannerProfiles` | DastScannerProfileConnection | The DAST scanner profiles associated with the project. | +| `dastSiteProfile` | DastSiteProfile | DAST Site Profile associated with the project. | +| `dastSiteProfiles` | DastSiteProfileConnection | DAST Site Profiles associated with the project. | +| `dastSiteValidations` | DastSiteValidationConnection | DAST Site Validations associated with the project. Always returns no nodes if `security_on_demand_scans_site_validation` is disabled. | +| `description` | String | Short description of the project. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `environment` | Environment | A single environment of the project | -| `environments` | EnvironmentConnection | Environments of the project | -| `forksCount` | Int! | Number of times the project has been forked | -| `fullPath` | ID! | Full path of the project | -| `grafanaIntegration` | GrafanaIntegration | Grafana integration details for the project | -| `group` | Group | Group of the project | -| `httpUrlToRepo` | String | URL to connect to the project via HTTPS | -| `id` | ID! | ID of the project | -| `importStatus` | String | Status of import background job of the project | -| `incidentManagementOncallSchedules` | IncidentManagementOncallScheduleConnection | Incident Management On-call schedules of the project | -| `issue` | Issue | A single issue of the project | -| `issueStatusCounts` | IssueStatusCountsType | Counts of issues by status for the project | -| `issues` | IssueConnection | Issues of the project | +| `environment` | Environment | A single environment of the project. | +| `environments` | EnvironmentConnection | Environments of the project. | +| `forksCount` | Int! | Number of times the project has been forked. | +| `fullPath` | ID! | Full path of the project. | +| `grafanaIntegration` | GrafanaIntegration | Grafana integration details for the project. | +| `group` | Group | Group of the project. | +| `httpUrlToRepo` | String | URL to connect to the project via HTTPS. | +| `id` | ID! | ID of the project. | +| `importStatus` | String | Status of import background job of the project. | +| `incidentManagementOncallSchedules` | IncidentManagementOncallScheduleConnection | Incident Management On-call schedules of the project. | +| `issue` | Issue | A single issue of the project. | +| `issueStatusCounts` | IssueStatusCountsType | Counts of issues by status for the project. | +| `issues` | IssueConnection | Issues of the project. | | `issuesEnabled` | Boolean | Indicates if Issues are enabled for the current user | -| `iterations` | IterationConnection | Find iterations | -| `jiraImportStatus` | String | Status of Jira import background job of the project | -| `jiraImports` | JiraImportConnection | Jira imports into the project | -| `jobsEnabled` | Boolean | Indicates if CI/CD pipeline jobs are enabled for the current user | -| `label` | Label | A label available on this project | -| `labels` | LabelConnection | Labels available on this project | -| `lastActivityAt` | Time | Timestamp of the project last activity | -| `lfsEnabled` | Boolean | Indicates if the project has Large File Storage (LFS) enabled | -| `mergeRequest` | MergeRequest | A single merge request of the project | -| `mergeRequests` | MergeRequestConnection | Merge requests of the project | +| `iterations` | IterationConnection | Find iterations. | +| `jiraImportStatus` | String | Status of Jira import background job of the project. | +| `jiraImports` | JiraImportConnection | Jira imports into the project. | +| `jobsEnabled` | Boolean | Indicates if CI/CD pipeline jobs are enabled for the current user. | +| `label` | Label | A label available on this project. | +| `labels` | LabelConnection | Labels available on this project. | +| `lastActivityAt` | Time | Timestamp of the project last activity. | +| `lfsEnabled` | Boolean | Indicates if the project has Large File Storage (LFS) enabled. | +| `mergeRequest` | MergeRequest | A single merge request of the project. | +| `mergeRequests` | MergeRequestConnection | Merge requests of the project. | | `mergeRequestsEnabled` | Boolean | Indicates if Merge Requests are enabled for the current user | | `mergeRequestsFfOnlyEnabled` | Boolean | Indicates if no merge commits should be created and all merges should instead be fast-forwarded, which means that merging is only allowed if the branch could be fast-forwarded. | -| `milestones` | MilestoneConnection | Milestones of the project | -| `name` | String! | Name of the project (without namespace) | -| `nameWithNamespace` | String! | Full name of the project with its namespace | -| `namespace` | Namespace | Namespace of the project | -| `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved | -| `onlyAllowMergeIfPipelineSucceeds` | Boolean | Indicates if merge requests of the project can only be merged with successful jobs | -| `openIssuesCount` | Int | Number of open issues for the project | -| `packages` | PackageConnection | Packages of the project | -| `path` | String! | Path of the project | -| `pipeline` | Pipeline | Build pipeline of the project | -| `pipelineAnalytics` | PipelineAnalytics | Pipeline analytics | -| `pipelines` | PipelineConnection | Build pipelines of the project | -| `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line | -| `projectMembers` | MemberInterfaceConnection | Members of the project | -| `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts | -| `release` | Release | A single release of the project | -| `releases` | ReleaseConnection | Releases of the project | -| `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project | -| `repository` | Repository | Git repository of the project | -| `repositorySizeExcess` | Float | Size of repository that exceeds the limit in bytes | -| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project | -| `requirement` | Requirement | Find a single requirement | -| `requirementStatesCount` | RequirementStatesCount | Number of requirements for the project by their state | -| `requirements` | RequirementConnection | Find requirements | -| `sastCiConfiguration` | SastCiConfiguration | SAST CI configuration for the project | -| `securityDashboardPath` | String | Path to project's security dashboard | -| `securityScanners` | SecurityScanners | Information about security analyzers used in the project | -| `sentryDetailedError` | SentryDetailedError | Detailed version of a Sentry error on the project | -| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project | +| `milestones` | MilestoneConnection | Milestones of the project. | +| `name` | String! | Name of the project (without namespace). | +| `nameWithNamespace` | String! | Full name of the project with its namespace. | +| `namespace` | Namespace | Namespace of the project. | +| `onlyAllowMergeIfAllDiscussionsAreResolved` | Boolean | Indicates if merge requests of the project can only be merged when all the discussions are resolved. | +| `onlyAllowMergeIfPipelineSucceeds` | Boolean | Indicates if merge requests of the project can only be merged with successful jobs. | +| `openIssuesCount` | Int | Number of open issues for the project. | +| `packages` | PackageConnection | Packages of the project. | +| `path` | String! | Path of the project. | +| `pipeline` | Pipeline | Build pipeline of the project. | +| `pipelineAnalytics` | PipelineAnalytics | Pipeline analytics. | +| `pipelines` | PipelineConnection | Build pipelines of the project. | +| `printingMergeRequestLinkEnabled` | Boolean | Indicates if a link to create or view a merge request should display after a push to Git repositories of the project from the command line. | +| `projectMembers` | MemberInterfaceConnection | Members of the project. | +| `publicJobs` | Boolean | Indicates if there is public access to pipelines and job details of the project, including output logs and artifacts. | +| `release` | Release | A single release of the project. | +| `releases` | ReleaseConnection | Releases of the project. | +| `removeSourceBranchAfterMerge` | Boolean | Indicates if `Delete source branch` option should be enabled by default for all new merge requests of the project. | +| `repository` | Repository | Git repository of the project. | +| `repositorySizeExcess` | Float | Size of repository that exceeds the limit in bytes. | +| `requestAccessEnabled` | Boolean | Indicates if users can request member access to the project. | +| `requirement` | Requirement | Find a single requirement. | +| `requirementStatesCount` | RequirementStatesCount | Number of requirements for the project by their state. | +| `requirements` | RequirementConnection | Find requirements. | +| `sastCiConfiguration` | SastCiConfiguration | SAST CI configuration for the project. | +| `securityDashboardPath` | String | Path to project's security dashboard. | +| `securityScanners` | SecurityScanners | Information about security analyzers used in the project. | +| `sentryDetailedError` | SentryDetailedError | Detailed version of a Sentry error on the project. | +| `sentryErrors` | SentryErrorCollection | Paginated collection of Sentry errors on the project. | | `serviceDeskAddress` | String | E-mail address of the service desk. | | `serviceDeskEnabled` | Boolean | Indicates if the project has service desk enabled. | -| `services` | ServiceConnection | Project services | -| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project | -| `snippets` | SnippetConnection | Snippets of the project | +| `services` | ServiceConnection | Project services. | +| `sharedRunnersEnabled` | Boolean | Indicates if shared runners are enabled for the project. | +| `snippets` | SnippetConnection | Snippets of the project. | | `snippetsEnabled` | Boolean | Indicates if Snippets are enabled for the current user | -| `squashReadOnly` | Boolean! | Indicates if squash readonly is enabled | -| `sshUrlToRepo` | String | URL to connect to the project via SSH | -| `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 topics (not Git tags) | -| `terraformStates` | TerraformStateConnection | Terraform states associated with the project | +| `squashReadOnly` | Boolean! | Indicates if `squashReadOnly` is enabled. | +| `sshUrlToRepo` | String | URL to connect to the project via SSH. | +| `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 topics (not Git tags). | +| `terraformState` | TerraformState | Find a single Terraform state by name. | +| `terraformStates` | TerraformStateConnection | Terraform states associated with the project. | | `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource | -| `visibility` | String | Visibility of the project | -| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the project | -| `vulnerabilitiesCountByDay` | VulnerabilitiesCountByDayConnection | Number of vulnerabilities per day for the project | -| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilties | -| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the project | -| `webUrl` | String | Web URL of the project | +| `visibility` | String | Visibility of the project. | +| `vulnerabilities` | VulnerabilityConnection | Vulnerabilities reported on the project. | +| `vulnerabilitiesCountByDay` | VulnerabilitiesCountByDayConnection | Number of vulnerabilities per day for the project. | +| `vulnerabilityScanners` | VulnerabilityScannerConnection | Vulnerability scanners reported on the project vulnerabilities. | +| `vulnerabilitySeveritiesCount` | VulnerabilitySeveritiesCount | Counts for each vulnerability severity in the project. | +| `webUrl` | String | Web URL of the project. | | `wikiEnabled` | Boolean | Indicates if Wikis are enabled for the current user | ### ProjectCiCdSetting @@ -2803,14 +3001,14 @@ Represents a Project Membership. | Field | Type | Description | | ----- | ---- | ----------- | -| `accessLevel` | AccessLevel | GitLab::Access level | -| `createdAt` | Time | Date and time the membership was created | -| `createdBy` | User | User that authorized membership | -| `expiresAt` | Time | Date and time the membership expires | -| `id` | ID! | ID of the member | -| `project` | Project | Project that User is a member of | -| `updatedAt` | Time | Date and time the membership was last updated | -| `user` | User! | User that is associated with the member object | +| `accessLevel` | AccessLevel | GitLab::Access level. | +| `createdAt` | Time | Date and time the membership was created. | +| `createdBy` | User | User that authorized membership. | +| `expiresAt` | Time | Date and time the membership expires. | +| `id` | ID! | ID of the member. | +| `project` | Project | Project that User is a member of. | +| `updatedAt` | Time | Date and time the membership was last updated. | +| `user` | User! | User that is associated with the member object. | | `userPermissions` | ProjectPermissions! | Permissions for the current user on the resource | ### ProjectPermissions @@ -2864,15 +3062,15 @@ Represents a Project Membership. | Field | Type | Description | | ----- | ---- | ----------- | -| `buildArtifactsSize` | Float! | Build artifacts size of the project in bytes | -| `commitCount` | Float! | Commit count of the project | -| `lfsObjectsSize` | Float! | Large File Storage (LFS) object size of the project in bytes | -| `packagesSize` | Float! | Packages size of the project in bytes | -| `repositorySize` | Float! | Repository size of the project in bytes | -| `snippetsSize` | Float | Snippets size of the project in bytes | -| `storageSize` | Float! | Storage size of the project in bytes | -| `uploadsSize` | Float | Uploads size of the project in bytes | -| `wikiSize` | Float | Wiki size of the project in bytes | +| `buildArtifactsSize` | Float! | Build artifacts size of the project in bytes. | +| `commitCount` | Float! | Commit count of the project. | +| `lfsObjectsSize` | Float! | Large File Storage (LFS) object size of the project in bytes. | +| `packagesSize` | Float! | Packages size of the project in bytes. | +| `repositorySize` | Float! | Repository size of the project in bytes. | +| `snippetsSize` | Float | Snippets size of the project in bytes. | +| `storageSize` | Float! | Storage size of the project in bytes. | +| `uploadsSize` | Float | Uploads size of the project in bytes. | +| `wikiSize` | Float | Wiki size of the project in bytes. | ### PrometheusAlert @@ -2880,8 +3078,8 @@ The alert condition for Prometheus. | Field | Type | Description | | ----- | ---- | ----------- | -| `humanizedText` | String! | The human-readable text of the alert condition | -| `id` | ID! | ID of the alert condition | +| `humanizedText` | String! | The human-readable text of the alert condition. | +| `id` | ID! | ID of the alert condition. | ### PrometheusIntegrationCreatePayload @@ -2930,20 +3128,20 @@ Represents a release. | Field | Type | Description | | ----- | ---- | ----------- | -| `assets` | ReleaseAssets | Assets of the release | -| `author` | User | User that created the release | -| `commit` | Commit | The commit associated with the release | -| `createdAt` | Time | Timestamp of when the release was created | -| `description` | String | Description (also known as "release notes") of the release | +| `assets` | ReleaseAssets | Assets of the release. | +| `author` | User | User that created the release. | +| `commit` | Commit | The commit associated with the release. | +| `createdAt` | Time | Timestamp of when the release was created. | +| `description` | String | Description (also known as "release notes") of the release. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `evidences` | ReleaseEvidenceConnection | Evidence for the release | -| `links` | ReleaseLinks | Links of the release | -| `milestones` | MilestoneConnection | Milestones associated to the release | -| `name` | String | Name of the release | -| `releasedAt` | Time | Timestamp of when the release was released | -| `tagName` | String | Name of the tag associated with the release | -| `tagPath` | String | Relative web path to the tag associated with the release | -| `upcomingRelease` | Boolean | Indicates the release is an upcoming release | +| `evidences` | ReleaseEvidenceConnection | Evidence for the release. | +| `links` | ReleaseLinks | Links of the release. | +| `milestones` | MilestoneConnection | Milestones associated to the release. | +| `name` | String | Name of the release. | +| `releasedAt` | Time | Timestamp of when the release was released. | +| `tagName` | String | Name of the tag associated with the release. | +| `tagPath` | String | Relative web path to the tag associated with the release. | +| `upcomingRelease` | Boolean | Indicates the release is an upcoming release. | ### ReleaseAssetLink @@ -2951,12 +3149,12 @@ Represents an asset link associated with a release. | Field | Type | Description | | ----- | ---- | ----------- | -| `directAssetUrl` | String | Direct asset URL of the link | -| `external` | Boolean | Indicates the link points to an external resource | -| `id` | ID! | ID of the link | -| `linkType` | ReleaseAssetLinkType | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other` | -| `name` | String | Name of the link | -| `url` | String | URL of the link | +| `directAssetUrl` | String | Direct asset URL of the link. | +| `external` | Boolean | Indicates the link points to an external resource. | +| `id` | ID! | ID of the link. | +| `linkType` | ReleaseAssetLinkType | Type of the link: `other`, `runbook`, `image`, `package`; defaults to `other`. | +| `name` | String | Name of the link. | +| `url` | String | URL of the link. | ### ReleaseAssets @@ -2964,9 +3162,9 @@ A container for all assets associated with a release. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int | Number of assets of the release | -| `links` | ReleaseAssetLinkConnection | Asset links of the release | -| `sources` | ReleaseSourceConnection | Sources of the release | +| `count` | Int | Number of assets of the release. | +| `links` | ReleaseAssetLinkConnection | Asset links of the release. | +| `sources` | ReleaseSourceConnection | Sources of the release. | ### ReleaseCreatePayload @@ -2994,22 +3192,22 @@ Evidence for a release. | Field | Type | Description | | ----- | ---- | ----------- | -| `collectedAt` | Time | Timestamp when the evidence was collected | -| `filepath` | String | URL from where the evidence can be downloaded | -| `id` | ID! | ID of the evidence | -| `sha` | String | SHA1 ID of the evidence hash | +| `collectedAt` | Time | Timestamp when the evidence was collected. | +| `filepath` | String | URL from where the evidence can be downloaded. | +| `id` | ID! | ID of the evidence. | +| `sha` | String | SHA1 ID of the evidence hash. | ### ReleaseLinks | Field | Type | Description | | ----- | ---- | ----------- | -| `closedIssuesUrl` | String | HTTP URL of the issues page, filtered by this release and `state=closed` | -| `closedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=closed` | -| `editUrl` | String | HTTP URL of the release's edit page | -| `mergedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=merged` | -| `openedIssuesUrl` | String | HTTP URL of the issues page, filtered by this release and `state=open` | -| `openedMergeRequestsUrl` | String | HTTP URL of the merge request page, filtered by this release and `state=open` | -| `selfUrl` | String | HTTP URL of the release | +| `closedIssuesUrl` | String | HTTP URL of the issues page, filtered by this release and `state=closed`. | +| `closedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=closed`. | +| `editUrl` | String | HTTP URL of the release's edit page. | +| `mergedMergeRequestsUrl` | String | HTTP URL of the merge request page , filtered by this release and `state=merged`. | +| `openedIssuesUrl` | String | HTTP URL of the issues page, filtered by this release and `state=open`. | +| `openedMergeRequestsUrl` | String | HTTP URL of the merge request page, filtered by this release and `state=open`. | +| `selfUrl` | String | HTTP URL of the release. | ### ReleaseSource @@ -3017,8 +3215,8 @@ Represents the source code attached to a release in a particular format. | Field | Type | Description | | ----- | ---- | ----------- | -| `format` | String | Format of the source | -| `url` | String | Download URL of the source | +| `format` | String | Format of the source. | +| `url` | String | Download URL of the source. | ### ReleaseUpdatePayload @@ -3063,10 +3261,10 @@ Autogenerated return type of RepositionImageDiffNote. | Field | Type | Description | | ----- | ---- | ----------- | -| `empty` | Boolean! | Indicates repository has no visible content | -| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk | -| `rootRef` | String | Default branch of the repository | -| `tree` | Tree | Tree of the repository | +| `empty` | Boolean! | Indicates repository has no visible content. | +| `exists` | Boolean! | Indicates a corresponding Git repository exists on disk. | +| `rootRef` | String | Default branch of the repository. | +| `tree` | Tree | Tree of the repository. | ### Requirement @@ -3074,20 +3272,20 @@ Represents a requirement. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User! | Author of the requirement | -| `createdAt` | Time! | Timestamp of when the requirement was created | -| `description` | String | Description of the requirement | +| `author` | User! | Author of the requirement. | +| `createdAt` | Time! | Timestamp of when the requirement was created. | +| `description` | String | Description of the requirement. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `id` | ID! | ID of the requirement | -| `iid` | ID! | Internal ID of the requirement | -| `lastTestReportManuallyCreated` | Boolean | Indicates if latest test report was created by user | -| `lastTestReportState` | TestReportState | Latest requirement test report state | -| `project` | Project! | Project to which the requirement belongs | -| `state` | RequirementState! | State of the requirement | -| `testReports` | TestReportConnection | Test reports of the requirement | -| `title` | String | Title of the requirement | +| `id` | ID! | ID of the requirement. | +| `iid` | ID! | Internal ID of the requirement. | +| `lastTestReportManuallyCreated` | Boolean | Indicates if latest test report was created by user. | +| `lastTestReportState` | TestReportState | Latest requirement test report state. | +| `project` | Project! | Project to which the requirement belongs. | +| `state` | RequirementState! | State of the requirement. | +| `testReports` | TestReportConnection | Test reports of the requirement. | +| `title` | String | Title of the requirement. | | `titleHtml` | String | The GitLab Flavored Markdown rendering of `title` | -| `updatedAt` | Time! | Timestamp of when the requirement was last updated | +| `updatedAt` | Time! | Timestamp of when the requirement was last updated. | | `userPermissions` | RequirementPermissions! | Permissions for the current user on the resource | ### RequirementPermissions @@ -3108,8 +3306,8 @@ Counts of requirements by their state. | Field | Type | Description | | ----- | ---- | ----------- | -| `archived` | Int | Number of archived requirements | -| `opened` | Int | Number of opened requirements | +| `archived` | Int | Number of archived requirements. | +| `opened` | Int | Number of opened requirements. | ### RevertVulnerabilityToDetectedPayload @@ -3125,15 +3323,15 @@ Autogenerated return type of RevertVulnerabilityToDetected. | Field | Type | Description | | ----- | ---- | ----------- | -| `buildArtifactsSize` | Float! | The CI artifacts size in bytes | -| `lfsObjectsSize` | Float! | The LFS objects size in bytes | -| `packagesSize` | Float! | The packages size in bytes | -| `pipelineArtifactsSize` | Float! | The CI pipeline artifacts size in bytes | -| `repositorySize` | Float! | The Git repository size in bytes | -| `snippetsSize` | Float! | The snippets size in bytes | -| `storageSize` | Float! | The total storage in bytes | -| `uploadsSize` | Float! | The uploads size in bytes | -| `wikiSize` | Float! | The wiki size in bytes | +| `buildArtifactsSize` | Float! | The CI artifacts size in bytes. | +| `lfsObjectsSize` | Float! | The LFS objects size in bytes. | +| `packagesSize` | Float! | The packages size in bytes. | +| `pipelineArtifactsSize` | Float! | The CI pipeline artifacts size in bytes. | +| `repositorySize` | Float! | The Git repository size in bytes. | +| `snippetsSize` | Float! | The snippets size in bytes. | +| `storageSize` | Float! | The total storage in bytes. | +| `uploadsSize` | Float! | The uploads size in bytes. | +| `wikiSize` | Float! | The wiki size in bytes. | ### RunDASTScanPayload @@ -3149,23 +3347,23 @@ Autogenerated return type of RunDASTScan. | Field | Type | Description | | ----- | ---- | ----------- | -| `downloadLocation` | String! | Download location for the runner for the platform architecture | -| `name` | String! | Name of the runner platform architecture | +| `downloadLocation` | String! | Download location for the runner for the platform architecture. | +| `name` | String! | Name of the runner platform architecture. | ### RunnerPlatform | Field | Type | Description | | ----- | ---- | ----------- | -| `architectures` | RunnerArchitectureConnection | Runner architectures supported for the platform | -| `humanReadableName` | String! | Human readable name of the runner platform | -| `name` | String! | Name slug of the runner platform | +| `architectures` | RunnerArchitectureConnection | Runner architectures supported for the platform. | +| `humanReadableName` | String! | Human readable name of the runner platform. | +| `name` | String! | Name slug of the runner platform. | ### RunnerSetup | Field | Type | Description | | ----- | ---- | ----------- | -| `installInstructions` | String! | Instructions for installing the runner on the specified architecture | -| `registerInstructions` | String | Instructions for registering the runner | +| `installInstructions` | String! | Instructions for installing the runner on the specified architecture. | +| `registerInstructions` | String | Instructions for registering the runner. | ### SastCiConfiguration @@ -3183,11 +3381,11 @@ Represents an analyzer entity in SAST CI configuration. | Field | Type | Description | | ----- | ---- | ----------- | -| `description` | String | Analyzer description that is displayed on the form | -| `enabled` | Boolean | Indicates whether an analyzer is enabled | -| `label` | String | Analyzer label used in the config UI | -| `name` | String | Name of the analyzer | -| `variables` | SastCiConfigurationEntityConnection | List of supported variables | +| `description` | String | Analyzer description that is displayed on the form. | +| `enabled` | Boolean | Indicates whether an analyzer is enabled. | +| `label` | String | Analyzer label used in the config UI. | +| `name` | String | Name of the analyzer. | +| `variables` | SastCiConfigurationEntityConnection | List of supported variables. | ### SastCiConfigurationEntity @@ -3219,8 +3417,8 @@ Represents a resource scanned by a security scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `requestMethod` | String | The HTTP request method used to access the URL | -| `url` | String | The URL scanned by the scanner | +| `requestMethod` | String | The HTTP request method used to access the URL. | +| `url` | String | The URL scanned by the scanner. | ### SecurityReportSummary @@ -3228,13 +3426,13 @@ Represents summary of a security report. | Field | Type | Description | | ----- | ---- | ----------- | -| `apiFuzzing` | SecurityReportSummarySection | Aggregated counts for the api_fuzzing scan | -| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the container_scanning scan | -| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the coverage_fuzzing scan | -| `dast` | SecurityReportSummarySection | Aggregated counts for the dast scan | -| `dependencyScanning` | SecurityReportSummarySection | Aggregated counts for the dependency_scanning scan | -| `sast` | SecurityReportSummarySection | Aggregated counts for the sast scan | -| `secretDetection` | SecurityReportSummarySection | Aggregated counts for the secret_detection scan | +| `apiFuzzing` | SecurityReportSummarySection | Aggregated counts for the `api_fuzzing` scan | +| `containerScanning` | SecurityReportSummarySection | Aggregated counts for the `container_scanning` scan | +| `coverageFuzzing` | SecurityReportSummarySection | Aggregated counts for the `coverage_fuzzing` scan | +| `dast` | SecurityReportSummarySection | Aggregated counts for the `dast` scan | +| `dependencyScanning` | SecurityReportSummarySection | Aggregated counts for the `dependency_scanning` scan | +| `sast` | SecurityReportSummarySection | Aggregated counts for the `sast` scan | +| `secretDetection` | SecurityReportSummarySection | Aggregated counts for the `secret_detection` scan | ### SecurityReportSummarySection @@ -3242,10 +3440,10 @@ Represents a section of a summary of a security report. | Field | Type | Description | | ----- | ---- | ----------- | -| `scannedResources` | ScannedResourceConnection | A list of the first 20 scanned resources | -| `scannedResourcesCount` | Int | Total number of scanned resources | -| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format | -| `vulnerabilitiesCount` | Int | Total number of vulnerabilities | +| `scannedResources` | ScannedResourceConnection | A list of the first 20 scanned resources. | +| `scannedResourcesCount` | Int | Total number of scanned resources. | +| `scannedResourcesCsvPath` | String | Path to download all the scanned resources in CSV format. | +| `vulnerabilitiesCount` | Int | Total number of vulnerabilities. | ### SecurityScanners @@ -3263,34 +3461,34 @@ A Sentry error. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | Count of occurrences | -| `culprit` | String! | Culprit of the error | -| `externalBaseUrl` | String! | External Base URL of the Sentry Instance | -| `externalUrl` | String! | External URL of the error | -| `firstReleaseLastCommit` | String | Commit the error was first seen | -| `firstReleaseShortVersion` | String | Release short version the error was first seen | -| `firstReleaseVersion` | String | Release version the error was first seen | -| `firstSeen` | Time! | Timestamp when the error was first seen | -| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error | -| `gitlabCommit` | String | GitLab commit SHA attributed to the Error based on the release version | -| `gitlabCommitPath` | String | Path to the GitLab page for the GitLab commit attributed to the error | -| `gitlabIssuePath` | String | URL of GitLab Issue | -| `id` | ID! | ID (global ID) of the error | -| `lastReleaseLastCommit` | String | Commit the error was last seen | -| `lastReleaseShortVersion` | String | Release short version the error was last seen | -| `lastReleaseVersion` | String | Release version the error was last seen | -| `lastSeen` | Time! | Timestamp when the error was last seen | -| `message` | String | Sentry metadata message of the error | -| `sentryId` | String! | ID (Sentry ID) of the error | -| `sentryProjectId` | ID! | ID of the project (Sentry project) | -| `sentryProjectName` | String! | Name of the project affected by the error | -| `sentryProjectSlug` | String! | Slug of the project affected by the error | -| `shortId` | String! | Short ID (Sentry ID) of the error | -| `status` | SentryErrorStatus! | Status of the error | -| `tags` | SentryErrorTags! | Tags associated with the Sentry Error | -| `title` | String! | Title of the error | -| `type` | String! | Type of the error | -| `userCount` | Int! | Count of users affected by the error | +| `count` | Int! | Count of occurrences. | +| `culprit` | String! | Culprit of the error. | +| `externalBaseUrl` | String! | External Base URL of the Sentry Instance. | +| `externalUrl` | String! | External URL of the error. | +| `firstReleaseLastCommit` | String | Commit the error was first seen. | +| `firstReleaseShortVersion` | String | Release short version the error was first seen. | +| `firstReleaseVersion` | String | Release version the error was first seen. | +| `firstSeen` | Time! | Timestamp when the error was first seen. | +| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error. | +| `gitlabCommit` | String | GitLab commit SHA attributed to the Error based on the release version. | +| `gitlabCommitPath` | String | Path to the GitLab page for the GitLab commit attributed to the error. | +| `gitlabIssuePath` | String | URL of GitLab Issue. | +| `id` | ID! | ID (global ID) of the error. | +| `lastReleaseLastCommit` | String | Commit the error was last seen. | +| `lastReleaseShortVersion` | String | Release short version the error was last seen. | +| `lastReleaseVersion` | String | Release version the error was last seen. | +| `lastSeen` | Time! | Timestamp when the error was last seen. | +| `message` | String | Sentry metadata message of the error. | +| `sentryId` | String! | ID (Sentry ID) of the error. | +| `sentryProjectId` | ID! | ID of the project (Sentry project). | +| `sentryProjectName` | String! | Name of the project affected by the error. | +| `sentryProjectSlug` | String! | Slug of the project affected by the error. | +| `shortId` | String! | Short ID (Sentry ID) of the error. | +| `status` | SentryErrorStatus! | Status of the error. | +| `tags` | SentryErrorTags! | Tags associated with the Sentry Error. | +| `title` | String! | Title of the error. | +| `type` | String! | Type of the error. | +| `userCount` | Int! | Count of users affected by the error. | ### SentryError @@ -3298,23 +3496,23 @@ A Sentry error. A simplified version of SentryDetailedError. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | Count of occurrences | -| `culprit` | String! | Culprit of the error | -| `externalUrl` | String! | External URL of the error | -| `firstSeen` | Time! | Timestamp when the error was first seen | -| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error | -| `id` | ID! | ID (global ID) of the error | -| `lastSeen` | Time! | Timestamp when the error was last seen | -| `message` | String | Sentry metadata message of the error | -| `sentryId` | String! | ID (Sentry ID) of the error | -| `sentryProjectId` | ID! | ID of the project (Sentry project) | -| `sentryProjectName` | String! | Name of the project affected by the error | -| `sentryProjectSlug` | String! | Slug of the project affected by the error | -| `shortId` | String! | Short ID (Sentry ID) of the error | -| `status` | SentryErrorStatus! | Status of the error | -| `title` | String! | Title of the error | -| `type` | String! | Type of the error | -| `userCount` | Int! | Count of users affected by the error | +| `count` | Int! | Count of occurrences. | +| `culprit` | String! | Culprit of the error. | +| `externalUrl` | String! | External URL of the error. | +| `firstSeen` | Time! | Timestamp when the error was first seen. | +| `frequency` | SentryErrorFrequency! => Array | Last 24hr stats of the error. | +| `id` | ID! | ID (global ID) of the error. | +| `lastSeen` | Time! | Timestamp when the error was last seen. | +| `message` | String | Sentry metadata message of the error. | +| `sentryId` | String! | ID (Sentry ID) of the error. | +| `sentryProjectId` | ID! | ID of the project (Sentry project). | +| `sentryProjectName` | String! | Name of the project affected by the error. | +| `sentryProjectSlug` | String! | Slug of the project affected by the error. | +| `shortId` | String! | Short ID (Sentry ID) of the error. | +| `status` | SentryErrorStatus! | Status of the error. | +| `title` | String! | Title of the error. | +| `type` | String! | Type of the error. | +| `userCount` | Int! | Count of users affected by the error. | ### SentryErrorCollection @@ -3322,17 +3520,17 @@ An object containing a collection of Sentry errors, and a detailed error. | Field | Type | Description | | ----- | ---- | ----------- | -| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project | -| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error | -| `errors` | SentryErrorConnection | Collection of Sentry Errors | -| `externalUrl` | String | External URL for Sentry | +| `detailedError` | SentryDetailedError | Detailed version of a Sentry error on the project. | +| `errorStackTrace` | SentryErrorStackTrace | Stack Trace of Sentry Error. | +| `errors` | SentryErrorConnection | Collection of Sentry Errors. | +| `externalUrl` | String | External URL for Sentry. | ### SentryErrorFrequency | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | Count of errors received since the previously recorded time | -| `time` | Time! | Time the error frequency stats were recorded | +| `count` | Int! | Count of errors received since the previously recorded time. | +| `time` | Time! | Time the error frequency stats were recorded. | ### SentryErrorStackTrace @@ -3340,9 +3538,9 @@ An object containing a stack trace entry for a Sentry error. | Field | Type | Description | | ----- | ---- | ----------- | -| `dateReceived` | String! | Time the stack trace was received by Sentry | -| `issueId` | String! | ID of the Sentry error | -| `stackTraceEntries` | SentryErrorStackTraceEntry! => Array | Stack trace entries for the Sentry error | +| `dateReceived` | String! | Time the stack trace was received by Sentry. | +| `issueId` | String! | ID of the Sentry error. | +| `stackTraceEntries` | SentryErrorStackTraceEntry! => Array | Stack trace entries for the Sentry error. | ### SentryErrorStackTraceContext @@ -3350,8 +3548,8 @@ An object context for a Sentry error stack trace. | Field | Type | Description | | ----- | ---- | ----------- | -| `code` | String! | Code number of the context | -| `line` | Int! | Line number of the context | +| `code` | String! | Code number of the context. | +| `line` | Int! | Line number of the context. | ### SentryErrorStackTraceEntry @@ -3359,11 +3557,11 @@ An object containing a stack trace entry for a Sentry error. | Field | Type | Description | | ----- | ---- | ----------- | -| `col` | String | Function in which the Sentry error occurred | -| `fileName` | String | File in which the Sentry error occurred | -| `function` | String | Function in which the Sentry error occurred | -| `line` | String | Function in which the Sentry error occurred | -| `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error | +| `col` | String | Function in which the Sentry error occurred. | +| `fileName` | String | File in which the Sentry error occurred. | +| `function` | String | Function in which the Sentry error occurred. | +| `line` | String | Function in which the Sentry error occurred. | +| `traceContext` | SentryErrorStackTraceContext! => Array | Context of the Sentry error. | ### SentryErrorTags @@ -3371,8 +3569,8 @@ State of a Sentry error. | Field | Type | Description | | ----- | ---- | ----------- | -| `level` | String | Severity level of the Sentry Error | -| `logger` | String | Logger of the Sentry Error | +| `level` | String | Severity level of the Sentry Error. | +| `logger` | String | Logger of the Sentry Error. | ### Snippet @@ -3380,25 +3578,25 @@ Represents a snippet entry. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User | The owner of the snippet | +| `author` | User | The owner of the snippet. | | `blob` **{warning-solid}** | SnippetBlob! | **Deprecated:** Use `blobs`. Deprecated in 13.3. | -| `blobs` | SnippetBlobConnection | Snippet blobs | -| `createdAt` | Time! | Timestamp this snippet was created | -| `description` | String | Description of the snippet | +| `blobs` | SnippetBlobConnection | Snippet blobs. | +| `createdAt` | Time! | Timestamp this snippet was created. | +| `description` | String | Description of the snippet. | | `descriptionHtml` | String | The GitLab Flavored Markdown rendering of `description` | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `fileName` | String | File Name of the snippet | -| `httpUrlToRepo` | String | HTTP URL to the snippet repository | -| `id` | SnippetID! | ID of the snippet | -| `notes` | NoteConnection! | All notes on this noteable | -| `project` | Project | The project the snippet is associated with | -| `rawUrl` | String! | Raw URL of the snippet | -| `sshUrlToRepo` | String | SSH URL to the snippet repository | -| `title` | String! | Title of the snippet | -| `updatedAt` | Time! | Timestamp this snippet was updated | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `fileName` | String | File Name of the snippet. | +| `httpUrlToRepo` | String | HTTP URL to the snippet repository. | +| `id` | SnippetID! | ID of the snippet. | +| `notes` | NoteConnection! | All notes on this noteable. | +| `project` | Project | The project the snippet is associated with. | +| `rawUrl` | String! | Raw URL of the snippet. | +| `sshUrlToRepo` | String | SSH URL to the snippet repository. | +| `title` | String! | Title of the snippet. | +| `updatedAt` | Time! | Timestamp this snippet was updated. | | `userPermissions` | SnippetPermissions! | Permissions for the current user on the resource | -| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet | -| `webUrl` | String! | Web URL of the snippet | +| `visibilityLevel` | VisibilityLevelsEnum! | Visibility Level of the snippet. | +| `webUrl` | String! | Web URL of the snippet. | ### SnippetBlob @@ -3406,18 +3604,18 @@ Represents the snippet blob. | Field | Type | Description | | ----- | ---- | ----------- | -| `binary` | Boolean! | Shows whether the blob is binary | -| `externalStorage` | String | Blob external storage | -| `mode` | String | Blob mode | -| `name` | String | Blob name | -| `path` | String | Blob path | -| `plainData` | String | Blob plain highlighted data | -| `rawPath` | String! | Blob raw content endpoint path | -| `renderedAsText` | Boolean! | Shows whether the blob is rendered as text | -| `richData` | String | Blob highlighted data | -| `richViewer` | SnippetBlobViewer | Blob content rich viewer | -| `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer | -| `size` | Int! | Blob size | +| `binary` | Boolean! | Shows whether the blob is binary. | +| `externalStorage` | String | Blob external storage. | +| `mode` | String | Blob mode. | +| `name` | String | Blob name. | +| `path` | String | Blob path. | +| `plainData` | String | Blob plain highlighted data. | +| `rawPath` | String! | Blob raw content endpoint path. | +| `renderedAsText` | Boolean! | Shows whether the blob is rendered as text. | +| `richData` | String | Blob highlighted data. | +| `richViewer` | SnippetBlobViewer | Blob content rich viewer. | +| `simpleViewer` | SnippetBlobViewer! | Blob content simple viewer. | +| `size` | Int! | Blob size. | ### SnippetBlobViewer @@ -3425,13 +3623,13 @@ Represents how the blob content should be displayed. | Field | Type | Description | | ----- | ---- | ----------- | -| `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed | -| `fileType` | String! | Content file type | -| `loadAsync` | Boolean! | Shows whether the blob content is loaded async | -| `loadingPartialName` | String! | Loading partial name | -| `renderError` | String | Error rendering the blob content | -| `tooLarge` | Boolean! | Shows whether the blob too large to be displayed | -| `type` | BlobViewersType! | Type of blob viewer | +| `collapsed` | Boolean! | Shows whether the blob should be displayed collapsed. | +| `fileType` | String! | Content file type. | +| `loadAsync` | Boolean! | Shows whether the blob content is loaded asynchronously. | +| `loadingPartialName` | String! | Loading partial name. | +| `renderError` | String | Error rendering the blob content. | +| `tooLarge` | Boolean! | Shows whether the blob too large to be displayed. | +| `type` | BlobViewersType! | Type of blob viewer. | ### SnippetPermissions @@ -3456,31 +3654,31 @@ Represents the Geo sync and verification state of a snippet repository. | `lastSyncedAt` | Time | Timestamp of the most recent successful sync of the SnippetRepositoryRegistry | | `retryAt` | Time | Timestamp after which the SnippetRepositoryRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the SnippetRepositoryRegistry | -| `snippetRepositoryId` | ID! | ID of the Snippet Repository | +| `snippetRepositoryId` | ID! | ID of the Snippet Repository. | | `state` | RegistryState | Sync state of the SnippetRepositoryRegistry | ### StatusAction | Field | Type | Description | | ----- | ---- | ----------- | -| `buttonTitle` | String | Title for the button, for example: Retry this job | -| `icon` | String | Icon used in the action button | -| `method` | String | Method for the action, for example: :post | -| `path` | String | Path for the action | -| `title` | String | Title for the action, for example: Retry | +| `buttonTitle` | String | Title for the button, for example: Retry this job. | +| `icon` | String | Icon used in the action button. | +| `method` | String | Method for the action, for example: :post. | +| `path` | String | Path for the action. | +| `title` | String | Title for the action, for example: Retry. | ### Submodule | Field | Type | Description | | ----- | ---- | ----------- | -| `flatPath` | String! | Flat path of the entry | -| `id` | ID! | ID of the entry | -| `name` | String! | Name of the entry | -| `path` | String! | Path of the entry | -| `sha` | String! | Last commit sha for the entry | -| `treeUrl` | String | Tree URL for the sub-module | -| `type` | EntryType! | Type of tree entry | -| `webUrl` | String | Web URL for the sub-module | +| `flatPath` | String! | Flat path of the entry. | +| `id` | ID! | ID of the entry. | +| `name` | String! | Name of the entry. | +| `path` | String! | Path of the entry. | +| `sha` | String! | Last commit SHA for the entry. | +| `treeUrl` | String | Tree URL for the sub-module. | +| `type` | EntryType! | Type of tree entry. | +| `webUrl` | String | Web URL for the sub-module. | ### TaskCompletionStatus @@ -3488,20 +3686,20 @@ Completion status of tasks. | Field | Type | Description | | ----- | ---- | ----------- | -| `completedCount` | Int! | Number of completed tasks | -| `count` | Int! | Number of total tasks | +| `completedCount` | Int! | Number of completed tasks. | +| `count` | Int! | Number of total tasks. | ### TerraformState | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp the Terraform state was created | -| `id` | ID! | ID of the Terraform state | -| `latestVersion` | TerraformStateVersion | The latest version of the Terraform state | -| `lockedAt` | Time | Timestamp the Terraform state was locked | -| `lockedByUser` | User | The user currently holding a lock on the Terraform state | -| `name` | String! | Name of the Terraform state | -| `updatedAt` | Time! | Timestamp the Terraform state was updated | +| `createdAt` | Time! | Timestamp the Terraform state was created. | +| `id` | ID! | ID of the Terraform state. | +| `latestVersion` | TerraformStateVersion | The latest version of the Terraform state. | +| `lockedAt` | Time | Timestamp the Terraform state was locked. | +| `lockedByUser` | User | The user currently holding a lock on the Terraform state. | +| `name` | String! | Name of the Terraform state. | +| `updatedAt` | Time! | Timestamp the Terraform state was updated. | ### TerraformStateDeletePayload @@ -3534,13 +3732,13 @@ Autogenerated return type of TerraformStateUnlock. | Field | Type | Description | | ----- | ---- | ----------- | -| `createdAt` | Time! | Timestamp the version was created | -| `createdByUser` | User | The user that created this version | -| `downloadPath` | String | URL for downloading the version's JSON file | -| `id` | ID! | ID of the Terraform state version | -| `job` | CiJob | The job that created this version | -| `serial` | Int | Serial number of the version | -| `updatedAt` | Time! | Timestamp the version was updated | +| `createdAt` | Time! | Timestamp the version was created. | +| `createdByUser` | User | The user that created this version. | +| `downloadPath` | String | URL for downloading the version's JSON file. | +| `id` | ID! | ID of the Terraform state version. | +| `job` | CiJob | The job that created this version. | +| `serial` | Int | Serial number of the version. | +| `updatedAt` | Time! | Timestamp the version was updated. | ### TerraformStateVersionRegistry @@ -3555,7 +3753,7 @@ Represents the Geo sync and verification state of a terraform state version. | `retryAt` | Time | Timestamp after which the TerraformStateVersionRegistry should be resynced | | `retryCount` | Int | Number of consecutive failed sync attempts of the TerraformStateVersionRegistry | | `state` | RegistryState | Sync state of the TerraformStateVersionRegistry | -| `terraformStateVersionId` | ID! | ID of the terraform state version | +| `terraformStateVersionId` | ID! | ID of the terraform state version. | ### TestReport @@ -3563,10 +3761,10 @@ Represents a requirement test report. | Field | Type | Description | | ----- | ---- | ----------- | -| `author` | User | Author of the test report | -| `createdAt` | Time! | Timestamp of when the test report was created | -| `id` | ID! | ID of the test report | -| `state` | TestReportState! | State of the test report | +| `author` | User | Author of the test report. | +| `createdAt` | Time! | Timestamp of when the test report was created. | +| `id` | ID! | ID of the test report. | +| `state` | TestReportState! | State of the test report. | ### TimeReportStats @@ -3574,9 +3772,9 @@ Represents the time report stats for timeboxes. | Field | Type | Description | | ----- | ---- | ----------- | -| `complete` | TimeboxMetrics | Completed issues metrics | -| `incomplete` | TimeboxMetrics | Incomplete issues metrics | -| `total` | TimeboxMetrics | Total issues metrics | +| `complete` | TimeboxMetrics | Completed issues metrics. | +| `incomplete` | TimeboxMetrics | Incomplete issues metrics. | +| `total` | TimeboxMetrics | Total issues metrics. | ### TimeboxMetrics @@ -3584,8 +3782,8 @@ Represents measured stats metrics for timeboxes. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | The count metric | -| `weight` | Int! | The weight metric | +| `count` | Int! | The count metric. | +| `weight` | Int! | The weight metric. | ### TimeboxReport @@ -3593,34 +3791,34 @@ Represents a historically accurate report about the timebox. | Field | Type | Description | | ----- | ---- | ----------- | -| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts | -| `stats` | TimeReportStats | Represents the time report stats for the timebox | +| `burnupTimeSeries` | BurnupChartDailyTotals! => Array | Daily scope and completed totals for burnup charts. | +| `stats` | TimeReportStats | Represents the time report stats for the timebox. | ### Timelog | Field | Type | Description | | ----- | ---- | ----------- | -| `issue` | Issue | The issue that logged time was added to | -| `note` | Note | The note where the quick action to add the logged time was executed | -| `spentAt` | Time | Timestamp of when the time tracked was spent at | -| `timeSpent` | Int! | The time spent displayed in seconds | -| `user` | User! | The user that logged the time | +| `issue` | Issue | The issue that logged time was added to. | +| `note` | Note | The note where the quick action to add the logged time was executed. | +| `spentAt` | Time | Timestamp of when the time tracked was spent at. | +| `timeSpent` | Int! | The time spent displayed in seconds. | +| `user` | User! | The user that logged the time. | ### Todo -Representing a todo entry. +Representing a to-do entry. | Field | Type | Description | | ----- | ---- | ----------- | -| `action` | TodoActionEnum! | Action of the todo | -| `author` | User! | The author of this todo | -| `body` | String! | Body of the todo | -| `createdAt` | Time! | Timestamp this todo was created | -| `group` | Group | Group this todo is associated with | -| `id` | ID! | ID of the todo | -| `project` | Project | The project this todo is associated with | -| `state` | TodoStateEnum! | State of the todo | -| `targetType` | TodoTargetEnum! | Target type of the todo | +| `action` | TodoActionEnum! | Action of the to-do item. | +| `author` | User! | The author of this to-do item. | +| `body` | String! | Body of the to-do item. | +| `createdAt` | Time! | Timestamp this to-do item was created. | +| `group` | Group | Group this to-do item is associated with. | +| `id` | ID! | ID of the to-do item. | +| `project` | Project | The project this to-do item is associated with. | +| `state` | TodoStateEnum! | State of the to-do item. | +| `targetType` | TodoTargetEnum! | Target type of the to-do item. | ### TodoCreatePayload @@ -3630,7 +3828,7 @@ Autogenerated return type of TodoCreate. | ----- | ---- | ----------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `todo` | Todo | The to-do created. | +| `todo` | Todo | The to-do item created. | ### TodoMarkDonePayload @@ -3640,7 +3838,7 @@ Autogenerated return type of TodoMarkDone. | ----- | ---- | ----------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `todo` | Todo! | The requested todo. | +| `todo` | Todo! | The requested to-do item. | ### TodoRestoreManyPayload @@ -3650,8 +3848,8 @@ Autogenerated return type of TodoRestoreMany. | ----- | ---- | ----------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `todos` | Todo! => Array | Updated todos. | -| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. | +| `todos` | Todo! => Array | Updated to-do items. | +| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. | ### TodoRestorePayload @@ -3661,7 +3859,7 @@ Autogenerated return type of TodoRestore. | ----- | ---- | ----------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `todo` | Todo! | The requested todo. | +| `todo` | Todo! | The requested to-do item. | ### TodosMarkAllDonePayload @@ -3671,8 +3869,8 @@ Autogenerated return type of TodosMarkAllDone. | ----- | ---- | ----------- | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `todos` | Todo! => Array | Updated todos. | -| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use todos. Deprecated in 13.2. | +| `todos` | Todo! => Array | Updated to-do items. | +| `updatedIds` **{warning-solid}** | TodoID! => Array | **Deprecated:** Use to-do items. Deprecated in 13.2. | ### ToggleAwardEmojiPayload @@ -3689,10 +3887,10 @@ Autogenerated return type of ToggleAwardEmoji. | Field | Type | Description | | ----- | ---- | ----------- | -| `blobs` | BlobConnection! | Blobs of the tree | -| `lastCommit` | Commit | Last commit for the tree | -| `submodules` | SubmoduleConnection! | Sub-modules of the tree | -| `trees` | TreeEntryConnection! | Trees of the tree | +| `blobs` | BlobConnection! | Blobs of the tree. | +| `lastCommit` | Commit | Last commit for the tree. | +| `submodules` | SubmoduleConnection! | Sub-modules of the tree. | +| `trees` | TreeEntryConnection! | Trees of the tree. | ### TreeEntry @@ -3700,14 +3898,14 @@ Represents a directory. | Field | Type | Description | | ----- | ---- | ----------- | -| `flatPath` | String! | Flat path of the entry | -| `id` | ID! | ID of the entry | -| `name` | String! | Name of the entry | -| `path` | String! | Path of the entry | -| `sha` | String! | Last commit sha for the entry | -| `type` | EntryType! | Type of tree entry | -| `webPath` | String | Web path for the tree entry (directory) | -| `webUrl` | String | Web URL for the tree entry (directory) | +| `flatPath` | String! | Flat path of the entry. | +| `id` | ID! | ID of the entry. | +| `name` | String! | Name of the entry. | +| `path` | String! | Path of the entry. | +| `sha` | String! | Last commit SHA for the entry. | +| `type` | EntryType! | Type of tree entry. | +| `webPath` | String | Web path for the tree entry (directory). | +| `webUrl` | String | Web URL for the tree entry (directory). | ### UpdateAlertStatusPayload @@ -3719,7 +3917,7 @@ Autogenerated return type of UpdateAlertStatus. | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `issue` | Issue | The issue created after mutation. | -| `todo` | Todo | The todo after mutation. | +| `todo` | Todo | The to-do item after mutation. | ### UpdateBoardEpicUserPreferencesPayload @@ -3771,16 +3969,6 @@ Autogenerated return type of UpdateContainerExpirationPolicy. | `containerExpirationPolicy` | ContainerExpirationPolicy | The container expiration policy after mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | -### UpdateDevopsAdoptionSegmentPayload - -Autogenerated return type of UpdateDevopsAdoptionSegment. - -| Field | Type | Description | -| ----- | ---- | ----------- | -| `clientMutationId` | String | A unique identifier for the client performing the mutation. | -| `errors` | String! => Array | Errors encountered during execution of the mutation. | -| `segment` | DevopsAdoptionSegment | The segment after mutation. | - ### UpdateEpicPayload Autogenerated return type of UpdateEpic. @@ -3857,36 +4045,40 @@ Autogenerated return type of UpdateSnippet. | Field | Type | Description | | ----- | ---- | ----------- | +| `captchaSiteKey` | String | The CAPTCHA site key which must be used to render a challenge for the user to solve to obtain a valid captchaResponse value. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | | `clientMutationId` | String | A unique identifier for the client performing the mutation. | | `errors` | String! => Array | Errors encountered during execution of the mutation. | +| `needsCaptchaResponse` | Boolean | Indicates whether the operation was detected as possible spam and not completed. If CAPTCHA is enabled, the request must be resubmitted with a valid CAPTCHA response and spam_log_id included for the operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | | `snippet` | Snippet | The snippet after mutation. | -| `spam` | Boolean | Indicates whether the operation returns a record detected as spam. | +| `spam` | Boolean | Indicates whether the operation was detected as definite spam. There is no option to resubmit the request with a CAPTCHA response. | +| `spamLogId` | Int | The spam log ID which must be passed along with a valid CAPTCHA response for an operation to be completed. Included only when an operation was not completed because "NeedsCaptchaResponse" is true. | ### User | Field | Type | Description | | ----- | ---- | ----------- | -| `assignedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user | -| `authoredMergeRequests` | MergeRequestConnection | Merge Requests authored by the user | -| `avatarUrl` | String | URL of the user's avatar | +| `assignedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user. | +| `authoredMergeRequests` | MergeRequestConnection | Merge Requests authored by the user. | +| `avatarUrl` | String | URL of the user's avatar. | +| `bot` | Boolean! | Indicates if the user is a bot. | | `email` **{warning-solid}** | String | **Deprecated:** Use public_email. Deprecated in 13.7. | -| `groupCount` | Int | Group count for the user Available only when feature flag `user_group_counts` is enabled. | -| `groupMemberships` | GroupMemberConnection | Group memberships of the user | -| `id` | ID! | ID of the user | +| `groupCount` | Int | Group count for the user. Available only when feature flag `user_group_counts` is enabled. | +| `groupMemberships` | GroupMemberConnection | Group memberships of the user. | +| `id` | ID! | ID of the user. | | `location` | String | The location of the user. | -| `name` | String! | Human-readable name of the user | -| `projectMemberships` | ProjectMemberConnection | Project memberships of the user | -| `publicEmail` | String | User's public email | -| `reviewRequestedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user for review | -| `snippets` | SnippetConnection | Snippets authored by the user | -| `starredProjects` | ProjectConnection | Projects starred by the user | -| `state` | UserState! | State of the user | -| `status` | UserStatus | User status | -| `todos` | TodoConnection! | Todos of the user | +| `name` | String! | Human-readable name of the user. | +| `projectMemberships` | ProjectMemberConnection | Project memberships of the user. | +| `publicEmail` | String | User's public email. | +| `reviewRequestedMergeRequests` | MergeRequestConnection | Merge Requests assigned to the user for review. | +| `snippets` | SnippetConnection | Snippets authored by the user. | +| `starredProjects` | ProjectConnection | Projects starred by the user. | +| `state` | UserState! | State of the user. | +| `status` | UserStatus | User status. | +| `todos` | TodoConnection! | To-do items of the user. | | `userPermissions` | UserPermissions! | Permissions for the current user on the resource | -| `username` | String! | Username of the user. Unique within this instance of GitLab | -| `webPath` | String! | Web path of the user | -| `webUrl` | String! | Web URL of the user | +| `username` | String! | Username of the user. Unique within this instance of GitLab. | +| `webPath` | String! | Web path of the user. | +| `webUrl` | String! | Web URL of the user. | ### UserPermissions @@ -3898,9 +4090,9 @@ Autogenerated return type of UpdateSnippet. | Field | Type | Description | | ----- | ---- | ----------- | -| `availability` | AvailabilityEnum! | User availability status | -| `emoji` | String | String representation of emoji | -| `message` | String | User status message | +| `availability` | AvailabilityEnum! | User availability status. | +| `emoji` | String | String representation of emoji. | +| `message` | String | User status message. | | `messageHtml` | String | HTML of the user status message | ### VulnerabilitiesCountByDay @@ -3910,12 +4102,12 @@ Represents the count of vulnerabilities by severity on a particular day. This da | Field | Type | Description | | ----- | ---- | ----------- | | `critical` | Int! | Total number of vulnerabilities on a particular day with critical severity | -| `date` | ISO8601Date! | Date for the count | +| `date` | ISO8601Date! | Date for the count. | | `high` | Int! | Total number of vulnerabilities on a particular day with high severity | | `info` | Int! | Total number of vulnerabilities on a particular day with info severity | | `low` | Int! | Total number of vulnerabilities on a particular day with low severity | | `medium` | Int! | Total number of vulnerabilities on a particular day with medium severity | -| `total` | Int! | Total number of vulnerabilities on a particular day | +| `total` | Int! | Total number of vulnerabilities on a particular day. | | `unknown` | Int! | Total number of vulnerabilities on a particular day with unknown severity | ### VulnerabilitiesCountByDayAndSeverity @@ -3924,9 +4116,9 @@ Represents the number of vulnerabilities for a particular severity on a particul | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int | Number of vulnerabilities | -| `day` | ISO8601Date | Date for the count | -| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities | +| `count` | Int | Number of vulnerabilities. | +| `day` | ISO8601Date | Date for the count. | +| `severity` | VulnerabilitySeverity | Severity of the counted vulnerabilities. | ### Vulnerability @@ -3934,34 +4126,35 @@ Represents a vulnerability. | Field | Type | Description | | ----- | ---- | ----------- | -| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed | +| `confirmedAt` | Time | Timestamp of when the vulnerability state was changed to confirmed. | | `confirmedBy` | User | The user that confirmed the vulnerability. | -| `description` | String | Description of the vulnerability | -| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected | -| `discussions` | DiscussionConnection! | All discussions on this noteable | -| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed | +| `description` | String | Description of the vulnerability. | +| `details` | VulnerabilityDetail! => Array | Details of the vulnerability. | +| `detectedAt` | Time! | Timestamp of when the vulnerability was first detected. | +| `discussions` | DiscussionConnection! | All discussions on this noteable. | +| `dismissedAt` | Time | Timestamp of when the vulnerability state was changed to dismissed. | | `dismissedBy` | User | The user that dismissed the vulnerability. | -| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability | +| `externalIssueLinks` | VulnerabilityExternalIssueLinkConnection! | List of external issue links related to the vulnerability. | | `hasSolutions` | Boolean | Indicates whether there is a solution available for this vulnerability. | -| `id` | ID! | GraphQL ID of the vulnerability | +| `id` | ID! | GraphQL ID of the vulnerability. | | `identifiers` | VulnerabilityIdentifier! => Array | Identifiers of the vulnerability. | -| `issueLinks` | VulnerabilityIssueLinkConnection! | List of issue links related to the vulnerability | -| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability | +| `issueLinks` | VulnerabilityIssueLinkConnection! | List of issue links related to the vulnerability. | +| `location` | VulnerabilityLocation | Location metadata for the vulnerability. Its fields depend on the type of security scan that found the vulnerability. | | `mergeRequest` | MergeRequest | Merge request that fixes the vulnerability. | -| `notes` | NoteConnection! | All notes on this noteable | +| `notes` | NoteConnection! | All notes on this noteable. | | `primaryIdentifier` | VulnerabilityIdentifier | Primary identifier of the vulnerability. | -| `project` | Project | The project on which the vulnerability was found | +| `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, SECRET_DETECTION, COVERAGE_FUZZING, API_FUZZING) | -| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved | +| `resolvedAt` | Time | Timestamp of when the vulnerability state was changed to resolved. | | `resolvedBy` | User | The user that resolved the vulnerability. | -| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not | +| `resolvedOnDefaultBranch` | Boolean! | Indicates whether the vulnerability is fixed on the default branch or not. | | `scanner` | VulnerabilityScanner | Scanner metadata for the vulnerability. | | `severity` | VulnerabilitySeverity | Severity of the vulnerability (INFO, UNKNOWN, LOW, MEDIUM, HIGH, CRITICAL) | | `state` | VulnerabilityState | State of the vulnerability (DETECTED, CONFIRMED, RESOLVED, DISMISSED) | -| `title` | String | Title of the vulnerability | -| `userNotesCount` | Int! | Number of user notes attached to the vulnerability | +| `title` | String | Title of the vulnerability. | +| `userNotesCount` | Int! | Number of user notes attached to the vulnerability. | | `userPermissions` | VulnerabilityPermissions! | Permissions for the current user on the resource | -| `vulnerabilityPath` | String | URL to the vulnerability's details page | +| `vulnerabilityPath` | String | URL to the vulnerability's details page. | ### VulnerabilityConfirmPayload @@ -3973,6 +4166,155 @@ Autogenerated return type of VulnerabilityConfirm. | `errors` | String! => Array | Errors encountered during execution of the mutation. | | `vulnerability` | Vulnerability | The vulnerability after state change. | +### VulnerabilityDetailBase + +Represents the vulnerability details base. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | + +### VulnerabilityDetailBoolean + +Represents the vulnerability details boolean value. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | +| `value` | Boolean! | Value of the field. | + +### VulnerabilityDetailCode + +Represents the vulnerability details code field. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `lang` | String | Language of the code. | +| `name` | String! | Name of the field. | +| `value` | String! | Source code. | + +### VulnerabilityDetailCommit + +Represents the vulnerability details commit field. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | +| `value` | String! | The commit SHA value. | + +### VulnerabilityDetailDiff + +Represents the vulnerability details diff field. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `after` | String! | Value of the field after the change. | +| `before` | String! | Value of the field before the change. | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | + +### VulnerabilityDetailFileLocation + +Represents the vulnerability details location within a file in the project. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `fileName` | String! | File name. | +| `lineEnd` | Int! | End line number of the file location. | +| `lineStart` | Int! | Start line number of the file location. | +| `name` | String! | Name of the field. | + +### VulnerabilityDetailInt + +Represents the vulnerability details integer value. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | +| `value` | Int! | Value of the field. | + +### VulnerabilityDetailList + +Represents the vulnerability details list value. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `items` | VulnerabilityDetail! => Array | List of details. | +| `name` | String! | Name of the field. | + +### VulnerabilityDetailMarkdown + +Represents the vulnerability details Markdown field. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | +| `value` | String! | Value of the Markdown field. | + +### VulnerabilityDetailModuleLocation + +Represents the vulnerability details location within a file in the project. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `moduleName` | String! | Module name. | +| `name` | String! | Name of the field. | +| `offset` | Int! | Offset of the module location. | + +### VulnerabilityDetailTable + +Represents the vulnerability details table value. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `headers` | VulnerabilityDetail! => Array | Table headers. | +| `name` | String! | Name of the field. | +| `rows` | VulnerabilityDetail! => Array | Table rows. | + +### VulnerabilityDetailText + +Represents the vulnerability details text field. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `name` | String! | Name of the field. | +| `value` | String! | Value of the text field. | + +### VulnerabilityDetailUrl + +Represents the vulnerability details URL field. + +| Field | Type | Description | +| ----- | ---- | ----------- | +| `description` | String! | Description of the field. | +| `fieldName` | String | Name of the field. | +| `href` | String! | Href of the URL. | +| `name` | String! | Name of the field. | +| `text` | String | Text of the URL. | + ### VulnerabilityDismissPayload Autogenerated return type of VulnerabilityDismiss. @@ -3989,9 +4331,9 @@ Represents an external issue link of a vulnerability. | Field | Type | Description | | ----- | ---- | ----------- | -| `externalIssue` | ExternalIssue | The external issue attached to the issue link | -| `id` | VulnerabilitiesExternalIssueLinkID! | GraphQL ID of the external issue link | -| `linkType` | VulnerabilityExternalIssueLinkType! | Type of the external issue link | +| `externalIssue` | ExternalIssue | The external issue attached to the issue link. | +| `id` | VulnerabilitiesExternalIssueLinkID! | GraphQL ID of the external issue link. | +| `linkType` | VulnerabilityExternalIssueLinkType! | Type of the external issue link. | ### VulnerabilityExternalIssueLinkCreatePayload @@ -4018,10 +4360,10 @@ Represents a vulnerability identifier. | Field | Type | Description | | ----- | ---- | ----------- | -| `externalId` | String | External ID of the vulnerability identifier | -| `externalType` | String | External type of the vulnerability identifier | -| `name` | String | Name of the vulnerability identifier | -| `url` | String | URL of the vulnerability identifier | +| `externalId` | String | External ID of the vulnerability identifier. | +| `externalType` | String | External type of the vulnerability identifier. | +| `name` | String | Name of the vulnerability identifier. | +| `url` | String | URL of the vulnerability identifier. | ### VulnerabilityIssueLink @@ -4029,9 +4371,9 @@ Represents an issue link of a vulnerability. | Field | Type | Description | | ----- | ---- | ----------- | -| `id` | ID! | GraphQL ID of the vulnerability | -| `issue` | Issue! | The issue attached to issue link | -| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link | +| `id` | ID! | GraphQL ID of the vulnerability. | +| `issue` | Issue! | The issue attached to issue link. | +| `linkType` | VulnerabilityIssueLinkType! | Type of the issue link. | ### VulnerabilityLocationContainerScanning @@ -4039,9 +4381,9 @@ Represents the location of a vulnerability found by a container security scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `dependency` | VulnerableDependency | Dependency containing the vulnerability | -| `image` | String | Name of the vulnerable container image | -| `operatingSystem` | String | Operating system that runs on the vulnerable container image | +| `dependency` | VulnerableDependency | Dependency containing the vulnerability. | +| `image` | String | Name of the vulnerable container image. | +| `operatingSystem` | String | Operating system that runs on the vulnerable container image. | ### VulnerabilityLocationCoverageFuzzing @@ -4049,11 +4391,12 @@ Represents the location of a vulnerability found by a Coverage Fuzzing scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `endLine` | String | Number of the last relevant line in the vulnerable file | -| `file` | String | Path to the vulnerable file | -| `startLine` | String | Number of the first relevant line in the vulnerable file | -| `vulnerableClass` | String | Class containing the vulnerability | -| `vulnerableMethod` | String | Method containing the vulnerability | +| `blobPath` | String | Blob path to the vulnerable file. | +| `endLine` | String | Number of the last relevant line in the vulnerable file. | +| `file` | String | Path to the vulnerable file. | +| `startLine` | String | Number of the first relevant line in the vulnerable file. | +| `vulnerableClass` | String | Class containing the vulnerability. | +| `vulnerableMethod` | String | Method containing the vulnerability. | ### VulnerabilityLocationDast @@ -4061,10 +4404,10 @@ Represents the location of a vulnerability found by a DAST scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `hostname` | String | Domain name of the vulnerable request | -| `param` | String | Query parameter for the URL on which the vulnerability occurred | -| `path` | String | URL path and query string of the vulnerable request | -| `requestMethod` | String | HTTP method of the vulnerable request | +| `hostname` | String | Domain name of the vulnerable request. | +| `param` | String | Query parameter for the URL on which the vulnerability occurred. | +| `path` | String | URL path and query string of the vulnerable request. | +| `requestMethod` | String | HTTP method of the vulnerable request. | ### VulnerabilityLocationDependencyScanning @@ -4072,8 +4415,9 @@ Represents the location of a vulnerability found by a dependency security scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `dependency` | VulnerableDependency | Dependency containing the vulnerability | -| `file` | String | Path to the vulnerable file | +| `blobPath` | String | Blob path to the vulnerable file. | +| `dependency` | VulnerableDependency | Dependency containing the vulnerability. | +| `file` | String | Path to the vulnerable file. | ### VulnerabilityLocationSast @@ -4081,11 +4425,12 @@ Represents the location of a vulnerability found by a SAST scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `endLine` | String | Number of the last relevant line in the vulnerable file | -| `file` | String | Path to the vulnerable file | -| `startLine` | String | Number of the first relevant line in the vulnerable file | -| `vulnerableClass` | String | Class containing the vulnerability | -| `vulnerableMethod` | String | Method containing the vulnerability | +| `blobPath` | String | Blob path to the vulnerable file. | +| `endLine` | String | Number of the last relevant line in the vulnerable file. | +| `file` | String | Path to the vulnerable file. | +| `startLine` | String | Number of the first relevant line in the vulnerable file. | +| `vulnerableClass` | String | Class containing the vulnerability. | +| `vulnerableMethod` | String | Method containing the vulnerability. | ### VulnerabilityLocationSecretDetection @@ -4093,11 +4438,12 @@ Represents the location of a vulnerability found by a secret detection scan. | Field | Type | Description | | ----- | ---- | ----------- | -| `endLine` | String | Number of the last relevant line in the vulnerable file | -| `file` | String | Path to the vulnerable file | -| `startLine` | String | Number of the first relevant line in the vulnerable file | -| `vulnerableClass` | String | Class containing the vulnerability | -| `vulnerableMethod` | String | Method containing the vulnerability | +| `blobPath` | String | Blob path to the vulnerable file. | +| `endLine` | String | Number of the last relevant line in the vulnerable file. | +| `file` | String | Path to the vulnerable file. | +| `startLine` | String | Number of the first relevant line in the vulnerable file. | +| `vulnerableClass` | String | Class containing the vulnerability. | +| `vulnerableMethod` | String | Method containing the vulnerability. | ### VulnerabilityPermissions @@ -4141,10 +4487,10 @@ Represents a vulnerability scanner. | Field | Type | Description | | ----- | ---- | ----------- | -| `externalId` | String | External ID of the vulnerability scanner | -| `name` | String | Name of the vulnerability scanner | -| `reportType` | VulnerabilityReportType | Type of the vulnerability report | -| `vendor` | String | Vendor of the vulnerability scanner | +| `externalId` | String | External ID of the vulnerability scanner. | +| `name` | String | Name of the vulnerability scanner. | +| `reportType` | VulnerabilityReportType | Type of the vulnerability report. | +| `vendor` | String | Vendor of the vulnerability scanner. | ### VulnerabilitySeveritiesCount @@ -4165,8 +4511,8 @@ Represents a vulnerable dependency. Used in vulnerability location data. | Field | Type | Description | | ----- | ---- | ----------- | -| `package` | VulnerablePackage | The package associated with the vulnerable dependency | -| `version` | String | The version of the vulnerable dependency | +| `package` | VulnerablePackage | The package associated with the vulnerable dependency. | +| `version` | String | The version of the vulnerable dependency. | ### VulnerablePackage @@ -4174,7 +4520,7 @@ Represents a vulnerable package. Used in vulnerability dependency data. | Field | Type | Description | | ----- | ---- | ----------- | -| `name` | String | The name of the vulnerable package | +| `name` | String | The name of the vulnerable package. | ### VulnerableProjectsByGrade @@ -4182,9 +4528,9 @@ Represents vulnerability letter grades with associated projects. | Field | Type | Description | | ----- | ---- | ----------- | -| `count` | Int! | Number of projects within this grade | -| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present | -| `projects` | ProjectConnection! | Projects within this grade | +| `count` | Int! | Number of projects within this grade. | +| `grade` | VulnerabilityGrade! | Grade based on the highest severity vulnerability present. | +| `projects` | ProjectConnection! | Projects within this grade. | ## Enumeration types @@ -4306,6 +4652,15 @@ Alert status values. | `RESOLVED` | Resolved status | | `TRIGGERED` | Triggered status | +### ApiFuzzingScanMode + +All possible ways to specify the API surface for an API fuzzing scan. + +| Value | Description | +| ----- | ----------- | +| `HAR` | The API surface is specified by a HAR file. | +| `OPENAPI` | The API surface is specified by a OPENAPI file. | + ### AvailabilityEnum User availability status. @@ -4394,6 +4749,23 @@ Status of the tags cleanup of a container repository. | `UNFINISHED` | The tags cleanup has been partially executed. There are still remaining tags to delete. | | `UNSCHEDULED` | The tags cleanup is not scheduled. This is the default state. | +### ContainerRepositorySort + +Values for sorting container repositories. + +| Value | Description | +| ----- | ----------- | +| `CREATED_ASC` | Created at ascending order | +| `CREATED_DESC` | Created at descending order | +| `NAME_ASC` | Name by ascending order | +| `NAME_DESC` | Name by descending order | +| `UPDATED_ASC` | Updated at ascending order | +| `UPDATED_DESC` | Updated at descending order | +| `created_asc` **{warning-solid}** | **Deprecated:** Use CREATED_ASC. Deprecated in 13.5. | +| `created_desc` **{warning-solid}** | **Deprecated:** Use CREATED_DESC. Deprecated in 13.5. | +| `updated_asc` **{warning-solid}** | **Deprecated:** Use UPDATED_ASC. Deprecated in 13.5. | +| `updated_desc` **{warning-solid}** | **Deprecated:** Use UPDATED_DESC. Deprecated in 13.5. | + ### ContainerRepositoryStatus Status of a container repository. @@ -4536,6 +4908,26 @@ Epic ID wildcard values. | `ANY` | Any epic is assigned | | `NONE` | No epic is assigned | +### EventAction + +Event action. + +| Value | Description | +| ----- | ----------- | +| `APPROVED` | Approved action | +| `ARCHIVED` | Archived action | +| `CLOSED` | Closed action | +| `COMMENTED` | Commented action | +| `CREATED` | Created action | +| `DESTROYED` | Destroyed action | +| `EXPIRED` | Expired action | +| `JOINED` | Joined action | +| `LEFT` | Left action | +| `MERGED` | Merged action | +| `PUSHED` | Pushed action | +| `REOPENED` | Reopened action | +| `UPDATED` | Updated action | + ### GroupMemberRelation Group member relation. @@ -4722,6 +5114,15 @@ Possible identifier types for a measurement. | `PROJECTS` | Project count | | `USERS` | User count | +### MergeRequestNewState + +New state to apply to a merge request.. + +| Value | Description | +| ----- | ----------- | +| `CLOSED` | Close the merge request if it is open. | +| `OPEN` | Open the merge request if it is closed. | + ### MergeRequestSort Values for sorting merge requests. @@ -4754,15 +5155,17 @@ State of a GitLab merge request. | `all` | | | `closed` | | | `locked` | | -| `merged` | | +| `merged` | Merge Request has been merged | | `opened` | | ### MilestoneStateEnum +Current state of milestone. + | Value | Description | | ----- | ----------- | -| `active` | | -| `closed` | | +| `active` | Milestone is currently active | +| `closed` | Milestone is closed | ### MoveType @@ -4812,9 +5215,10 @@ Rotation length unit of an on-call rotation. | `GENERIC` | Packages from the Generic package manager | | `GOLANG` | Packages from the Golang package manager | | `MAVEN` | Packages from the Maven package manager | -| `NPM` | Packages from the NPM package manager | +| `NPM` | Packages from the npm package manager | | `NUGET` | Packages from the Nuget package manager | | `PYPI` | Packages from the PyPI package manager | +| `RUBYGEMS` | Packages from the Rubygems package manager | ### PipelineConfigSourceEnum @@ -4822,6 +5226,7 @@ Rotation length unit of an on-call rotation. | ----- | ----------- | | `AUTO_DEVOPS_SOURCE` | | | `BRIDGE_SOURCE` | | +| `COMPLIANCE_SOURCE` | | | `EXTERNAL_PROJECT_SOURCE` | | | `PARAMETER_SOURCE` | | | `REMOTE_SOURCE` | | @@ -4949,42 +5354,42 @@ State of a Sentry error. | Value | Description | | ----- | ----------- | -| `ASANA_SERVICE` | | -| `ASSEMBLA_SERVICE` | | -| `BAMBOO_SERVICE` | | -| `BUGZILLA_SERVICE` | | -| `BUILDKITE_SERVICE` | | -| `CAMPFIRE_SERVICE` | | -| `CONFLUENCE_SERVICE` | | -| `CUSTOM_ISSUE_TRACKER_SERVICE` | | -| `DATADOG_SERVICE` | | -| `DISCORD_SERVICE` | | -| `DRONE_CI_SERVICE` | | -| `EMAILS_ON_PUSH_SERVICE` | | -| `EWM_SERVICE` | | -| `EXTERNAL_WIKI_SERVICE` | | -| `FLOWDOCK_SERVICE` | | -| `GITHUB_SERVICE` | | -| `HANGOUTS_CHAT_SERVICE` | | -| `HIPCHAT_SERVICE` | | -| `IRKER_SERVICE` | | -| `JENKINS_SERVICE` | | -| `JIRA_SERVICE` | | -| `MATTERMOST_SERVICE` | | -| `MATTERMOST_SLASH_COMMANDS_SERVICE` | | -| `MICROSOFT_TEAMS_SERVICE` | | -| `PACKAGIST_SERVICE` | | -| `PIPELINES_EMAIL_SERVICE` | | -| `PIVOTALTRACKER_SERVICE` | | -| `PROMETHEUS_SERVICE` | | -| `PUSHOVER_SERVICE` | | -| `REDMINE_SERVICE` | | -| `SLACK_SERVICE` | | -| `SLACK_SLASH_COMMANDS_SERVICE` | | -| `TEAMCITY_SERVICE` | | -| `UNIFY_CIRCUIT_SERVICE` | | -| `WEBEX_TEAMS_SERVICE` | | -| `YOUTRACK_SERVICE` | | +| `ASANA_SERVICE` | AsanaService type | +| `ASSEMBLA_SERVICE` | AssemblaService type | +| `BAMBOO_SERVICE` | BambooService type | +| `BUGZILLA_SERVICE` | BugzillaService type | +| `BUILDKITE_SERVICE` | BuildkiteService type | +| `CAMPFIRE_SERVICE` | CampfireService type | +| `CONFLUENCE_SERVICE` | ConfluenceService type | +| `CUSTOM_ISSUE_TRACKER_SERVICE` | CustomIssueTrackerService type | +| `DATADOG_SERVICE` | DatadogService type | +| `DISCORD_SERVICE` | DiscordService type | +| `DRONE_CI_SERVICE` | DroneCiService type | +| `EMAILS_ON_PUSH_SERVICE` | EmailsOnPushService type | +| `EWM_SERVICE` | EwmService type | +| `EXTERNAL_WIKI_SERVICE` | ExternalWikiService type | +| `FLOWDOCK_SERVICE` | FlowdockService type | +| `GITHUB_SERVICE` | GithubService type | +| `HANGOUTS_CHAT_SERVICE` | HangoutsChatService type | +| `HIPCHAT_SERVICE` | HipchatService type | +| `IRKER_SERVICE` | IrkerService type | +| `JENKINS_SERVICE` | JenkinsService type | +| `JIRA_SERVICE` | JiraService type | +| `MATTERMOST_SERVICE` | MattermostService type | +| `MATTERMOST_SLASH_COMMANDS_SERVICE` | MattermostSlashCommandsService type | +| `MICROSOFT_TEAMS_SERVICE` | MicrosoftTeamsService type | +| `PACKAGIST_SERVICE` | PackagistService type | +| `PIPELINES_EMAIL_SERVICE` | PipelinesEmailService type | +| `PIVOTALTRACKER_SERVICE` | PivotaltrackerService type | +| `PROMETHEUS_SERVICE` | PrometheusService type | +| `PUSHOVER_SERVICE` | PushoverService type | +| `REDMINE_SERVICE` | RedmineService type | +| `SLACK_SERVICE` | SlackService type | +| `SLACK_SLASH_COMMANDS_SERVICE` | SlackSlashCommandsService type | +| `TEAMCITY_SERVICE` | TeamcityService type | +| `UNIFY_CIRCUIT_SERVICE` | UnifyCircuitService type | +| `WEBEX_TEAMS_SERVICE` | WebexTeamsService type | +| `YOUTRACK_SERVICE` | YoutrackService type | ### SnippetBlobActionEnum diff --git a/doc/api/graphql/removed_items.md b/doc/api/graphql/removed_items.md index f05b23495bb..2761c1a1c84 100644 --- a/doc/api/graphql/removed_items.md +++ b/doc/api/graphql/removed_items.md @@ -1,3 +1,9 @@ +--- +stage: Plan +group: Product Planning +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + # GraphQL API removed items GraphQL is a versionless API, unlike the REST API. diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index 7698fa9ba5f..e3fcaa3db37 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -12,11 +12,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w Badges support placeholders that are replaced in real time in both the link and image URL. The allowed placeholders are: +<!-- vale gitlab.Spelling = NO --> + - **%{project_path}**: replaced by the project path. - **%{project_id}**: replaced by the project ID. - **%{default_branch}**: replaced by the project default branch. - **%{commit_sha}**: replaced by the last project's commit SHA. +<!-- vale gitlab.Spelling = YES --> + Because these endpoints aren't inside a project's context, the information used to replace the placeholders comes from the first group's project by creation date. If the group hasn't got any project the original URL with the placeholders is returned. diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md index 722f3a76267..16ab81af1fe 100644 --- a/doc/api/group_boards.md +++ b/doc/api/group_boards.md @@ -76,7 +76,7 @@ Example response: ] ``` -Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) see +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) see different parameters, due to the ability to have multiple group boards. Example response: @@ -192,7 +192,7 @@ Example response: } ``` -Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) see +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) see different parameters, due to the ability to have multiple group issue boards. Example response: @@ -526,7 +526,7 @@ Example response: ## Delete a group issue board list -Only for admins and group owners. Deletes the board list in question. +Only for administrators and group owners. Deletes the board list in question. ```plaintext DELETE /groups/:id/boards/:board_id/lists/:list_id diff --git a/doc/api/group_clusters.md b/doc/api/group_clusters.md index f169c1829be..69b54591d0a 100644 --- a/doc/api/group_clusters.md +++ b/doc/api/group_clusters.md @@ -4,7 +4,7 @@ group: Configure info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Group clusters API +# Group clusters API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30213) in GitLab 12.1. diff --git a/doc/api/group_import_export.md b/doc/api/group_import_export.md index 57670eff1ea..79338df4f7a 100644 --- a/doc/api/group_import_export.md +++ b/doc/api/group_import_export.md @@ -19,7 +19,8 @@ Group exports include the following: - Group labels - Group badges - Group members -- Sub-groups. Each sub-group includes all data above +- Subgroups. Each subgroup includes all data above +- Group wikis **(PREMIUM SELF)** ## Schedule new export @@ -94,7 +95,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "name=i NOTE: The maximum import file size can be set by the Administrator, default is `0` (unlimited). -As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the [Application settings API](settings.md#change-application-settings) or the [Admin UI](../user/admin_area/settings/account_and_limit_settings.md). +As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the [Application settings API](settings.md#change-application-settings) or the [Admin Area](../user/admin_area/settings/account_and_limit_settings.md). Default [modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50MB to 0 in GitLab 13.8. ## Important notes diff --git a/doc/api/group_iterations.md b/doc/api/group_iterations.md index d96f0881088..3d72e035383 100644 --- a/doc/api/group_iterations.md +++ b/doc/api/group_iterations.md @@ -4,9 +4,10 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Group iterations API **(STARTER)** +# Group iterations API **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.5. +> - Moved to GitLab Premium in 13.9. This page describes the group iterations API. There's a separate [project iterations API](iterations.md) page. @@ -49,7 +50,8 @@ Example response: "created_at": "2020-01-27T05:07:12.573Z", "updated_at": "2020-01-27T05:07:12.573Z", "due_date": "2020-02-01", - "start_date": "2020-02-14" + "start_date": "2020-02-14", + "web_url": "http://gitlab.example.com/groups/my-group/-/iterations/13" } ] ``` diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index 2c56b2c501d..cf542a9da0b 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -159,9 +159,10 @@ Parameters: | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `milestone_id` | integer | yes | The ID of a group milestone | -## Get all burndown chart events for a single milestone **(STARTER)** +## Get all burndown chart events for a single milestone **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1 +> - Moved to GitLab Premium in 13.9. Get all burndown chart events for a single milestone. diff --git a/doc/api/group_repository_storage_moves.md b/doc/api/group_repository_storage_moves.md new file mode 100644 index 00000000000..8a19a43d31f --- /dev/null +++ b/doc/api/group_repository_storage_moves.md @@ -0,0 +1,254 @@ +--- +stage: Create +group: Editor +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +type: reference +--- + +# Group repository storage moves API **(PREMIUM SELF)** + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/53016) in GitLab 13.9. + +Group repositories can be moved between storages. This can be useful when +[migrating to Gitaly Cluster](../administration/gitaly/praefect.md#migrate-existing-repositories-to-gitaly-cluster), +for example, or to migrate a Group Wiki. + +As group repository storage moves are processed, they transition through different states. Values +of `state` are: + +- `initial` +- `scheduled` +- `started` +- `finished` +- `failed` +- `replicated` +- `cleanup failed` + +To ensure data integrity, groups are put in a temporary read-only state for the +duration of the move. During this time, users receive a `The repository is temporarily +read-only. Please try again later.` message if they try to push new commits. + +This API requires you to [authenticate yourself](README.md#authentication) as an administrator. + +For other type of repositories you can read: + +- [Project repository storage moves API](project_repository_storage_moves.md) +- [Snippet repository storage moves API](snippet_repository_storage_moves.md) + +## Retrieve all group repository storage moves + +```plaintext +GET /group_repository_storage_moves +``` + +By default, `GET` requests return 20 results at a time because the API results +are [paginated](README.md#pagination). + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/group_repository_storage_moves" +``` + +Example response: + +```json +[ + { + "id": 1, + "created_at": "2020-05-07T04:27:17.234Z", + "state": "scheduled", + "source_storage_name": "default", + "destination_storage_name": "storage2", + "group": { + "id": 283, + "web_url": "https://gitlab.example.com/groups/testgroup", + "name": "testgroup" + } + } +] +``` + +## Retrieve all repository storage moves for a single group + +In order to retrieve all the repository storage moves for a single group you can use the following endpoint: + +```plaintext +GET /groups/:group_id/repository_storage_moves +``` + +By default, `GET` requests return 20 results at a time because the API results +are [paginated](README.md#pagination). + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `group_id` | integer | yes | ID of the group. | + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/repository_storage_moves" +``` + +Example response: + +```json +[ + { + "id": 1, + "created_at": "2020-05-07T04:27:17.234Z", + "state": "scheduled", + "source_storage_name": "default", + "destination_storage_name": "storage2", + "group": { + "id": 283, + "web_url": "https://gitlab.example.com/groups/testgroup", + "name": "testgroup" + } + } +] +``` + +## Get a single group repository storage move + +In order to retrieve a single repository storage move throughout all the existing repository storage moves, you can use the following endpoint: + +```plaintext +GET /group_repository_storage_moves/:repository_storage_id +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `repository_storage_id` | integer | yes | ID of the group repository storage move. | + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/group_repository_storage_moves/1" +``` + +Example response: + +```json +{ + "id": 1, + "created_at": "2020-05-07T04:27:17.234Z", + "state": "scheduled", + "source_storage_name": "default", + "destination_storage_name": "storage2", + "group": { + "id": 283, + "web_url": "https://gitlab.example.com/groups/testgroup", + "name": "testgroup" + } +} +``` + +## Get a single repository storage move for a group + +Given a group, you can retrieve a specific repository storage move for that group, through the following endpoint: + +```plaintext +GET /groups/:group_id/repository_storage_moves/:repository_storage_id +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `group_id` | integer | yes | ID of the group. | +| `repository_storage_id` | integer | yes | ID of the group repository storage move. | + +Example request: + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/repository_storage_moves/1" +``` + +Example response: + +```json +{ + "id": 1, + "created_at": "2020-05-07T04:27:17.234Z", + "state": "scheduled", + "source_storage_name": "default", + "destination_storage_name": "storage2", + "group": { + "id": 283, + "web_url": "https://gitlab.example.com/groups/testgroup", + "name": "testgroup" + } +} +``` + +## Schedule a repository storage move for a group + +```plaintext +POST /groups/:group_id/repository_storage_moves +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `group_id` | integer | yes | ID of the group. | +| `destination_storage_name` | string | no | Name of the destination storage shard. In [GitLab 13.5 and later](https://gitlab.com/gitlab-org/gitaly/-/issues/3209), the storage is selected automatically if not provided. | + +Example request: + +```shell +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \ +--data '{"destination_storage_name":"storage2"}' "https://gitlab.example.com/api/v4/groups/1/repository_storage_moves" +``` + +Example response: + +```json +{ + "id": 1, + "created_at": "2020-05-07T04:27:17.234Z", + "state": "scheduled", + "source_storage_name": "default", + "destination_storage_name": "storage2", + "group": { + "id": 283, + "web_url": "https://gitlab.example.com/groups/testgroup", + "name": "testgroup" + } +} +``` + +## Schedule repository storage moves for all groups on a storage shard + +Schedules repository storage moves for each group repository stored on the source storage shard. + +```plaintext +POST /group_repository_storage_moves +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| --------- | ---- | -------- | ----------- | +| `source_storage_name` | string | yes | Name of the source storage shard. | +| `destination_storage_name` | string | no | Name of the destination storage shard. The storage is selected automatically if not provided. | + +Example request: + +```shell +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" \ +--data '{"source_storage_name":"default"}' "https://gitlab.example.com/api/v4/group_repository_storage_moves" +``` + +Example response: + +```json +{ + "message": "202 Accepted" +} +``` diff --git a/doc/api/group_wikis.md b/doc/api/group_wikis.md index f8804d1eadc..6c5e2b77f93 100644 --- a/doc/api/group_wikis.md +++ b/doc/api/group_wikis.md @@ -1,6 +1,6 @@ --- stage: Create -group: Knowledge +group: Editor info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments" type: reference, api --- @@ -179,9 +179,9 @@ POST /groups/:id/wikis/attachments | `file` | string | yes | The attachment to be uploaded | | `branch` | string | no | The name of the branch. Defaults to the wiki repository default branch | -To upload a file from your filesystem, use the `--form` argument. This causes +To upload a file from your file system, use the `--form` argument. This causes cURL to post data using the header `Content-Type: multipart/form-data`. -The `file=` parameter must point to a file on your filesystem and be preceded +The `file=` parameter must point to a file on your file system and be preceded by `@`. For example: ```shell diff --git a/doc/api/groups.md b/doc/api/groups.md index eb255f8de00..6031d780436 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -18,12 +18,12 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------ | ----------------- | -------- | ---------- | | `skip_groups` | array of integers | no | Skip the group IDs passed | -| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin); Attributes `owned` and `min_access_level` have precedence | +| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for administrators); Attributes `owned` and `min_access_level` have precedence | | `search` | string | no | Return the list of authorized groups matching the search criteria | | `order_by` | string | no | Order groups by `name`, `path` or `id`. Default is `name` | | `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | -| `statistics` | boolean | no | Include group statistics (admins only) | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | +| `statistics` | boolean | no | Include group statistics (administrators only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) | | `owned` | boolean | no | Limit to groups explicitly owned by the current user | | `min_access_level` | integer | no | Limit to groups where current user has at least this [access level](members.md#valid-access-levels) | | `top_level_only` | boolean | no | Limit to top level groups, excluding all subgroups | @@ -62,7 +62,7 @@ GET /groups ] ``` -When adding the parameter `statistics=true` and the authenticated user is an admin, additional group statistics are returned. +When adding the parameter `statistics=true` and the authenticated user is an administrator, additional group statistics are returned. ```plaintext GET /groups?statistics=true @@ -130,12 +130,12 @@ Parameters: | ------------------------ | ----------------- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) of the immediate parent group | | `skip_groups` | array of integers | no | Skip the group IDs passed | -| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin); Attributes `owned` and `min_access_level` have precedence | +| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for administrators); Attributes `owned` and `min_access_level` have precedence | | `search` | string | no | Return the list of authorized groups matching the search criteria | | `order_by` | string | no | Order groups by `name`, `path` or `id`. Default is `name` | | `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | -| `statistics` | boolean | no | Include group statistics (admins only) | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | +| `statistics` | boolean | no | Include group statistics (administrators only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) | | `owned` | boolean | no | Limit to groups explicitly owned by the current user | | `min_access_level` | integer | no | Limit to groups where current user has at least this [access level](members.md#valid-access-levels) | @@ -188,12 +188,12 @@ Parameters: | ------------------------ | ----------------- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) of the immediate parent group | | `skip_groups` | array of integers | no | Skip the group IDs passed | -| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for admin). Attributes `owned` and `min_access_level` have precedence | +| `all_available` | boolean | no | Show all the groups you have access to (defaults to `false` for authenticated users, `true` for administrators). Attributes `owned` and `min_access_level` have precedence | | `search` | string | no | Return the list of authorized groups matching the search criteria | | `order_by` | string | no | Order groups by `name`, `path`, or `id`. Default is `name` | | `sort` | string | no | Order groups in `asc` or `desc` order. Default is `asc` | -| `statistics` | boolean | no | Include group statistics (admins only) | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | +| `statistics` | boolean | no | Include group statistics (administrators only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) | | `owned` | boolean | no | Limit to groups explicitly owned by the current user | | `min_access_level` | integer | no | Limit to groups where current user has at least this [access level](members.md#valid-access-levels) | @@ -284,7 +284,7 @@ Parameters: | `with_shared` | boolean | no | Include projects shared to this group. Default is `true` | | `include_subgroups` | boolean | no | Include projects in subgroups of this group. Default is `false` | | `min_access_level` | integer | no | Limit to projects where current user has at least this [access level](members.md#valid-access-levels) | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) | | `with_security_reports` | boolean | no | **(ULTIMATE)** Return only projects that have security reports artifacts present in any of their builds. This means "projects with security reports enabled". Default is `false` | 1. Order by similarity: Orders the results by a similarity score calculated from the provided `search` @@ -366,7 +366,7 @@ Parameters: | `with_issues_enabled` | boolean | no | Limit by projects with issues feature enabled. Default is `false` | | `with_merge_requests_enabled` | boolean | no | Limit by projects with merge requests feature enabled. Default is `false` | | `min_access_level` | integer | no | Limit to projects where current user has at least this [access level](members.md#valid-access-levels) | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only) | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only) | Example response: @@ -479,7 +479,7 @@ Example response: ## Details of a group Get all details of a group. This endpoint can be accessed without authentication -if the group is publicly accessible. In case the user that requests is admin of the group, it returns the `runners_token` for the group too. +if the group is publicly accessible. In case the user that requests is administrator of the group, it returns the `runners_token` for the group too. ```plaintext GET /groups/:id @@ -490,7 +490,7 @@ Parameters: | Attribute | Type | Required | Description | | ------------------------ | -------------- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (admins only). | +| `with_custom_attributes` | boolean | no | Include [custom attributes](custom_attributes.md) in response (administrators only). | | `with_projects` | boolean | no | Include details from projects that belong to the specified group (defaults to `true`). (Deprecated, [scheduled for removal in API v5](https://gitlab.com/gitlab-org/gitlab/-/issues/213797). To get the details of all projects within a group, use the [list a group's projects endpoint](#list-a-groups-projects).) | NOTE: @@ -670,7 +670,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit` and `extra_shared_runners_minutes_limit` parameters: Additional response parameters: @@ -685,7 +685,7 @@ Additional response parameters: } ``` -Users on GitLab [Silver, Premium, or higher](https://about.gitlab.com/pricing/) also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) also see the `marked_for_deletion_on` attribute: ```json @@ -764,8 +764,8 @@ Parameters: | `request_access_enabled` | boolean | no | Allow users to request member access. | | `parent_id` | integer | no | The parent group ID for creating nested group. | | `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). Default to the global level default branch protection setting. | -| `shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Pipeline minutes quota for this group (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` | -| `extra_shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Extra pipeline minutes quota for this group (purchased in addition to the minutes included in the plan). | +| `shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Pipeline minutes quota for this group (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` | +| `extra_shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Extra pipeline minutes quota for this group (purchased in addition to the minutes included in the plan). | ### Options for `default_branch_protection` @@ -838,8 +838,8 @@ PUT /groups/:id | `request_access_enabled` | boolean | no | Allow users to request member access. | | `default_branch_protection` | integer | no | See [Options for `default_branch_protection`](#options-for-default_branch_protection). | | `file_template_project_id` | integer | no | **(PREMIUM)** The ID of a project to load custom file templates from. | -| `shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Pipeline minutes quota for this group (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` | -| `extra_shared_runners_minutes_limit` | integer | no | **(STARTER ONLY)** Extra pipeline minutes quota for this group (purchased in addition to the minutes included in the plan). | +| `shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Pipeline minutes quota for this group (included in plan). Can be `nil` (default; inherit system default), `0` (unlimited) or `> 0` | +| `extra_shared_runners_minutes_limit` | integer | no | **(PREMIUM SELF)** Extra pipeline minutes quota for this group (purchased in addition to the minutes included in the plan). | | `prevent_forking_outside_group` | boolean | no | **(PREMIUM)** When enabled, users can **not** fork projects from this group to external namespaces | `shared_runners_setting` | string | no | See [Options for `shared_runners_setting`](#options-for-shared_runners_setting). Enable or disable shared runners for a group's subgroups and projects. | @@ -941,6 +941,19 @@ The `shared_runners_setting` attribute determines whether shared runners are ena | `disabled_with_override` | Disables shared runners for all projects and subgroups in this group, but allows subgroups to override this setting. | | `disabled_and_unoverridable` | Disables shared runners for all projects and subgroups in this group, and prevents subgroups from overriding this setting. | +### Upload a group avatar + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/36681) in GitLab 12.9. + +To upload an avatar file from your file system, use the `--form` argument. This causes +curl to post data using the header `Content-Type: multipart/form-data`. The +`file=` parameter must point to a file on your file system and be preceded by +`@`. For example: + +```shell +curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/22" --form "avatar=@/tmp/example.png" +``` + ## Remove group Only available to group owners and administrators. @@ -948,7 +961,7 @@ Only available to group owners and administrators. This endpoint either: - Removes group, and queues a background job to delete all projects in the group as well. -- Since [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/33257), on [Premium or Silver](https://about.gitlab.com/pricing/) or higher tiers, marks a group for deletion. The deletion happens 7 days later by default, but this can be changed in the [instance settings](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). +- Since [GitLab 12.8](https://gitlab.com/gitlab-org/gitlab/-/issues/33257), on [Premium](https://about.gitlab.com/pricing/) or higher tiers, marks a group for deletion. The deletion happens 7 days later by default, but this can be changed in the [instance settings](../user/admin_area/settings/visibility_and_access_controls.md#default-deletion-delay). ```plaintext DELETE /groups/:id @@ -997,7 +1010,7 @@ GET /groups?search=foobar ] ``` -## Hooks +## Hooks **(PREMIUM)** Also called Group Hooks and Webhooks. These are different from [System Hooks](system_hooks.md) that are system wide and [Project Hooks](projects.md#hooks) that are limited to one project. @@ -1044,6 +1057,7 @@ GET /groups/:id/hooks/:hook_id "wiki_page_events": true, "deployment_events": true, "releases_events": true, + "subgroup_events": true, "enable_ssl_verification": true, "created_at": "2012-10-12T17:04:47Z" } @@ -1073,6 +1087,7 @@ POST /groups/:id/hooks | `wiki_page_events` | boolean | no | Trigger hook on wiki events | | `deployment_events` | boolean | no | Trigger hook on deployment events | | `releases_events` | boolean | no | Trigger hook on release events | +| `subgroup_events` | boolean | no | Trigger hook on subgroup events | | `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook | | `token` | string | no | Secret token to validate received payloads; not returned in the response | @@ -1101,6 +1116,7 @@ PUT /groups/:id/hooks/:hook_id | `wiki_events` | boolean | no | Trigger hook on wiki events | | `deployment_events` | boolean | no | Trigger hook on deployment events | | `releases_events` | boolean | no | Trigger hook on release events | +| `subgroup_events` | boolean | no | Trigger hook on subgroup events | | `enable_ssl_verification` | boolean | no | Do SSL verification when triggering the hook | | `token` | string | no | Secret token to validate received payloads; not returned in the response | @@ -1122,7 +1138,7 @@ DELETE /groups/:id/hooks/:hook_id Group audit events can be accessed via the [Group Audit Events API](audit_events.md#group-audit-events) -## Sync group with LDAP **(STARTER ONLY)** +## Sync group with LDAP **(PREMIUM SELF)** Syncs the group with its linked LDAP group. Only available to group owners and administrators. @@ -1142,7 +1158,7 @@ Please consult the [Group Members](members.md) documentation. List, add, and delete LDAP group links. -### List LDAP group links **(STARTER ONLY)** +### List LDAP group links **(PREMIUM SELF)** Lists LDAP group links. @@ -1154,7 +1170,7 @@ GET /groups/:id/ldap_group_links | --------- | -------------- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) | -### Add LDAP group link with CN or filter **(STARTER ONLY)** +### Add LDAP group link with CN or filter **(PREMIUM SELF)** Adds an LDAP group link using a CN or filter. Adding a group link by filter is only supported in the Premium tier and above. @@ -1173,7 +1189,7 @@ POST /groups/:id/ldap_group_links NOTE: To define the LDAP group link, provide either a `cn` or a `filter`, but not both. -### Delete LDAP group link **(STARTER ONLY)** +### Delete LDAP group link **(PREMIUM SELF)** Deletes an LDAP group link. Deprecated. Scheduled for removal in a future release. @@ -1198,7 +1214,7 @@ DELETE /groups/:id/ldap_group_links/:provider/:cn | `cn` | string | yes | The CN of an LDAP group | | `provider` | string | yes | LDAP provider for the LDAP group link | -### Delete LDAP group link with CN or filter **(STARTER ONLY)** +### Delete LDAP group link with CN or filter **(PREMIUM SELF)** Deletes an LDAP group link using a CN or filter. Deleting by filter is only supported in the Premium tier and above. @@ -1306,7 +1322,7 @@ GET /groups/:id/push_rule } ``` -Users on GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `commit_committer_check` and `reject_unsigned_commits` parameters: ```json diff --git a/doc/api/instance_clusters.md b/doc/api/instance_clusters.md index d5c033563d6..99717ba939d 100644 --- a/doc/api/instance_clusters.md +++ b/doc/api/instance_clusters.md @@ -4,14 +4,14 @@ group: Configure info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Instance clusters API +# Instance clusters API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/36001) in GitLab 13.2. Instance-level Kubernetes clusters allow you to connect a Kubernetes cluster to the GitLab instance, which enables you to use the same cluster across multiple projects. [More information](../user/instance/clusters/index.md) NOTE: -Users need admin access to use these endpoints. +Users need administrator access to use these endpoints. ## List instance clusters diff --git a/doc/api/issue_links.md b/doc/api/issue_links.md index b94207f8e16..0d55b77df0e 100644 --- a/doc/api/issue_links.md +++ b/doc/api/issue_links.md @@ -4,9 +4,9 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Issue links API **(CORE)** +# Issue links API **(FREE)** -> The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.4. +> The simple "relates to" relationship [moved](https://gitlab.com/gitlab-org/gitlab/-/issues/212329) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.4. ## List issue relations diff --git a/doc/api/issues.md b/doc/api/issues.md index 1abb4fe3b4a..c333967b36c 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -60,8 +60,8 @@ GET /issues?state=opened | `due_date` | string | no | Return issues that have no due date, are overdue, or whose due date is this week, this month, or between two weeks ago and next month. Accepts: `0` (no due date), `overdue`, `week`, `month`, `next_month_and_previous_two_weeks`. _(Introduced in [GitLab 13.3](https://gitlab.com/gitlab-org/gitlab/-/issues/233420))_ | | `iids[]` | integer array | no | Return only the issues having the given `iid` | | `in` | string | no | Modify the scope of the `search` attribute. `title`, `description`, or a string joining them with comma. Default is `title,description` | -| `iteration_id` **(STARTER)** | integer | no | Return issues assigned to the given iteration ID. `None` returns issues that do not belong to an iteration. `Any` returns issues that belong to an iteration. Mutually exclusive with `iteration_title`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.6)_ | -| `iteration_title` **(STARTER)** | string | no | Return issues assigned to the iteration with the given title. Similar to `iteration_id` and mutually exclusive with `iteration_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.6)_ | +| `iteration_id` **(PREMIUM)** | integer | no | Return issues assigned to the given iteration ID. `None` returns issues that do not belong to an iteration. `Any` returns issues that belong to an iteration. Mutually exclusive with `iteration_title`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | +| `iteration_title` **(PREMIUM)** | string | no | Return issues assigned to the iteration with the given title. Similar to `iteration_id` and mutually exclusive with `iteration_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.6)_ | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | @@ -169,7 +169,7 @@ Example response: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -183,7 +183,7 @@ the `weight` parameter: ] ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` parameter: ```json @@ -347,7 +347,7 @@ Example response: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -361,7 +361,7 @@ the `weight` parameter: ] ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` parameter: ```json @@ -530,7 +530,7 @@ Example response: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -544,7 +544,7 @@ the `weight` parameter: ] ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` parameter: ```json @@ -684,7 +684,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -696,7 +696,7 @@ the `weight` parameter: } ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `epic` property: ```javascript @@ -833,7 +833,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -845,7 +845,7 @@ the `weight` parameter: } ``` -Users on GitLab [Premium](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium](https://about.gitlab.com/pricing/) can also see the `epic` property: ```javascript @@ -864,7 +864,7 @@ the `epic` property: } ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` property: ```json @@ -980,7 +980,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -992,7 +992,7 @@ the `weight` parameter: } ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` parameter: ```json @@ -1133,7 +1133,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -1145,7 +1145,7 @@ the `weight` parameter: } ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` parameter: ```json @@ -1298,7 +1298,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json @@ -1310,7 +1310,7 @@ the `weight` parameter: } ``` -Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` parameter: ```json @@ -1421,7 +1421,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) can also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `weight` parameter: ```json diff --git a/doc/api/iterations.md b/doc/api/iterations.md index 1ee489e4cf1..be52ef0ea47 100644 --- a/doc/api/iterations.md +++ b/doc/api/iterations.md @@ -4,9 +4,10 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Project iterations API **(STARTER)** +# Project iterations API **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/118742) in GitLab 13.5. +> - Moved to GitLab Premium in 13.9. This page describes the project iterations API. There's a separate [group iterations API](group_iterations.md) page. @@ -51,7 +52,8 @@ Example response: "created_at": "2020-01-27T05:07:12.573Z", "updated_at": "2020-01-27T05:07:12.573Z", "due_date": "2020-02-01", - "start_date": "2020-02-14" + "start_date": "2020-02-14", + "web_url": "http://gitlab.example.com/groups/my-group/-/iterations/13" } ] ``` diff --git a/doc/api/jobs.md b/doc/api/jobs.md index b7b742ebe66..18d2e5ec3df 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -54,6 +54,9 @@ Example of response {"file_type": "junit", "size": 750, "filename": "junit.xml.gz", "file_format": "gzip"} ], "artifacts_expire_at": "2016-01-23T17:54:27.895Z", + "tag_list": [ + "docker runner", "ubuntu18" + ], "id": 7, "name": "teaspoon", "pipeline": { @@ -104,6 +107,9 @@ Example of response "finished_at": "2015-12-24T17:54:24.921Z", "duration": 0.192, "artifacts_expire_at": "2016-01-23T17:54:24.921Z", + "tag_list": [ + "docker runner", "win10-2004" + ], "id": 6, "name": "rspec:other", "pipeline": { @@ -148,11 +154,12 @@ Get a list of jobs for a pipeline. GET /projects/:id/pipelines/:pipeline_id/jobs ``` -| Attribute | Type | Required | Description | -|---------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `pipeline_id` | integer | yes | ID of a pipeline. | -| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. | +| Attribute | Type | Required | Description | +|-------------------|--------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `id` | integer/string | yes | ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `pipeline_id` | integer | yes | ID of a pipeline. | +| `scope` | string **or** array of strings | no | Scope of jobs to show. Either one of or an array of the following: `created`, `pending`, `running`, `failed`, `success`, `canceled`, `skipped`, or `manual`. All jobs are returned if `scope` is not provided. | +| `include_retried` | boolean | no | Include retried jobs in the response. Defaults to `false`. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/272627) in GitLab 13.9. | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipelines/6/jobs?scope[]=pending&scope[]=running" @@ -179,6 +186,9 @@ Example of response "finished_at": "2015-12-24T17:54:24.921Z", "duration": 0.192, "artifacts_expire_at": "2016-01-23T17:54:24.921Z", + "tag_list": [ + "docker runner", "ubuntu18" + ], "id": 6, "name": "rspec:other", "pipeline": { @@ -239,6 +249,9 @@ Example of response {"file_type": "junit", "size": 750, "filename": "junit.xml.gz", "file_format": "gzip"} ], "artifacts_expire_at": "2016-01-23T17:54:27.895Z", + "tag_list": [ + "docker runner", "ubuntu18" + ], "id": 7, "name": "teaspoon", "pipeline": { @@ -248,7 +261,6 @@ Example of response "status": "pending" }, "ref": "master", - "artifacts": [], "runner": null, "stage": "test", "status": "failed", @@ -278,6 +290,12 @@ Example of response In GitLab 13.3 and later, this endpoint [returns data for any pipeline](pipelines.md#single-pipeline-requests) including [child pipelines](../ci/parent_child_pipelines.md). +In GitLab 13.5 and later, this endpoint does not return retried jobs in the response +by default. + +In GitLab 13.9 and later, this endpoint can include retried jobs in the response +with `include_retried` set to `true`. + ## List pipeline bridges Get a list of bridge jobs for a pipeline. @@ -399,6 +417,9 @@ Example of response "finished_at": "2015-12-24T17:54:31.198Z", "duration": 0.465, "artifacts_expire_at": "2016-01-23T17:54:31.198Z", + "tag_list": [ + "docker runner", "macos-10.15" + ], "id": 8, "name": "rubocop", "pipeline": { diff --git a/doc/api/keys.md b/doc/api/keys.md index dccea1f0e0a..98159bcf027 100644 --- a/doc/api/keys.md +++ b/doc/api/keys.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Keys API +# Keys API **(FREE)** ## Get SSH key with user by ID of an SSH key diff --git a/doc/api/license.md b/doc/api/license.md index 9aaf68d5b89..7aa00335933 100644 --- a/doc/api/license.md +++ b/doc/api/license.md @@ -4,7 +4,7 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# License **(CORE ONLY)** +# License **(FREE SELF)** To interact with license endpoints, you need to authenticate yourself as an administrator. diff --git a/doc/api/license_templates.md b/doc/api/license_templates.md deleted file mode 100644 index 7587721968b..00000000000 --- a/doc/api/license_templates.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -redirect_to: 'templates/licenses.md' ---- - -This document was moved to [another location](templates/licenses.md). - -<!-- This redirect file can be deleted after February 1, 2021. --> -<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/lint.md b/doc/api/lint.md index 48a7be13a28..867a5e54663 100644 --- a/doc/api/lint.md +++ b/doc/api/lint.md @@ -13,6 +13,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w Checks if CI/CD YAML configuration is valid. This endpoint validates basic CI/CD configuration syntax. It doesn't have any namespace specific context. +Access to this endpoint requires authentication. + ```plaintext POST /ci/lint ``` @@ -23,7 +25,7 @@ POST /ci/lint | `include_merged_yaml` | boolean | no | If the [expanded CI/CD configuration](#yaml-expansion) should be included in the response. | ```shell -curl --header "Content-Type: application/json" "https://gitlab.example.com/api/v4/ci/lint" --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}' +curl --header "Content-Type: application/json" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/ci/lint" --data '{"content": "{ \"image\": \"ruby:2.6\", \"services\": [\"postgres\"], \"before_script\": [\"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}' ``` Be sure to paste the exact contents of your GitLab CI/CD YAML configuration because YAML diff --git a/doc/api/markdown.md b/doc/api/markdown.md index c7908f02b6e..157714c2791 100644 --- a/doc/api/markdown.md +++ b/doc/api/markdown.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Markdown API +# Markdown API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18926) in GitLab 11.0. diff --git a/doc/api/members.md b/doc/api/members.md index 47b686d9275..bf2bf8c1220 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -284,6 +284,7 @@ Example response: "state": "active", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "web_url": "http://192.168.1.8:3000/root", + "last_activity_on": "2021-01-27" }, { "id": 2, @@ -292,7 +293,8 @@ Example response: "state": "active", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", "web_url": "http://192.168.1.8:3000/root", - "email": "john@example.com" + "email": "john@example.com", + "last_activity_on": "2021-01-25" }, { "id": 3, @@ -300,7 +302,8 @@ Example response: "name": "Foo bar", "state": "active", "avatar_url": "https://www.gravatar.com/avatar/c2525a7f58ae3776070e44c106c48e15?s=80&d=identicon", - "web_url": "http://192.168.1.8:3000/root" + "web_url": "http://192.168.1.8:3000/root", + "last_activity_on": "2021-01-20" } ] ``` @@ -319,7 +322,7 @@ POST /projects/:id/members | `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user | | `user_id` | integer/string | yes | The user ID of the new member or multiple IDs separated by commas | | `access_level` | integer | yes | A valid access level | -| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY | +| `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "user_id=1&access_level=30" "https://gitlab.example.com/api/v4/groups/:id/members" @@ -357,7 +360,7 @@ PUT /projects/:id/members/:user_id | `id` | integer/string | yes | The ID or [URL-encoded path of the project or group](README.md#namespaced-path-encoding) owned by the authenticated user | | `user_id` | integer | yes | The user ID of the member | | `access_level` | integer | yes | A valid access level | -| `expires_at` | string | no | A date string in the format YEAR-MONTH-DAY | +| `expires_at` | string | no | A date string in the format `YEAR-MONTH-DAY` | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/members/:user_id?access_level=40" diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md index e3ebb61768e..5b8bad1d685 100644 --- a/doc/api/merge_request_approvals.md +++ b/doc/api/merge_request_approvals.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Merge request approvals API **(STARTER)** +# Merge request approvals API **(PREMIUM)** Configuration for approvals on all Merge Requests (MR) in the project. Must be authenticated for all endpoints. @@ -13,7 +13,8 @@ Configuration for approvals on all Merge Requests (MR) in the project. Must be a ### Get Configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6. +> - Moved to GitLab Premium in 13.9. You can request information about a project's approval configuration using the following endpoint: @@ -41,7 +42,8 @@ GET /projects/:id/approvals ### Change configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6. +> - Moved to GitLab Premium in 13.9. If you are allowed to, you can change approval configuration using the following endpoint: @@ -75,7 +77,8 @@ POST /projects/:id/approvals ### Get project-level rules -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. > - `protected_branches` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/460) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.7. You can request information about a project's approval rules using the following endpoint: @@ -273,7 +276,8 @@ GET /projects/:id/approval_rules/:approval_rule_id ### Create project-level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can create project approval rules using the following endpoint: @@ -375,7 +379,8 @@ POST /projects/:id/approval_rules ### Update project-level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can update project approval rules using the following endpoint: @@ -480,7 +485,8 @@ PUT /projects/:id/approval_rules/:approval_rule_id ### Delete project-level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can delete project approval rules using the following endpoint: @@ -497,7 +503,8 @@ DELETE /projects/:id/approval_rules/:approval_rule_id ### Change allowed approvers -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6. +> - Moved to GitLab Premium in 13.9. NOTE: This API endpoint has been deprecated. Please use Approval Rule API instead. @@ -566,7 +573,8 @@ Configuration for approvals on a specific Merge Request. Must be authenticated f ### Get Configuration -> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 8.9. +> - Introduced in GitLab 8.9. +> - Moved to GitLab Premium in 13.9. You can request information about a merge request's approval status using the following endpoint: @@ -612,7 +620,8 @@ GET /projects/:id/merge_requests/:merge_request_iid/approvals ### Change approval configuration -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6. +> - Moved to GitLab Premium in 13.9. If you are allowed to, you can change `approvals_required` using the following endpoint: @@ -648,7 +657,8 @@ POST /projects/:id/merge_requests/:merge_request_iid/approvals ### Change allowed approvers for Merge Request -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in [GitLab Starter](https://about.gitlab.com/pricing/) 10.6. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/183) in GitLab 10.6. +> - Moved to GitLab Premium in 13.9. NOTE: This API endpoint has been deprecated. Please use Approval Rule API instead. @@ -722,7 +732,8 @@ PUT /projects/:id/merge_requests/:merge_request_iid/approvers ### Get the approval state of merge requests -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13712) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13712) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can request information about a merge request's approval state by using the following endpoint: @@ -794,7 +805,8 @@ This includes additional information about the users who have already approved ### Get merge request level rules -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13712) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/13712) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can request information about a merge request's approval rules using the following endpoint: @@ -871,7 +883,8 @@ GET /projects/:id/merge_requests/:merge_request_iid/approval_rules ### Create merge request level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can create merge request approval rules using the following endpoint: @@ -955,7 +968,8 @@ will be used. ### Update merge request level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can update merge request approval rules using the following endpoint: @@ -1040,7 +1054,8 @@ These are system generated rules. ### Delete merge request level rule -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/11877) in GitLab 12.3. +> - Moved to GitLab Premium in 13.9. You can delete merge request approval rules using the following endpoint: @@ -1061,7 +1076,8 @@ These are system generated rules. ## Approve Merge Request -> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 8.9. +> - Introduced in GitLab 8.9. +> - Moved to GitLab Premium in 13.9. If you are allowed to, you can approve a merge request using the following endpoint: @@ -1077,7 +1093,7 @@ POST /projects/:id/merge_requests/:merge_request_iid/approve | `id` | integer | yes | The ID of a project | | `merge_request_iid` | integer | yes | The IID of MR | | `sha` | string | no | The HEAD of the MR | -| `approval_password` **(STARTER)** | string | no | Current user's password. Required if [**Require user password to approve**](../user/project/merge_requests/merge_request_approvals.md#require-authentication-when-approving-a-merge-request) is enabled in the project settings. | +| `approval_password` **(PREMIUM)** | string | no | Current user's password. Required if [**Require user password to approve**](../user/project/merge_requests/merge_request_approvals.md#require-authentication-when-approving-a-merge-request) is enabled in the project settings. | The `sha` parameter works in the same way as when [accepting a merge request](merge_requests.md#accept-mr): if it is passed, then it must @@ -1124,7 +1140,8 @@ does not match, the response code will be `409`. ## Unapprove Merge Request ->Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 9.0. +> - Introduced in GitLab 9.0. +> - Moved to GitLab Premium in 13.9. If you did approve a merge request, you can unapprove it using the following endpoint: diff --git a/doc/api/merge_request_context_commits.md b/doc/api/merge_request_context_commits.md index 3873cb00033..0b4b96b889b 100644 --- a/doc/api/merge_request_context_commits.md +++ b/doc/api/merge_request_context_commits.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Merge request context commits API +# Merge request context commits API **(FREE)** ## List MR context commits diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index c43ac96a42f..d9bcba96fdc 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Merge requests API +# Merge requests API **(FREE)** > - `author_id`, `author_username`, and `assignee_id` were [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5. > - `my_reaction_emoji` was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0. @@ -15,6 +15,7 @@ type: reference, api > - `reference` was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) in GitLab 12.10 in favour of `references`. > - `with_merge_status_recheck` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31890) in GitLab 13.0. > - `reviewer_username` and `reviewer_id` were [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49341) in GitLab 13.8. +> - `reviewer_ids` was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/51186) in GitLab 13.8. Every API call to merge requests must be authenticated. @@ -30,7 +31,7 @@ If you need the value of these fields from this endpoint, set the `with_merge_st `true` in the query. - `references.relative` is relative to the group or project that the merge request is being requested. When the merge request is fetched from its project, `relative` format would be the same as `short` format, and when requested across groups or projects, it is expected to be the same as `full` format. -- If `approvals_before_merge` **(STARTER)** is not provided, it inherits the value from the target project. If provided, the following conditions must hold for it to take effect: +- If `approvals_before_merge` is not provided, it inherits the value from the target project. If provided, the following conditions must hold for it to take effect: - The target project's `approvals_before_merge` must be greater than zero. A value of zero disables approvals for that project. @@ -91,8 +92,8 @@ Parameters: | `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. | | `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. | | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. | -| `approver_ids` **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | -| `approved_by_ids` **(STARTER)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | +| `approver_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | +| `approved_by_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | | `reviewer_id` | integer | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`. | | `reviewer_username` | string | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. | | `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. | @@ -216,7 +217,7 @@ Parameters: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium or higher also see the `approvals_before_merge` parameter: ```json @@ -277,8 +278,8 @@ Parameters: | `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. | | `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`.| | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. | -| `approver_ids` **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | -| `approved_by_ids` **(STARTER)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | +| `approver_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | +| `approved_by_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | | `reviewer_id` | integer | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`. | | `reviewer_username` | string | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. | @@ -401,7 +402,7 @@ Parameters: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium or higher also see the `approvals_before_merge` parameter: ```json @@ -453,10 +454,10 @@ Parameters: | `author_id` | integer | no | Returns merge requests created by the given user `id`. Mutually exclusive with `author_username`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5)_. | | `author_username` | string | no | Returns merge requests created by the given `username`. Mutually exclusive with `author_id`. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 12.10)_. | | `assignee_id` | integer | no | Returns merge requests assigned to the given user `id`. `None` returns unassigned merge requests. `Any` returns merge requests with an assignee. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060) in GitLab 9.5)_. | -| `approver_ids` **(STARTER)** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | -| `approved_by_ids` **(STARTER)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | -| `reviewer_id` | integer | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#enable-or-disable-merge-request-reviewers) with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`. | -| `reviewer_username` | string | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#enable-or-disable-merge-request-reviewers) with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. | +| `approver_ids` **(PREMIUM))** | integer array | no | Returns merge requests which have specified all the users with the given `id`s as individual approvers. `None` returns merge requests without approvers. `Any` returns merge requests with an approver. | +| `approved_by_ids` **(PREMIUM)** | integer array | no | Returns merge requests which have been approved by all the users with the given `id`s (Max: 5). `None` returns merge requests with no approvals. `Any` returns merge requests with an approval. | +| `reviewer_id` | integer | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given user `id`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_username`. | +| `reviewer_username` | string | no | Returns merge requests which have the user as a [reviewer](../user/project/merge_requests/getting_started.md#reviewer) with the given `username`. `None` returns merge requests with no reviewers. `Any` returns merge requests with any reviewer. Mutually exclusive with `reviewer_id`. | | `my_reaction_emoji` | string | no | Return merge requests reacted by the authenticated user by the given `emoji`. `None` returns issues not given a reaction. `Any` returns issues given at least one reaction. _([Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016) in GitLab 10.0)_. | | `source_branch` | string | no | Return merge requests with the given source branch. | | `target_branch` | string | no | Return merge requests with the given target branch. | @@ -574,7 +575,7 @@ Parameters: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium or higher also see the `approvals_before_merge` parameter: ```json @@ -745,7 +746,7 @@ Parameters: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium also see the `approvals_before_merge` parameter: ```json @@ -884,6 +885,14 @@ Parameters: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 4, "target_project_id": 4, "labels": [ ], @@ -1051,7 +1060,8 @@ POST /projects/:id/merge_requests | `target_branch` | string | yes | The target branch. | | `title` | string | yes | Title of MR. | | `assignee_id` | integer | no | Assignee user ID. | -| `assignee_ids` | integer array | no | The ID of the user(s) to assign the MR to. Set to `0` or provide an empty value to unassign all assignees. | +| `assignee_ids` | integer array | no | The ID of the user(s) to assign the MR to. Set to `0` or provide an empty value to unassign all assignees. | +| `reviewer_ids` | integer array | no | The ID of the user(s) added as a reviewer to the MR. If set to `0` or left empty, there will be no reviewers added. | | `description` | string | no | Description of MR. Limited to 1,048,576 characters. | | `target_project_id` | integer | no | The target project (numeric ID). | | `labels` | string | no | Labels for MR as a comma-separated list. | @@ -1172,7 +1182,7 @@ POST /projects/:id/merge_requests } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) also see the `approvals_before_merge` parameter: ```json @@ -1200,6 +1210,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid | `title` | string | no | Title of MR. | | `assignee_id` | integer | no | The ID of the user to assign the merge request to. Set to `0` or provide an empty value to unassign all assignees. | | `assignee_ids` | integer array | no | The ID of the user(s) to assign the MR to. Set to `0` or provide an empty value to unassign all assignees. | +| `reviewer_ids` | integer array | no | The ID of the user(s) set as a reviewer to the MR. Set the value to `0` or provide an empty value to unset all reviewers. | | `milestone_id` | integer | no | The global ID of a milestone to assign the merge request to. Set to `0` or provide an empty value to unassign a milestone.| | `labels` | string | no | Comma-separated label names for a merge request. Set to an empty string to unassign all labels. | | `add_labels` | string | no | Comma-separated label names to add to a merge request. | @@ -1252,6 +1263,14 @@ Must include at least one non-required attribute from above. "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 2, "target_project_id": 3, "labels": [ @@ -1333,7 +1352,7 @@ Must include at least one non-required attribute from above. } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium or higher also see the `approvals_before_merge` parameter: ```json @@ -1386,7 +1405,7 @@ Parameters: | `merge_request_iid` | integer | yes | The internal ID of the merge request. | | `merge_commit_message` | string | no | Custom merge commit message. | | `squash_commit_message` | string | no | Custom squash commit message. | -| `squash` | boolean | no | If `true` the commits the commits are squashed into a single commit on merge. | +| `squash` | boolean | no | If `true` the commits are squashed into a single commit on merge. | | `should_remove_source_branch` | boolean | no | If `true` removes the source branch. | | `merge_when_pipeline_succeeds` | boolean | no | If `true` the MR is merged when the pipeline succeeds. | | `sha` | string | no | If present, then this SHA must match the HEAD of the source branch, otherwise the merge fails. | @@ -1429,6 +1448,14 @@ Parameters: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 2, "target_project_id": 3, "labels": [ @@ -1510,7 +1537,7 @@ Parameters: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium also see the `approvals_before_merge` parameter: ```json @@ -1609,6 +1636,14 @@ Parameters: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 2, "target_project_id": 3, "labels": [ @@ -1690,7 +1725,7 @@ Parameters: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium or higher also see the `approvals_before_merge` parameter: ```json @@ -1902,6 +1937,14 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 2, "target_project_id": 3, "labels": [ @@ -1982,7 +2025,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium also see the `approvals_before_merge` parameter: ```json @@ -2053,6 +2096,14 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 2, "target_project_id": 3, "labels": [ @@ -2133,7 +2184,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab Premium or higher also see the `approvals_before_merge` parameter: ```json @@ -2224,6 +2275,14 @@ Example response: "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", "web_url": "https://gitlab.example.com/axel.block" }], + "reviewers": [{ + "name": "Miss Monserrate Beier", + "username": "axel.block", + "id": 12, + "state": "active", + "avatar_url": "http://www.gravatar.com/avatar/46f6f7dc858ada7be1853f7fb96e81da?s=80&d=identicon", + "web_url": "https://gitlab.example.com/axel.block" + }], "source_project_id": 3, "target_project_id": 3, "labels": [], @@ -2513,7 +2572,7 @@ Example response: } ``` -## Approvals **(STARTER)** +## Approvals For approvals, please see [Merge Request Approvals](merge_request_approvals.md) diff --git a/doc/api/metrics_dashboard_annotations.md b/doc/api/metrics_dashboard_annotations.md index b92e26b03fb..896420ed0fb 100644 --- a/doc/api/metrics_dashboard_annotations.md +++ b/doc/api/metrics_dashboard_annotations.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: concepts, howto --- -# Dashboard annotations API +# Dashboard annotations API **(FREE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/29089) in GitLab 12.10 behind a disabled feature flag. diff --git a/doc/api/metrics_user_starred_dashboards.md b/doc/api/metrics_user_starred_dashboards.md index 79040333148..9178291181e 100644 --- a/doc/api/metrics_user_starred_dashboards.md +++ b/doc/api/metrics_user_starred_dashboards.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: concepts, howto --- -# User-starred metrics dashboards API +# User-starred metrics dashboards API **(FREE)** The starred dashboard feature makes navigating to frequently-used dashboards easier by displaying favorited dashboards at the top of the select list. diff --git a/doc/api/milestones.md b/doc/api/milestones.md index 93b867c0286..15927ad852e 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -159,9 +159,10 @@ Parameters: - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `milestone_id` (required) - The ID of a project milestone -## Get all burndown chart events for a single milestone **(STARTER)** +## Get all burndown chart events for a single milestone **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1 +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/4737) in GitLab 12.1 +> - Moved to GitLab Premium in 13.9. Gets all burndown chart events for a single milestone. diff --git a/doc/api/namespaces.md b/doc/api/namespaces.md index 4e5a418be7a..a89e91f82e5 100644 --- a/doc/api/namespaces.md +++ b/doc/api/namespaces.md @@ -6,7 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Namespaces API -Usernames and groupnames fall under a special category called namespaces. +Usernames and group names fall under a special category called namespaces. For users and groups supported API calls see the [users](users.md) and [groups](groups.md) documentation respectively. diff --git a/doc/api/notes.md b/doc/api/notes.md index fe20d5ab353..8a443d57682 100644 --- a/doc/api/notes.md +++ b/doc/api/notes.md @@ -36,6 +36,11 @@ are paginated. Read more on [pagination](README.md#pagination). +## Rate limits + +To help avoid abuse, you can limit your users to a specific number of `Create` request per minute. +See [Notes rate limits](../user/admin_area/settings/rate_limit_on_notes_creation.md). + ## Issues ### List project issue notes diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index 74746f60d7e..a85c6475331 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -196,7 +196,7 @@ Example responses: } ``` -Users on GitLab [Ultimate or Gold](https://about.gitlab.com/pricing/) also see the `new_epic` +Users on GitLab [Ultimate](https://about.gitlab.com/pricing/) also see the `new_epic` parameter: ```json diff --git a/doc/api/oauth2.md b/doc/api/oauth2.md index a80a97890ba..92d109cac5f 100644 --- a/doc/api/oauth2.md +++ b/doc/api/oauth2.md @@ -21,7 +21,7 @@ GitLab currently supports the following authorization flows: - **Authorization code with [Proof Key for Code Exchange (PKCE)](https://tools.ietf.org/html/rfc7636):** Most secure. Without PKCE, you'd have to include client secrets on mobile clients, - and is recommended for both client and server aoos. + and is recommended for both client and server apps. - **Authorization code:** Secure and common flow. Recommended option for secure server-side apps. - **Implicit grant:** Originally designed for user-agent only apps, such as @@ -89,7 +89,7 @@ Before starting the flow, generate the `STATE`, the `CODE_VERIFIER` and the `COD `/oauth/authorize` page with the following query parameters: ```plaintext - https://gitlab.example.com/oauth/authorize?client_id=APP_ID&redirect_uri=REDIRECT_URI&response_type=code&state=YOUR_UNIQUE_STATE_HASH&scope=REQUESTED_SCOPES&code_challenge=CODE_CHALLENGE&code_challenge_method=S256 + https://gitlab.example.com/oauth/authorize?client_id=APP_ID&redirect_uri=REDIRECT_URI&response_type=code&state=STATE&scope=REQUESTED_SCOPES&code_challenge=CODE_CHALLENGE&code_challenge_method=S256 ``` This page asks the user to approve the request from the app to access their @@ -100,7 +100,7 @@ Before starting the flow, generate the `STATE`, the `CODE_VERIFIER` and the `COD The redirect includes the authorization `code`, for example: ```plaintext - https://example.com/oauth/redirect?code=1234567890&state=YOUR_UNIQUE_STATE_HASH + https://example.com/oauth/redirect?code=1234567890&state=STATE ``` 1. With the authorization `code` returned from the previous request (denoted as @@ -139,29 +139,31 @@ detailed flow description. The authorization code flow is essentially the same as [authorization code flow with PKCE](#authorization-code-with-proof-key-for-code-exchange-pkce), +Before starting the flow, generate the `STATE`. It is a value that can't be predicted +used by the client to maintain state between the request and callback. It should also +be used as a CSRF token. + 1. Request authorization code. To do that, you should redirect the user to the - `/oauth/authorize` endpoint with the following GET parameters: + `/oauth/authorize` page with the following query parameters: ```plaintext https://gitlab.example.com/oauth/authorize?client_id=APP_ID&redirect_uri=REDIRECT_URI&response_type=code&state=STATE&scope=REQUESTED_SCOPES ``` - This will ask the user to approve the applications access to their account - based on the scopes specified in `REQUESTED_SCOPES` and then redirect back to - the `REDIRECT_URI` you provided. The [scope parameter](https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes#requesting-particular-scopes) - is a space separated list of scopes you want to have access to (e.g. `scope=read_user+profile` - would request `read_user` and `profile` scopes). The redirect will - include the GET `code` parameter, for example: + This page asks the user to approve the request from the app to access their + account based on the scopes specified in `REQUESTED_SCOPES`. The user is then + redirected back to the specified `REDIRECT_URI`. The [scope parameter](https://github.com/doorkeeper-gem/doorkeeper/wiki/Using-Scopes#requesting-particular-scopes) + is a space separated list of scopes associated with the user. + For example,`scope=read_user+profile` requests the `read_user` and `profile` scopes. + The redirect includes the authorization `code`, for example: ```plaintext https://example.com/oauth/redirect?code=1234567890&state=STATE ``` - You should then use `code` to request an access token. - -1. After you have the authorization code you can request an `access_token` using the - code. You can do that by using any HTTP client. In the following example, - we are using Ruby's `rest-client`: +1. With the authorization `code` returned from the previous request (shown as + `RETURNED_CODE` in the following example), you can request an `access_token`, with + any HTTP client. The following example uses Ruby's `rest-client`: ```ruby parameters = 'client_id=APP_ID&client_secret=APP_SECRET&code=RETURNED_CODE&grant_type=authorization_code&redirect_uri=REDIRECT_URI' diff --git a/doc/api/openapi/img/apiviewer01-fs8.png b/doc/api/openapi/img/apiviewer01-fs8.png Binary files differnew file mode 100644 index 00000000000..0a2f7062cc8 --- /dev/null +++ b/doc/api/openapi/img/apiviewer01-fs8.png diff --git a/doc/api/openapi/img/apiviewer03-fs8.png b/doc/api/openapi/img/apiviewer03-fs8.png Binary files differnew file mode 100644 index 00000000000..9fa00e830e7 --- /dev/null +++ b/doc/api/openapi/img/apiviewer03-fs8.png diff --git a/doc/api/openapi/img/apiviewer04-fs8.png b/doc/api/openapi/img/apiviewer04-fs8.png Binary files differnew file mode 100644 index 00000000000..bd878ba809b --- /dev/null +++ b/doc/api/openapi/img/apiviewer04-fs8.png diff --git a/doc/api/openapi/openapi_interactive.md b/doc/api/openapi/openapi_interactive.md new file mode 100644 index 00000000000..0f1544b139d --- /dev/null +++ b/doc/api/openapi/openapi_interactive.md @@ -0,0 +1,42 @@ +--- +stage: none +group: unassigned +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# Interactive API documentation + +Introduces the interactive documentation tool for the GitLab API. + +## About the OpenAPI specification + +The [OpenAPI specification](https://swagger.io/specification/) (formerly called Swagger) defines a standard, language-agnostic interface to RESTful APIs. OpenAPI definition files are written in the YAML format, which is automatically rendered by the GitLab browser into a more human-readable interface. For general information about the GitLab APIs, see [API Docs](../README.md). + +## Overview + +The [interactive API documentation tool](openapi.yaml) allows API testing directly on the GitLab.com +website. Only a few of the available endpoints are documented with the OpenAPI spec, but the current +list demonstrates the functionality of the tool. + +![API viewer screenshot](img/apiviewer01-fs8.png) + +## Endpoint parameters + +When you expand an endpoint listing, you'll see a description, input parameters (if required), +and example server responses. Some parameters include a default or a list of allowed values. + +![API viewer screenshot](img/apiviewer04-fs8.png) + +## Starting an interactive sesssion + +A [Personal access token](../../user/profile/personal_access_tokens.md) (PAT) is one way to +start an interactive session. To do this, select **Authorize** from the main page, and a +dialog box prompts you to enter your PAT, which is valid for the current web session. + +To test the endpoint, first select **Try it out** on the endpoint definition page. Input the parameters +as required, then select **Execute**. In the following example, we executed a request for the `version` +endpoint (no parameters required). The tool shows the `curl` command and URL of the request, followed +by the server responses that are returned. You can create new responses by editing the relevant parameters +and then select **Execute** once again. + +![API viewer screenshot](img/apiviewer03-fs8.png) diff --git a/doc/api/packages.md b/doc/api/packages.md index a0d966fdd88..112c7ef2e61 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -29,6 +29,7 @@ GET /projects/:id/packages | `package_type` | string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, or `golang`. (_Introduced in GitLab 12.9_) | `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_Introduced in GitLab 12.9_) | `include_versionless` | boolean | no | When set to true, versionless packages are included in the response. (_Introduced in GitLab 13.8_) +| `status` | string | no | Filter the returned packages by status. One of `default` (default), `hidden`, or `processing`. (_Introduced in GitLab 13.9_) ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages" @@ -70,6 +71,9 @@ Example response: By default, the `GET` request returns 20 results, because the API is [paginated](README.md#pagination). +Although you can filter packages by status, working with packages that have a `processing` status +can result in malformed data or broken packages. + ### Within a group > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18871) in GitLab 12.5. @@ -90,9 +94,10 @@ GET /groups/:id/packages | `package_type` | string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, or `golang`. (_Introduced in GitLab 12.9_) | | `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30980) in GitLab 13.0_) | `include_versionless` | boolean | no | When set to true, versionless packages are included in the response. (_Introduced in GitLab 13.8_) +| `status` | string | no | Filter the returned packages by status. One of `default` (default), `hidden`, or `processing`. (_Introduced in GitLab 13.9_) ```shell -curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=true" +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/:id/packages?exclude_subgroups=false" ``` > **Deprecation:** @@ -166,6 +171,9 @@ The `_links` object contains the following properties: - `web_path`: The path which you can visit in GitLab and see the details of the package. - `delete_api_path`: The API path to delete the package. Only available if the request user has permission to do so. +Although you can filter packages by status, working with packages that have a `processing` status +can result in malformed data or broken packages. + ## Get a project package > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9667) in GitLab 11.9. @@ -264,7 +272,7 @@ GET /projects/:id/packages/:package_id/package_files | `package_id` | integer | yes | ID of a package. | ```shell -curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/4/package_files" +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/packages/4/package_files" ``` Example response: diff --git a/doc/api/personal_access_tokens.md b/doc/api/personal_access_tokens.md index ca0ac3522c3..4949bf504fa 100644 --- a/doc/api/personal_access_tokens.md +++ b/doc/api/personal_access_tokens.md @@ -11,7 +11,7 @@ You can read more about [personal access tokens](../user/profile/personal_access ## List personal access tokens > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227264) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.3. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/270200) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.6. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/270200) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.6. Get a list of personal access tokens. @@ -71,7 +71,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a ## Revoke a personal access token > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/216004) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.3. -> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/270200) to [GitLab Core](https://about.gitlab.com/pricing/) in 13.6. +> - [Moved](https://gitlab.com/gitlab-org/gitlab/-/issues/270200) to [GitLab Free](https://about.gitlab.com/pricing/) in 13.6. Revoke a personal access token. diff --git a/doc/api/project_aliases.md b/doc/api/project_aliases.md index 270c88ca661..439f34ad93b 100644 --- a/doc/api/project_aliases.md +++ b/doc/api/project_aliases.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Project Aliases API **(PREMIUM ONLY)** +# Project Aliases API **(PREMIUM SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/3264) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1. diff --git a/doc/api/project_analytics.md b/doc/api/project_analytics.md index 97b15cc2c88..d89c173dd3e 100644 --- a/doc/api/project_analytics.md +++ b/doc/api/project_analytics.md @@ -1,52 +1,8 @@ --- -stage: Release -group: Release -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments -type: reference, api +redirect_to: 'dora4_project_analytics.md' --- -# Project Analytics API **(ULTIMATE ONLY)** +This document was moved to [another location](dora4_project_analytics.md). -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/279039) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 13.7. - -All methods require reporter authorization. - -## List project deployment frequencies - -Get a list of all project aliases: - -```plaintext -GET /projects/:id/analytics/deployment_frequency?environment=:environment&from=:from&to=:to&interval=:interval -``` - -| Attribute | Type | Required | Description | -|--------------|--------|----------|-----------------------| -| `id` | string | yes | The ID of the project | - -| Parameter | Type | Required | Description | -|--------------|--------|----------|-----------------------| -| `environment`| string | yes | The name of the environment to filter by | -| `from` | string | yes | Datetime range to start from, inclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`) | -| `to` | string | no | Datetime range to end at, exclusive, ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`) | -| `interval` | string | no | The bucketing interval (`all`, `monthly`, `daily`) | - -```shell -curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/analytics/deployment_frequency?from=:from&to=:to&interval=:interval" -``` - -Example response: - -```json -[ - { - "from": "2017-01-01", - "to": "2017-01-02", - "value": 106 - }, - { - "from": "2017-01-02", - "to": "2017-01-03", - "value": 55 - } -] -``` +<!-- This redirect file can be deleted after <2021-04-25>. --> +<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page --> diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 2ca22baf654..041f67157f7 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Project badges API +# Project badges API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6. @@ -13,11 +13,14 @@ type: reference, api Badges support placeholders that will be replaced in real time in both the link and image URL. The allowed placeholders are: +<!-- vale gitlab.Spelling = NO --> + - **%{project_path}**: will be replaced by the project path. - **%{project_id}**: will be replaced by the project ID. - **%{default_branch}**: will be replaced by the project default branch. - **%{commit_sha}**: will be replaced by the last project's commit SHA. +<!-- vale gitlab.Spelling = YES --> ## List all badges of a project Gets a list of a project's badges and its group badges. @@ -103,9 +106,10 @@ POST /projects/:id/badges | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `link_url` | string | yes | URL of the badge link | | `image_url` | string | yes | URL of the badge image | +| `name` | string | no | Name of the badge | ```shell -curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0" "https://gitlab.example.com/api/v4/projects/:id/badges" +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&name=mybadge" "https://gitlab.example.com/api/v4/projects/:id/badges" ``` Example response: @@ -113,6 +117,7 @@ Example response: ```json { "id": 1, + "name": "mybadge", "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge1", "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", @@ -135,6 +140,7 @@ PUT /projects/:id/badges/:badge_id | `badge_id` | integer | yes | The badge ID | | `link_url` | string | no | URL of the badge link | | `image_url` | string | no | URL of the badge image | +| `name` | string | no | Name of the badge | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/:id/badges/:badge_id" @@ -145,6 +151,7 @@ Example response: ```json { "id": 1, + "name": "mybadge", "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge", "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", diff --git a/doc/api/project_clusters.md b/doc/api/project_clusters.md index 3cc8cd07923..a431e754774 100644 --- a/doc/api/project_clusters.md +++ b/doc/api/project_clusters.md @@ -4,7 +4,7 @@ group: Configure info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Project clusters API +# Project clusters API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23922) in GitLab 11.7. diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index 0711cc8abd6..cd8adf49f1d 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -5,14 +5,14 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Project import/export API +# Project import/export API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41899) in GitLab 10.6. See also: - [Project import/export documentation](../user/project/settings/import_export.md). -- [Project import/export administration Rake tasks](../administration/raketasks/project_import_export.md). **(CORE ONLY)** +- [Project import/export administration Rake tasks](../administration/raketasks/project_import_export.md). **(FREE SELF)** ## Schedule an export @@ -194,7 +194,7 @@ requests.post(url, headers=headers, data=data, files=files) NOTE: The maximum import file size can be set by the Administrator, default is `0` (unlimited).. -As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the [Application settings API](settings.md#change-application-settings) or the [Admin UI](../user/admin_area/settings/account_and_limit_settings.md). +As an administrator, you can modify the maximum import file size. To do so, use the `max_import_size` option in the [Application settings API](settings.md#change-application-settings) or the [Admin UI](../user/admin_area/settings/account_and_limit_settings.md). Default [modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50MB to 0 in GitLab 13.8. ## Import status diff --git a/doc/api/project_level_variables.md b/doc/api/project_level_variables.md index 413d89950cd..8ef887675e9 100644 --- a/doc/api/project_level_variables.md +++ b/doc/api/project_level_variables.md @@ -17,7 +17,7 @@ GET /projects/:id/variables | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| -| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/variables" @@ -48,7 +48,7 @@ GET /projects/:id/variables/:key | Attribute | Type | required | Description | |-----------|---------|----------|-----------------------| -| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `key` | string | yes | The `key` of a variable | | `filter` | hash | no | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | @@ -76,7 +76,7 @@ POST /projects/:id/variables | Attribute | Type | required | Description | |---------------------|---------|----------|-----------------------| -| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `key` | string | yes | The `key` of a variable; must have no more than 255 characters; only `A-Z`, `a-z`, `0-9`, and `_` are allowed | | `value` | string | yes | The `value` of a variable | | `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | @@ -109,7 +109,7 @@ PUT /projects/:id/variables/:key | Attribute | Type | required | Description | |---------------------|---------|----------|-------------------------| -| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `key` | string | yes | The `key` of a variable | | `value` | string | yes | The `value` of a variable | | `variable_type` | string | no | The type of a variable. Available types are: `env_var` (default) and `file` | @@ -143,7 +143,7 @@ DELETE /projects/:id/variables/:key | Attribute | Type | required | Description | |-----------|---------|----------|-------------------------| -| `id` | integer/string | yes | The ID of a project or [urlencoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `id` | integer/string | yes | The ID of a project or [URL-encoded NAMESPACE/PROJECT_NAME of the project](README.md#namespaced-path-encoding) owned by the authenticated user | | `key` | string | yes | The `key` of a variable | | `filter` | hash | no | Available filters: `[environment_scope]`. See the [`filter` parameter details](#the-filter-parameter). | diff --git a/doc/api/project_repository_storage_moves.md b/doc/api/project_repository_storage_moves.md index 52c357ca32a..be922b441d6 100644 --- a/doc/api/project_repository_storage_moves.md +++ b/doc/api/project_repository_storage_moves.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# Project repository storage moves API **(CORE ONLY)** +# Project repository storage moves API **(FREE SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/31285) in GitLab 13.0. @@ -30,11 +30,10 @@ read-only. Please try again later.` message if they try to push new commits. This API requires you to [authenticate yourself](README.md#authentication) as an administrator. -Snippet repositories can be moved using the [Snippet repository storage moves API](snippet_repository_storage_moves.md). +For other repository types see: -## Limitations - -- Group-level wikis [can't be moved with the API](https://gitlab.com/gitlab-org/gitlab/-/issues/219003). +- [Snippet repository storage moves API](snippet_repository_storage_moves.md). +- [Group repository storage moves API](group_repository_storage_moves.md). ## Retrieve all project repository storage moves diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index d264e68e96a..c5adf361fb6 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -225,8 +225,8 @@ Parameters: - `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user - `snippet_id` (required) - The ID of a project's snippet -- `ref` (required) - The name of a branch, tag or commit e.g. master -- `file_path` (required) - The URL-encoded path to the file, e.g. snippet%2Erb +- `ref` (required) - The name of a branch, tag or commit, such as `master` +- `file_path` (required) - The URL-encoded path to the file, such as `snippet%2Erb` Example request: @@ -239,7 +239,7 @@ curl "https://gitlab.com/api/v4/projects/1/snippets/2/files/master/snippet%2Erb/ > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/29508) in GitLab 9.4. -Available only for admins. +Available only for users with Administrator [permissions](../user/permissions.md). ```plaintext GET /projects/:id/snippets/:snippet_id/user_agent_detail diff --git a/doc/api/project_statistics.md b/doc/api/project_statistics.md index 984720ed56f..6a987b60f64 100644 --- a/doc/api/project_statistics.md +++ b/doc/api/project_statistics.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Project statistics API +# Project statistics API **(FREE)** Every API call to [project](../user/project/index.md) statistics must be authenticated. diff --git a/doc/api/project_templates.md b/doc/api/project_templates.md index d75047d6cb3..6251d31660c 100644 --- a/doc/api/project_templates.md +++ b/doc/api/project_templates.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Project templates API +# Project templates API **(FREE)** This API is a project-specific version of these endpoints: @@ -34,7 +34,7 @@ GET /projects/:id/templates/:type | Attribute | Type | Required | Description | | ---------- | ------ | -------- | ----------- | | `id` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | -| `type` | string | yes| The type `(dockerfiles|gitignores|gitlab_ci_ymls|licenses|issues|merge_requests)` of the template | +| `type` | string | yes | The type `(dockerfiles|gitignores|gitlab_ci_ymls|licenses|issues|merge_requests)` of the template | Example response (licenses): @@ -94,14 +94,15 @@ Example response (licenses): ## Get one template of a particular type ```plaintext -GET /projects/:id/templates/:type/:key +GET /projects/:id/templates/:type/:name ``` | Attribute | Type | Required | Description | | ---------- | ------ | -------- | ----------- | | `id` | integer / string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `type` | string | yes| The type `(dockerfiles|gitignores|gitlab_ci_ymls|licenses|issues|merge_requests)` of the template | -| `key` | string | yes | The key of the template, as obtained from the collection endpoint | +| `name` | string | yes | The key of the template, as obtained from the collection endpoint | +| `source_template_project_id` | integer | no | The project ID where a given template is being stored. This is useful when multiple templates from different projects have the same name. If multiple templates have the same name, the match from `closest ancestor` is returned if `source_template_project_id` is not specified | | `project` | string | no | The project name to use when expanding placeholders in the template. Only affects licenses | | `fullname` | string | no | The full name of the copyright holder to use when expanding placeholders in the template. Only affects licenses | diff --git a/doc/api/projects.md b/doc/api/projects.md index f9a4b3ba55e..321a95af8b5 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -298,11 +298,11 @@ When the user is authenticated and `simple` is not set this returns something li ``` NOTE: -For users of GitLab [Silver, Premium, or higher](https://about.gitlab.com/pricing/), +For users of [GitLab Premium or higher](https://about.gitlab.com/pricing/), the `marked_for_deletion_at` attribute has been deprecated, and is removed in API v5 in favor of the `marked_for_deletion_on` attribute. -Users of GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `approvals_before_merge` parameter: ```json @@ -933,7 +933,7 @@ GET /projects/:id } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `approvals_before_merge` parameter: ```json @@ -1053,7 +1053,7 @@ POST /projects |-------------------------------------------------------------|---------|------------------------|-------------| | `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. | | `analytics_access_level` | string | no | One of `disabled`, `private` or `enabled` | -| `approvals_before_merge` **(STARTER)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. | +| `approvals_before_merge` **(PREMIUM)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. | | `auto_cancel_pending_pipelines` | string | **{dotted-circle}** No | Auto-cancel pending pipelines. This isn't a boolean, but enabled/disabled. | | `auto_devops_deploy_strategy` | string | **{dotted-circle}** No | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`). | | `auto_devops_enabled` | boolean | **{dotted-circle}** No | Enable Auto DevOps for this project. | @@ -1081,8 +1081,8 @@ POST /projects | `merge_method` | string | **{dotted-circle}** No | Set the [merge method](#project-merge-method) used. | | `merge_requests_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. | -| `mirror_trigger_builds` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | -| `mirror` **(STARTER)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | +| `mirror_trigger_builds` **(PREMIUM)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | +| `mirror` **(PREMIUM)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | | `name` | string | **{check-circle}** Yes (if path isn't provided) | The name of the new project. Equals path if not provided. | | `namespace_id` | integer | **{dotted-circle}** No | Namespace for the new project (defaults to the current user's namespace). | | `operations_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | @@ -1104,7 +1104,7 @@ POST /projects | `snippets_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `snippets_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable snippets for this project. Use `snippets_access_level` instead. | | `tag_list` | array | **{dotted-circle}** No | The list of tags for a project; put array of tags, that should be finally assigned to a project. | -| `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. | +| `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../user/project/working_with_projects.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. | | `template_project_id` **(PREMIUM)** | integer | **{dotted-circle}** No | When used with `use_custom_template`, project ID of a custom project template. This is preferable to using `template_name` since `template_name` may be ambiguous. | | `use_custom_template` **(PREMIUM)** | boolean | **{dotted-circle}** No | Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template. | | `visibility` | string | **{dotted-circle}** No | See [project visibility level](#project-visibility-level). | @@ -1127,7 +1127,7 @@ POST /projects/user/:user_id |-------------------------------------------------------------|---------|------------------------|-------------| | `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. | | `analytics_access_level` | string | no | One of `disabled`, `private` or `enabled` | -| `approvals_before_merge` **(STARTER)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. | +| `approvals_before_merge` **(PREMIUM)** | integer | **{dotted-circle}** No | How many approvers should approve merge requests by default. | | `auto_cancel_pending_pipelines` | string | **{dotted-circle}** No | Auto-cancel pending pipelines. This isn't a boolean, but enabled/disabled. | | `auto_devops_deploy_strategy` | string | **{dotted-circle}** No | Auto Deploy strategy (`continuous`, `manual` or `timed_incremental`). | | `auto_devops_enabled` | boolean | **{dotted-circle}** No | Enable Auto DevOps for this project. | @@ -1153,8 +1153,8 @@ POST /projects/user/:user_id | `merge_method` | string | **{dotted-circle}** No | Set the [merge method](#project-merge-method) used. | | `merge_requests_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. | -| `mirror_trigger_builds` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | -| `mirror` **(STARTER)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | +| `mirror_trigger_builds` **(PREMIUM)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | +| `mirror` **(PREMIUM)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | | `name` | string | **{check-circle}** Yes | The name of the new project. | | `namespace_id` | integer | **{dotted-circle}** No | Namespace for the new project (defaults to the current user's namespace). | | `operations_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | @@ -1177,7 +1177,7 @@ POST /projects/user/:user_id | `snippets_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable snippets for this project. Use `snippets_access_level` instead. | | `suggestion_commit_message` | string | **{dotted-circle}** No | The commit message used to apply merge request suggestions. | | `tag_list` | array | **{dotted-circle}** No | The list of tags for a project; put array of tags, that should be finally assigned to a project. | -| `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../gitlab-basics/create-project.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. | +| `template_name` | string | **{dotted-circle}** No | When used without `use_custom_template`, name of a [built-in project template](../user/project/working_with_projects.md#built-in-templates). When used with `use_custom_template`, name of a custom project template. | | `use_custom_template` **(PREMIUM)** | boolean | **{dotted-circle}** No | Use either custom [instance](../user/admin_area/custom_project_templates.md) or [group](../user/group/custom_project_templates.md) (with `group_with_project_templates_id`) project template. | | `user_id` | integer | **{check-circle}** Yes | The user ID of the project owner. | | `visibility` | string | **{dotted-circle}** No | See [project visibility level](#project-visibility-level). | @@ -1200,7 +1200,7 @@ PUT /projects/:id |-------------------------------------------------------------|----------------|------------------------|-------------| | `allow_merge_on_skipped_pipeline` | boolean | **{dotted-circle}** No | Set whether or not merge requests can be merged with skipped jobs. | | `analytics_access_level` | string | no | One of `disabled`, `private` or `enabled` | -| `approvals_before_merge` **(STARTER)** | integer | **{dotted-circle}** No | How many approvers should approve merge request by default. | +| `approvals_before_merge` **(PREMIUM)** | integer | **{dotted-circle}** No | How many approvers should approve merge request by default. | | `auto_cancel_pending_pipelines` | string | **{dotted-circle}** No | Auto-cancel pending pipelines. This isn't a boolean, but enabled/disabled. | | `auto_devops_deploy_strategy` | string | **{dotted-circle}** No | Auto Deploy strategy (`continuous`, `manual`, or `timed_incremental`). | | `auto_devops_enabled` | boolean | **{dotted-circle}** No | Enable Auto DevOps for this project. | @@ -1229,15 +1229,15 @@ PUT /projects/:id | `merge_method` | string | **{dotted-circle}** No | Set the [merge method](#project-merge-method) used. | | `merge_requests_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `merge_requests_enabled` | boolean | **{dotted-circle}** No | _(Deprecated)_ Enable merge requests for this project. Use `merge_requests_access_level` instead. | -| `mirror_overwrites_diverged_branches` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirror overwrites diverged branches. | -| `mirror_trigger_builds` **(STARTER)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | -| `mirror_user_id` **(STARTER)** | integer | **{dotted-circle}** No | User responsible for all the activity surrounding a pull mirror event. _(admins only)_ | -| `mirror` **(STARTER)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | +| `mirror_overwrites_diverged_branches` **(PREMIUM)** | boolean | **{dotted-circle}** No | Pull mirror overwrites diverged branches. | +| `mirror_trigger_builds` **(PREMIUM)** | boolean | **{dotted-circle}** No | Pull mirroring triggers builds. | +| `mirror_user_id` **(PREMIUM)** | integer | **{dotted-circle}** No | User responsible for all the activity surrounding a pull mirror event. _(admins only)_ | +| `mirror` **(PREMIUM)** | boolean | **{dotted-circle}** No | Enables pull mirroring in a project. | | `name` | string | **{dotted-circle}** No | The name of the project. | | `operations_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, or `enabled`. | | `only_allow_merge_if_all_discussions_are_resolved` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged when all the discussions are resolved. | | `only_allow_merge_if_pipeline_succeeds` | boolean | **{dotted-circle}** No | Set whether merge requests can only be merged with successful jobs. | -| `only_mirror_protected_branches` **(STARTER)** | boolean | **{dotted-circle}** No | Only mirror protected branches. | +| `only_mirror_protected_branches` **(PREMIUM)** | boolean | **{dotted-circle}** No | Only mirror protected branches. | | `packages_enabled` | boolean | **{dotted-circle}** No | Enable or disable packages repository feature. | | `pages_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled`, or `public`. | | `requirements_access_level` | string | **{dotted-circle}** No | One of `disabled`, `private`, `enabled` or `public` | @@ -1280,6 +1280,8 @@ POST /projects/:id/fork | `namespace_path` | string | **{dotted-circle}** No | The path of the namespace that the project is forked to. | | `namespace` | integer/string | **{dotted-circle}** No | _(Deprecated)_ The ID or path of the namespace that the project is forked to. | | `path` | string | **{dotted-circle}** No | The path assigned to the resultant project after forking. | +| `description` | string | **{dotted-circle}** No | The description assigned to the resultant project after forking. | +| `visibility` | string | **{dotted-circle}** No | The [visibility level](#project-visibility-level) assigned to the resultant project after forking. | ## List Forks of a project @@ -1875,7 +1877,7 @@ This endpoint: - Deletes a project including all associated resources (including issues and merge requests). - From [GitLab 13.2](https://gitlab.com/gitlab-org/gitlab/-/issues/220382) on - [Premium or Silver](https://about.gitlab.com/pricing/) or higher tiers, group + [Premium or higher](https://about.gitlab.com/pricing/) tiers, group admins can [configure](../user/group/index.md#enabling-delayed-project-removal) projects within a group to be deleted after a delayed period. When enabled, actual deletion happens after the number of days specified in the @@ -2185,8 +2187,6 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a ## Start the Housekeeping task for a project -> Introduced in GitLab 9.0. - ```plaintext POST /projects/:id/housekeeping ``` @@ -2195,9 +2195,9 @@ POST /projects/:id/housekeeping |-----------|----------------|------------------------|-------------| | `id` | integer/string | **{check-circle}** Yes | The ID of the project or NAMESPACE/PROJECT_NAME. | -## Push Rules **(STARTER)** +## Push Rules **(PREMIUM)** -### Get project push rules **(STARTER)** +### Get project push rules **(PREMIUM)** Get the [push rules](../push_rules/push_rules.md#enabling-push-rules) of a project. @@ -2229,7 +2229,7 @@ GET /projects/:id/push_rule } ``` -Users of GitLab [Premium, Silver, or higher](https://about.gitlab.com/pricing/) +Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see the `commit_committer_check` and `reject_unsigned_commits` parameters: @@ -2243,7 +2243,7 @@ parameters: } ``` -### Add project push rule **(STARTER)** +### Add project push rule **(PREMIUM)** Adds a push rule to a specified project. @@ -2266,7 +2266,7 @@ POST /projects/:id/push_rule | `prevent_secrets` | boolean | **{dotted-circle}** No | GitLab rejects any files that are likely to contain secrets. | | `reject_unsigned_commits` **(PREMIUM)** | boolean | **{dotted-circle}** No | Reject commit when it's not signed through GPG. | -### Edit project push rule **(STARTER)** +### Edit project push rule **(PREMIUM)** Edits a push rule for a specified project. @@ -2291,7 +2291,7 @@ PUT /projects/:id/push_rule ### Delete project push rule -> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 9.0. +> - Moved to GitLab Premium in 13.9. Removes a push rule from a project. This is an idempotent method and can be called multiple times. Either the push rule is available or not. @@ -2438,9 +2438,10 @@ Read more in the [Project import/export](project_import_export.md) documentation Read more in the [Project members](members.md) documentation. -## Configure pull mirroring for a project **(STARTER)** +## Configure pull mirroring for a project **(PREMIUM)** -> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 11.2. +> - Introduced in GitLab 11. +> - Moved to GitLab Premium in 13.9. Configure pull mirroring while [creating a new project](#create-project) or [updating an existing project](#edit-project) using the API if the remote repository is publicly accessible or via `username/password` authentication. In case your HTTP repository is not publicly accessible, you can add the authentication information to the URL: `https://username:password@gitlab.company.com/group/project.git`, where password is a [personal access token](../user/profile/personal_access_tokens.md) with the API scope enabled. @@ -2450,9 +2451,9 @@ The relevant API parameters to update are: - `mirror`: Enables pull mirroring on project when set to `true`. - `only_mirror_protected_branches`: Set to `true` for protected branches. -## Start the pull mirroring process for a Project **(STARTER)** +## Start the pull mirroring process for a Project **(PREMIUM)** -> Introduced in [GitLab Starter](https://about.gitlab.com/pricing/) 10.3. +> - Moved to GitLab Premium in 13.9. ```plaintext POST /projects/:id/mirror/pull diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index 1dd15231dd8..12ba40d5df5 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Protected branches API +# Protected branches API **(FREE)** > Introduced in GitLab 9.5. @@ -62,7 +62,7 @@ Example response: ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see +Users on GitLab Premium or higher also see the `user_id` and `group_id` parameters: Example response: @@ -133,7 +133,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see +Users on GitLab Premium or higher also see the `user_id` and `group_id` parameters: Example response: @@ -182,9 +182,9 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla | `push_access_level` | string | no | Access levels allowed to push (defaults: `40`, maintainer access level) | | `merge_access_level` | string | no | Access levels allowed to merge (defaults: `40`, maintainer access level) | | `unprotect_access_level` | string | no | Access levels allowed to unprotect (defaults: `40`, maintainer access level) | -| `allowed_to_push` | array | no | **(STARTER)** Array of access levels allowed to push, with each described by a hash | -| `allowed_to_merge` | array | no | **(STARTER)** Array of access levels allowed to merge, with each described by a hash | -| `allowed_to_unprotect` | array | no | **(STARTER)** Array of access levels allowed to unprotect, with each described by a hash | +| `allowed_to_push` | array | no | **(PREMIUM)** Array of access levels allowed to push, with each described by a hash | +| `allowed_to_merge` | array | no | **(PREMIUM)** Array of access levels allowed to merge, with each described by a hash | +| `allowed_to_unprotect` | array | no | **(PREMIUM)** Array of access levels allowed to unprotect, with each described by a hash | | `code_owner_approval_required` | boolean | no | **(PREMIUM)** Prevent pushes to this branch if it matches an item in the [`CODEOWNERS` file](../user/project/code_owners.md). (defaults: false) | Example response: @@ -215,7 +215,7 @@ Example response: } ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) will also see +Users on GitLab Premium or higher also see the `user_id` and `group_id` parameters: Example response: @@ -252,7 +252,7 @@ Example response: } ``` -### Example with user / group level access **(STARTER)** +### Example with user / group level access **(PREMIUM)** Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users) and were [added to the API](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE. @@ -295,7 +295,9 @@ Example response: } ``` -### Example with allow to push and allow to merge access **(STARTER)** +### Example with allow to push and allow to merge access **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. Example request: @@ -375,7 +377,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ## Require code owner approvals for a single branch -Update the "code owner approval required" option for the given protected branch protected branch. +Update the "code owner approval required" option for the given protected branch. ```plaintext PATCH /projects/:id/protected_branches/:name diff --git a/doc/api/protected_tags.md b/doc/api/protected_tags.md index 87bd7043121..63fa7183aab 100644 --- a/doc/api/protected_tags.md +++ b/doc/api/protected_tags.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Protected tags API +# Protected tags API **(FREE)** > Introduced in GitLab 11.3. diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index a58d6246a63..be9512ed0e0 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -486,7 +486,7 @@ Example response: } ``` -### Group milestones **(PREMIUM ONLY)** +### Group milestones **(PREMIUM SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/235391) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.5. @@ -495,7 +495,7 @@ array for [Create a release](#create-a-release) and [Update a release](#update-a API calls. Only milestones associated with the project's group may be specified, and adding milestones for ancestor groups raises an error. -## Collect release evidence **(PREMIUM ONLY)** +## Collect release evidence **(PREMIUM SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/199065) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.10. diff --git a/doc/api/remote_mirrors.md b/doc/api/remote_mirrors.md index c40aed534d5..638d4a3b917 100644 --- a/doc/api/remote_mirrors.md +++ b/doc/api/remote_mirrors.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Project remote mirrors API +# Project remote mirrors API **(FREE)** [Push mirrors](../user/project/repository/repository_mirroring.md#pushing-to-a-remote-repository) defined on a project's repository settings are called "remote mirrors", and the diff --git a/doc/api/repositories.md b/doc/api/repositories.md index efdf010e072..b0b3160e075 100644 --- a/doc/api/repositories.md +++ b/doc/api/repositories.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Repositories API +# Repositories API **(FREE)** ## List repository tree @@ -18,14 +18,15 @@ This command provides essentially the same functionality as the `git ls-tree` co GET /projects/:id/repository/tree ``` -Parameters: +Supported attributes: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `path` (optional) - The path inside repository. Used to get content of subdirectories -- `ref` (optional) - The name of a repository branch or tag or if not given the default branch -- `recursive` (optional) - Boolean value used to get a recursive tree (false by default) -- `per_page` (optional) - Number of results to show per page. If not specified, defaults to `20`. - Read more on [pagination](README.md#pagination). +| Attribute | Type | Required | Description | +| :---------- | :------------- | :------- | :---------- | +| `id` | integer/string | no | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `path` | string | yes | The path inside repository. Used to get content of subdirectories. | +| `ref` | string | yes | The name of a repository branch or tag or if not given the default branch. | +| `recursive` | boolean | yes | Boolean value used to get a recursive tree (false by default). | +| `per_page` | integer | yes | Number of results to show per page. If not specified, defaults to `20`. [Learn more on pagination](README.md#pagination). | ```json [ @@ -91,10 +92,12 @@ without authentication if the repository is publicly accessible. GET /projects/:id/repository/blobs/:sha ``` -Parameters: +Supported attributes: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `sha` (required) - The blob SHA +| Attribute | Type | Required | Description | +| :-------- | :------------- | :------- | :---------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `sha` | string | yes | The blob SHA. | ## Raw blob content @@ -105,10 +108,12 @@ without authentication if the repository is publicly accessible. GET /projects/:id/repository/blobs/:sha/raw ``` -Parameters: +Supported attributes: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `sha` (required) - The blob SHA +| Attribute | Type | Required | Description | +| :-------- | :------- | :------- | :---------- | +| `id` | datatype | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `sha` | datatype | yes | The blob SHA. | ## Get file archive @@ -128,10 +133,14 @@ GET /projects/:id/repository/archive[.format] `bz2`, `tar`, and `zip`. For example, specifying `archive.zip` would send an archive in ZIP format. -Parameters: +Supported attributes: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `sha` (optional) - The commit SHA to download. A tag, branch reference, or SHA can be used. This defaults to the tip of the default branch if not specified. For example: +| Attribute | Type | Required | Description | +|:------------|:---------------|:---------|:----------------------| +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `sha` | string | no | The commit SHA to download. A tag, branch reference, or SHA can be used. This defaults to the tip of the default branch if not specified. | + +Example request: ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.com/api/v4/projects/<project_id>/repository/archive?sha=<commit_sha>" @@ -146,21 +155,22 @@ publicly accessible. Note that diffs could have an empty diff string if [diff li GET /projects/:id/repository/compare ``` -Parameters: +Supported attributes: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `from` (required) - the commit SHA or branch name -- `to` (required) - the commit SHA or branch name -- `straight` (optional) - comparison method, `true` for direct comparison between `from` and `to` (`from`..`to`), `false` to compare using merge base (`from`...`to`)'. Default is `false`. +| Attribute | Type | Required | Description | +| :--------- | :------------- | :------- | :---------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `from` | string | yes | The commit SHA or branch name. | +| `to` | string | yes | The commit SHA or branch name. | +| `straight` | boolean | no | Comparison method, `true` for direct comparison between `from` and `to` (`from`..`to`), `false` to compare using merge base (`from`...`to`)'. Default is `false`. | ```plaintext GET /projects/:id/repository/compare?from=master&to=feature ``` -Response: +Example response: ```json - { "commit": { "id": "12d65c8dd2b2676fa3ac47d955accc085a37a9c1", @@ -203,15 +213,17 @@ GET /projects/:id/repository/contributors ``` WARNING: -The `additions` and `deletions` attributes are deprecated [as of GitLab 13.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39653) because they [always return `0`](https://gitlab.com/gitlab-org/gitlab/-/issues/233119). +The `additions` and `deletions` attributes are deprecated [as of GitLab 13.4](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/39653), because they [always return `0`](https://gitlab.com/gitlab-org/gitlab/-/issues/233119). -Parameters: +Supported attributes: -- `id` (required) - The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user -- `order_by` (optional) - Return contributors ordered by `name`, `email`, or `commits` (orders by commit date) fields. Default is `commits` -- `sort` (optional) - Return contributors sorted in `asc` or `desc` order. Default is `asc` +| Attribute | Type | Required | Description | +| :--------- | :------------- | :------- | :---------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. | +| `order_by` | string | no | Return contributors ordered by `name`, `email`, or `commits` (orders by commit date) fields. Default is `commits`. | +| `sort` | string | no | Return contributors sorted in `asc` or `desc` order. Default is `asc`. | -Response: +Example response: ```json [{ @@ -237,10 +249,12 @@ Get the common ancestor for 2 or more refs (commit SHAs, branch names or tags). GET /projects/:id/repository/merge_base ``` -| Attribute | Type | Required | Description | -| --------- | ---- | -------- | ----------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | -| `refs` | array | yes | The refs to find the common ancestor of, multiple refs can be passed | +| Attribute | Type | Required | Description | +| --------- | -------------- | -------- | ------------------------------------------------------------------------------- | +| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | +| `refs` | array | yes | The refs to find the common ancestor of, multiple refs can be passed | + +Example request: ```shell curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/merge_base?refs[]=304d257dcb821665ab5110318fc58a007bd104ed&refs[]=0031876facac3f2b2702a0e53a26e89939a42209" @@ -264,3 +278,283 @@ Example response: "committed_date": "2014-02-27T08:03:18.000Z" } ``` + +## Generate changelog data + +> [Introduced](https://gitlab.com/groups/gitlab-com/gl-infra/-/epics/351) in GitLab 13.9. + +Generate changelog data based on commits in a repository. + +Given a version (using semantic versioning) and a range of commits, +GitLab generates a changelog for all commits that use a particular +[Git trailer](https://git-scm.com/docs/git-interpret-trailers). + +The output of this process is a new section in a changelog file in the Git +repository of the given project. The output format is in Markdown, and can be +customized. + +```plaintext +POST /projects/:id/repository/changelog +``` + +Supported attributes: + +| Attribute | Type | Required | Description | +| :-------- | :------- | :--------- | :---------- | +| `version` | string | yes | The version to generate the changelog for. The format must follow [semantic versioning](https://semver.org/). | +| `from` | string | no | The start of the range of commits (as a SHA) to use for generating the changelog. This commit itself isn't included in the list. | +| `to` | string | yes | The end of the range of commits (as a SHA) to use for the changelog. This commit _is_ included in the list. | +| `date` | datetime | no | The date and time of the release, defaults to the current time. | +| `branch` | string | no | The branch to commit the changelog changes to, defaults to the project's default branch. | +| `trailer` | string | no | The Git trailer to use for including commits, defaults to `Changelog`. | +| `file` | string | no | The file to commit the changes to, defaults to `CHANGELOG.md`. | +| `message` | string | no | The commit message to produce when committing the changes, defaults to `Add changelog for version X` where X is the value of the `version` argument. | + +If the `from` attribute is unspecified, GitLab uses the Git tag of the last +version that came before the version specified in the `version` attribute. For +this to work, your project must create Git tags for versions using the +following format: + +```plaintext +vX.Y.Z +``` + +Where `X.Y.Z` is a version that follows semantic versioning. For example, +consider a project with the following tags: + +- v1.0.0 +- v1.1.0 +- v2.0.0 + +If the `version` attribute is `2.1.0`, GitLab uses tag v2.0.0. And when the +version is `1.1.1`, or `1.2.0`, GitLab uses tag v1.1.0. + +If `from` is unspecified and no tag to use is found, the API produces an error. +To solve such an error, you must explicitly specify a value for the `from` +attribute. + +### How it works + +Changelogs are generated based on commit titles. Commits are only included if +they contain a specific Git trailer. GitLab uses the value of this trailer to +categorize the changes. + +GitLab uses Git trailers, because Git trailers are +supported by Git out of the box. We use commits as input, as this is the only +source of data every project uses. In addition, commits can be retrieved when +operating on a mirror. This is important for GitLab itself, because during a security +release we might need to include changes from both public projects and private +security mirrors. + +Changelogs are generated by taking the title of the commits to include and using +these as the changelog entries. You can enrich entries with additional data, +such as a link to the merge request or details about the commit author. You can +[customize the format of a changelog](#customize-the-changelog-output) section with a template. + +### Customize the changelog output + +The output is customized using a YAML configuration file stored in your +project's Git repository. This file must reside in +`.gitlab/changelog_config.yml`. + +You can set the following variables in this file: + +- `date_format`: the date format to use in the title of the newly added + changelog data. This uses regular `strftime` formatting. +- `template`: a custom template to use for generating the changelog data. +- `categories`: a hash that maps raw category names to the names to use in the + changelog. + +Using the default settings, generating a changelog results in a section along +the lines of the following: + +```markdown +## 1.0.0 (2021-01-05) + +### Features (4 changes) + +- [Feature 1](gitlab-org/gitlab@123abc) by @alice ([merge request](gitlab-org/gitlab!123)) +- [Feature 2](gitlab-org/gitlab@456abc) ([merge request](gitlab-org/gitlab!456)) +- [Feature 3](gitlab-org/gitlab@234abc) by @steve +- [Feature 4](gitlab-org/gitlab@456) +``` + +Each section starts with a title that contains the version and release date. +While the format of the date can be customized, the rest of the title can't be +changed. When adding a new section, GitLab parses these titles to determine +where in the file the new section should be placed. GitLab sorts sections +according to their versions, not their dates. + +Each section can have categories, each with their +corresponding changes. In the above example, "Features" is one such category. +You can customize the format of these sections. + +The section names are derived from the values of the Git trailer used to include +or exclude commits. + +For example, if the trailer to use is called `Changelog`, +and its value is `feature`, then the commit is grouped in the `feature` +category. The names of these raw values might differ from what you want to +show in a changelog, you can remap them. Let's say we use the `Changelog` +trailer and developers use the following values: `feature`, `bug`, and +`performance`. + +You can remap these using the following YAML configuration file: + +```yaml +--- +categories: + feature: Features + bug: Bug fixes + performance: Performance improvements +``` + +When generating the changelog data, the category titles are then `### Features`, +`### Bug fixes`, and `### Performance improvements`. + +### Custom templates + +The category sections are generated using a template. The default template is as +follows: + +```plaintext +{% if categories %} +{% each categories %} +### {{ title }} ({% if single_change %}1 change{% else %}{{ count }} changes{% end %}) + +{% each entries %} +- [{{ title }}]({{ commit.reference }})\ +{% if author.contributor %} by {{ author.reference }}{% end %}\ +{% if merge_request %} ([merge request]({{ merge_request.reference }})){% end %} + +{% end %} + +{% end %} +{% else %} +No changes. +{% end %} +``` + +The `{% ... %}` tags are for statements, and `{{ ... }}` is used for printing +data. Statements must be terminated using a `{% end %}` tag. Both the `if` and +`each` statements require a single argument. + +For example, if we have a variable `valid`, and we want to display "yes" +when this value is true, and display "nope" otherwise. We can do so as follows: + +```plaintext +{% if valid %} +yes +{% else %} +nope +{% end %} +``` + +The use of `else` is optional. A value is considered true when it's a non-empty +value or boolean `true`. Empty arrays and hashes are considered false. + +Looping is done using `each`, and variables inside a loop are scoped to it. +Referring to the current value in a loop is done using the variable tag `{{ it +}}`. Other variables read their value from the current loop value. Take +this template for example: + +```plaintext +{% each users %} +{{name}} +{% end %} +``` + +Assuming `users` is an array of objects, each with a `name` field, this would +then print the name of every user. + +Using variable tags, you can access nested objects. For example, `{{ +users.0.name }}` prints the name of the first user in the `users` variable. + +If a line ends in a backslash, the next newline is ignored. This allows you to +wrap code across multiple lines, without introducing unnecessary newlines in the +Markdown output. + +Tags that use `{%` and `%}` (known as expression tags) consume the newline that +directly follows them, if any. This means that this: + +```plaintext +--- +{% if foo %} +bar +{% end %} +--- +``` + +Compiles into this: + +```plaintext +--- +bar +--- +``` + +Instead of this: + +```plaintext +--- + +bar + +--- +``` + +You can specify a custom template in your configuration like so: + +```yaml +--- +template: | + {% if categories %} + {% each categories %} + ### {{ title }} + + {% each entries %} + - [{{ title }}]({{ commit.reference }})\ + {% if author.contributor %} by {{ author.reference }}{% end %} + + {% end %} + + {% end %} + {% else %} + No changes. + {% end %} +``` + +Note that when specifying the template you should use `template: |` and not +`template: >`, as the latter doesn't preserve newlines in the template. + +### Template data + +At the top level, the following variable is available: + +- `categories`: an array of objects, one for every changelog category. + +In a category, the following variables are available: + +- `title`: the title of the category (after it has been remapped). +- `count`: the number of entries in this category. +- `single_change`: a boolean that indicates if there is only one change (`true`), + or multiple changes (`false`). +- `entries`: the entries that belong to this category. + +In an entry, the following variables are available (here `foo.bar` means that +`bar` is a sub-field of `foo`): + +- `title`: the title of the changelog entry (this is the commit title). +- `commit.reference`: a reference to the commit, for example, + `gitlab-org/gitlab@0a4cdd86ab31748ba6dac0f69a8653f206e5cfc7`. +- `commit.trailers`: an object containing all the Git trailers that were present + in the commit body. +- `author.reference`: a reference to the commit author (for example, `@alice`). +- `author.contributor`: a boolean set to `true` when the author is an external + contributor, otherwise this is set to `false`. +- `merge_request.reference`: a reference to the merge request that first + introduced the change (for example, `gitlab-org/gitlab!50063`). + +The `author` and `merge_request` objects might not be present if the data +couldn't be determined. For example, when a commit is created without a +corresponding merge request, no merge request is displayed. diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index ce11e5a38b7..19684b4ac0e 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Repository files API +# Repository files API **(FREE)** **CRUD for repository files** diff --git a/doc/api/repository_submodules.md b/doc/api/repository_submodules.md index 9c59920df77..c014bb44861 100644 --- a/doc/api/repository_submodules.md +++ b/doc/api/repository_submodules.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Repository submodules API +# Repository submodules API **(FREE)** > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41213) in GitLab 11.5 diff --git a/doc/api/resource_access_tokens.md b/doc/api/resource_access_tokens.md new file mode 100644 index 00000000000..50f5ea73634 --- /dev/null +++ b/doc/api/resource_access_tokens.md @@ -0,0 +1,107 @@ +--- +stage: Manage +group: Access +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments +--- + +# Project access tokens API + +You can read more about [project access tokens](../user/project/settings/project_access_tokens.md). + +## List project access tokens + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. + +Get a list of project access tokens. + +```plaintext +GET projects/:id/access_tokens +``` + +| Attribute | Type | required | Description | +|-----------|---------|----------|---------------------| +| `id` | integer/string | yes | The ID of the project | + +```shell +curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/<project_id>/access_tokens" +``` + +```json +[ + { + "user_id" : 141, + "scopes" : [ + "api" + ], + "name" : "token", + "expires_at" : "2021-01-31", + "id" : 42, + "active" : true, + "created_at" : "2021-01-20T22:11:48.151Z", + "revoked" : false + } +] +``` + +## Create a project access token + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. + +Create a project access token. + +```plaintext +POST projects/:id/access_tokens +``` + +| Attribute | Type | required | Description | +|-----------|---------|----------|---------------------| +| `name` | String | yes | The name of the project access token | +| `scopes` | Array\[String] | yes | [List of scopes](../user/project/settings/project_access_tokens.md#limiting-scopes-of-a-project-access-token) | +| `expires_at` | Date | no | The token expires at midnight UTC on that date | + +```shell +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ +--header "Content-Type:application/json" \ +--data '{ "name":"test_token", "scopes":["api", "read_repository"], "expires_at":"2021-01-31" }' \ +"https://gitlab.example.com/api/v4/projects/<project_id>/access_tokens" +``` + +```json +{ + "scopes" : [ + "api", + "read_repository" + ], + "active" : true, + "name" : "test", + "revoked" : false, + "created_at" : "2021-01-21T19:35:37.921Z", + "user_id" : 166, + "id" : 58, + "expires_at" : "2021-01-31" +} +``` + +## Revoke a project access token + +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/238991) in GitLab 13.9. + +Revoke a project access token. + +```plaintext +DELETE projects/:id/access_tokens/:token_id +``` + +| Attribute | Type | required | Description | +|-----------|---------|----------|---------------------| +| `id` | integer/string | yes | The ID of the project | +| `token_id` | integer/string | yes | The ID of the project access token | + +```shell +curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/<project_id>/access_tokens/<token_id>" +``` + +### Responses + +- `204: No Content` if successfully revoked. +- `400 Bad Request` or `404 Not Found` if not revoked successfully. diff --git a/doc/api/resource_iteration_events.md b/doc/api/resource_iteration_events.md index 4c351308ae1..91c7a1b07ea 100644 --- a/doc/api/resource_iteration_events.md +++ b/doc/api/resource_iteration_events.md @@ -4,10 +4,11 @@ group: Project Management info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Resource iteration events API **(STARTER)** +# Resource iteration events API **(PREMIUM)** -> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229463) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.4. -> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/229463) in [GitLab Starter](https://about.gitlab.com/pricing/) 13.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/229463) in GitLab 13.4. +> - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/229463) in GitLab 13.5. +> - Moved to GitLab Premium in 13.9. Resource iteration events keep track of what happens to GitLab [issues](../user/project/issues/). diff --git a/doc/api/runners.md b/doc/api/runners.md index 131418de725..1782e236c36 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -575,7 +575,7 @@ Example response: ```json { - "id": "12345", + "id": 12345, "token": "6337ff461c94fd3fa32ba3b1ff4125" } ``` diff --git a/doc/api/scim.md b/doc/api/scim.md index 6e67b6fbc2d..d00a0988d2b 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -5,9 +5,9 @@ group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# SCIM API (SYSTEM ONLY) **(SILVER ONLY)** +# SCIM API (SYSTEM ONLY) **(PREMIUM SAAS)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in [GitLab.com Silver](https://about.gitlab.com/pricing/) 11.10. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in GitLab Premium 11.10. The SCIM API implements the [RFC7644 protocol](https://tools.ietf.org/html/rfc7644). As this API is for **system** use for SCIM provider integration, it is subject to change without notice. diff --git a/doc/api/search.md b/doc/api/search.md index 584b2cbb837..9e1407fdffd 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Search API +# Search API **(FREE)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41763) in GitLab 10.5. > - [Feature flag `search_filter_by_confidential` removed](https://gitlab.com/gitlab-org/gitlab/-/issues/244923) in GitLab 13.6. @@ -31,7 +31,7 @@ GET /search Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, snippet_titles, users. -If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs, notes, and commits. Find more about [the feature](../integration/elasticsearch.md). **(STARTER)** +If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs, notes, and commits. Find more about [the feature](../integration/elasticsearch.md). **(PREMIUM)** The response depends on the requested scope. @@ -266,7 +266,9 @@ Example response: ] ``` -### Scope: wiki_blobs **(STARTER)** +### Scope: wiki_blobs **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -295,7 +297,9 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: commits **(STARTER)** +### Scope: commits **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -328,7 +332,9 @@ Example response: ] ``` -### Scope: blobs **(STARTER)** +### Scope: blobs **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -367,7 +373,9 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: notes **(STARTER)** +### Scope: notes **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -444,7 +452,7 @@ GET /groups/:id/search Search the expression within the specified scope. Currently these scopes are supported: projects, issues, merge_requests, milestones, users. -If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs, notes, and commits. Find more about [the feature](../integration/elasticsearch.md). **(STARTER)** +If Elasticsearch is enabled additional scopes available are blobs, wiki_blobs, notes, and commits. Find more about [the feature](../integration/elasticsearch.md). **(PREMIUM)** The response depends on the requested scope. @@ -648,7 +656,9 @@ Example response: ] ``` -### Scope: wiki_blobs **(STARTER)** +### Scope: wiki_blobs **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -677,7 +687,9 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: commits **(STARTER)** +### Scope: commits **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -710,7 +722,9 @@ Example response: ] ``` -### Scope: blobs **(STARTER)** +### Scope: blobs **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -749,7 +763,9 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the file name and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: notes **(STARTER)** +### Scope: notes **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -998,7 +1014,9 @@ Example response: ] ``` -### Scope: notes **(STARTER)** +### Scope: notes **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -1032,7 +1050,9 @@ Example response: ] ``` -### Scope: wiki_blobs **(STARTER)** +### Scope: wiki_blobs **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -1078,7 +1098,9 @@ Example response: NOTE: `filename` is deprecated in favor of `path`. Both return the full path of the file inside the repository, but in the future `filename` will be only the filename and not the full path. For details, see [issue 34521](https://gitlab.com/gitlab-org/gitlab/-/issues/34521). -### Scope: commits **(STARTER)** +### Scope: commits **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. @@ -1111,7 +1133,9 @@ Example response: ] ``` -### Scope: blobs **(STARTER)** +### Scope: blobs **(PREMIUM)** + +> Moved to GitLab Premium in 13.9. This scope is available only if [Elasticsearch](../integration/elasticsearch.md) is enabled. diff --git a/doc/api/services.md b/doc/api/services.md index d00ddb07a05..16431937c7a 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -748,7 +748,7 @@ Send IRC messages, on update, to a list of recipients through an Irker gateway. Set Irker (IRC gateway) service for a project. NOTE: -Irker does NOT have built-in authentication, which makes it vulnerable to spamming IRC channels if it is hosted outside of a firewall. Please make sure you run the daemon within a secured network to prevent abuse. For more details, read: <http://www.catb.org/~esr/irker/security.html>. +Irker does NOT have built-in authentication, which makes it vulnerable to spamming IRC channels if it is hosted outside of a firewall. Please make sure you run the daemon within a secured network to prevent abuse. For more details, read [Security analysis of `irker`](http://www.catb.org/~esr/irker/security.html). ```plaintext PUT /projects/:id/services/irker @@ -1358,7 +1358,7 @@ Get JetBrains TeamCity CI service settings for a project. GET /projects/:id/services/teamcity ``` -## Jenkins CI **(STARTER)** +## Jenkins CI A continuous integration and build server diff --git a/doc/api/settings.md b/doc/api/settings.md index 264021b3a2d..2fd58917aad 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -4,7 +4,7 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Application settings API **(CORE ONLY)** +# Application settings API **(FREE SELF)** These API calls allow you to read and modify GitLab instance [application settings](#list-of-settings-that-can-be-accessed-via-api-calls) @@ -77,6 +77,7 @@ Example response: "asset_proxy_enabled": true, "asset_proxy_url": "https://assets.example.com", "asset_proxy_whitelist": ["example.com", "*.example.com", "your-instance.com"], + "asset_proxy_allowlist": ["example.com", "*.example.com", "your-instance.com"], "npm_package_requests_forwarding": true, "snippet_size_limit": 52428800, "issues_create_limit": 300, @@ -84,7 +85,8 @@ Example response: "wiki_page_max_content_bytes": 52428800, "require_admin_approval_after_user_signup": false, "personal_access_token_prefix": "GL-", - "rate_limiting_response_text": null + "rate_limiting_response_text": null, + "keep_latest_artifact": true } ``` @@ -166,7 +168,7 @@ Example response: "local_markdown_version": 0, "asset_proxy_enabled": true, "asset_proxy_url": "https://assets.example.com", - "asset_proxy_whitelist": ["example.com", "*.example.com", "your-instance.com"], + "asset_proxy_allowlist": ["example.com", "*.example.com", "your-instance.com"], "geo_node_allowed_ips": "0.0.0.0/0, ::/0", "allow_local_requests_from_hooks_and_services": true, "allow_local_requests_from_web_hooks_and_services": true, @@ -178,7 +180,8 @@ Example response: "wiki_page_max_content_bytes": 52428800, "require_admin_approval_after_user_signup": false, "personal_access_token_prefix": "GL-", - "rate_limiting_response_text": null + "rate_limiting_response_text": null, + "keep_latest_artifact": true } ``` @@ -190,7 +193,7 @@ these parameters: - `geo_status_timeout` - `deletion_adjourned_period` -Example responses: **(PREMIUM ONLY)** +Example responses: **(PREMIUM SELF)** ```json "file_template_project_id": 1, @@ -219,7 +222,8 @@ listed in the descriptions of the relevant settings. | `asset_proxy_enabled` | boolean | no | (**If enabled, requires:** `asset_proxy_url`) Enable proxying of assets. GitLab restart is required to apply changes. | | `asset_proxy_secret_key` | string | no | Shared secret with the asset proxy server. GitLab restart is required to apply changes. | | `asset_proxy_url` | string | no | URL of the asset proxy server. GitLab restart is required to apply changes. | -| `asset_proxy_whitelist` | string or array of strings | no | Assets that match these domain(s) are **not** proxied. Wildcards allowed. Your GitLab installation URL is automatically allowlisted. GitLab restart is required to apply changes. | +| `asset_proxy_whitelist` | string or array of strings | no | (Deprecated: Use `asset_proxy_allowlist` instead) Assets that match these domain(s) are **not** proxied. Wildcards allowed. Your GitLab installation URL is automatically allowlisted. GitLab restart is required to apply changes. | +| `asset_proxy_allowlist` | string or array of strings | no | Assets that match these domain(s) are **not** proxied. Wildcards allowed. Your GitLab installation URL is automatically allowlisted. GitLab restart is required to apply changes. | | `authorized_keys_enabled` | boolean | no | By default, we write to the `authorized_keys` file to support Git over SSH without additional configuration. GitLab can be optimized to authenticate SSH keys via the database file. Only disable this if you have configured your OpenSSH server to use the AuthorizedKeysCommand. | | `auto_devops_domain` | string | no | Specify a domain to use by default for every project's Auto Review Apps and Auto Deploy stages. | | `auto_devops_enabled` | boolean | no | Enable Auto DevOps for projects by default. It automatically builds, tests, and deploys applications based on a predefined CI/CD configuration. | @@ -235,7 +239,7 @@ listed in the descriptions of the relevant settings. | `default_project_visibility` | string | no | What visibility level new projects receive. Can take `private`, `internal` and `public` as a parameter. Default is `private`. | | `default_projects_limit` | integer | no | Project limit per user. Default is `100000`. | | `default_snippet_visibility` | string | no | What visibility level new snippets receive. Can take `private`, `internal` and `public` as a parameter. Default is `private`. | -| `deletion_adjourned_period` | integer | no | **(PREMIUM ONLY)** The number of days to wait before deleting a project or group that is marked for deletion. Value must be between 0 and 90. +| `deletion_adjourned_period` | integer | no | **(PREMIUM SELF)** The number of days to wait before deleting a project or group that is marked for deletion. Value must be between 0 and 90. | `diff_max_patch_bytes` | integer | no | Maximum diff patch size (Bytes). | | `disable_feed_token` | boolean | no | Disable display of RSS/Atom and calendar feed tokens ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/231493) in GitLab 13.7) | | `disabled_oauth_sign_in_sources` | array of strings | no | Disabled OAuth sign-in sources. | @@ -280,6 +284,7 @@ listed in the descriptions of the relevant settings. | `first_day_of_week` | integer | no | Start day of the week for calendar views and date pickers. Valid values are `0` (default) for Sunday, `1` for Monday, and `6` for Saturday. | | `geo_node_allowed_ips` | string | yes | **(PREMIUM)** Comma-separated list of IPs and CIDRs of allowed secondary nodes. For example, `1.1.1.1, 2.2.2.0/24`. | | `geo_status_timeout` | integer | no | **(PREMIUM)** The amount of seconds after which a request to get a secondary node status times out. | +| `git_two_factor_session_expiry` | integer | no | **(PREMIUM)** Maximum duration (in minutes) of a session for Git operations when 2FA is enabled. | | `gitaly_timeout_default` | integer | no | Default Gitaly timeout, in seconds. This timeout is not enforced for Git fetch/push operations or Sidekiq jobs. Set to `0` to disable timeouts. | | `gitaly_timeout_fast` | integer | no | Gitaly fast operation timeout, in seconds. Some Gitaly operations are expected to be fast. If they exceed this threshold, there may be a problem with a storage shard and 'failing fast' can help maintain the stability of the GitLab instance. Set to `0` to disable timeouts. | | `gitaly_timeout_medium` | integer | no | Medium Gitaly timeout, in seconds. This should be a value between the Fast and the Default timeout. Set to `0` to disable timeouts. | @@ -300,22 +305,22 @@ listed in the descriptions of the relevant settings. | `housekeeping_incremental_repack_period` | integer | required by: `housekeeping_enabled` | Number of Git pushes after which an incremental `git repack` is run. | | `html_emails_enabled` | boolean | no | Enable HTML emails. | | `import_sources` | array of strings | no | Sources to allow project import from, possible values: `github`, `bitbucket`, `bitbucket_server`, `gitlab`, `fogbugz`, `git`, `gitlab_project`, `gitea`, `manifest`, and `phabricator`. | -| `invisible_captcha_enabled` | boolean | no | Enable Invisible Captcha spam detection during signup. Disabled by default. | +| `invisible_captcha_enabled` | boolean | no | <!-- vale gitlab.Spelling = NO --> Enable Invisible Captcha <!-- vale gitlab.Spelling = YES --> spam detection during sign-up. Disabled by default. | | `issues_create_limit` | integer | no | Max number of issue creation requests per minute per user. Disabled by default.| | `local_markdown_version` | integer | no | Increase this value when any cached Markdown should be invalidated. | | `maintenance_mode_message` | string | no | **(PREMIUM)** Message displayed when instance is in maintenance mode | -| `maintenance_mode` | boolean | no | **(PREMIUM)** When instance is in maintenance mode, non-admin users can sign in with read-only access and make read-only API requests | +| `maintenance_mode` | boolean | no | **(PREMIUM)** When instance is in maintenance mode, non-administrative users can sign in with read-only access and make read-only API requests | | `max_artifacts_size` | integer | no | Maximum artifacts size in MB | | `max_attachment_size` | integer | no | Limit attachment size in MB | -| `max_import_size` | integer | no | Maximum import size in MB. 0 for unlimited. Default = 0 (unlimited) | +| `max_import_size` | integer | no | Maximum import size in MB. 0 for unlimited. Default = 0 (unlimited) [Modified](https://gitlab.com/gitlab-org/gitlab/-/issues/251106) from 50MB to 0 in GitLab 13.8. | | `max_pages_size` | integer | no | Maximum size of pages repositories in MB | -| `max_personal_access_token_lifetime` | integer | no | **(ULTIMATE ONLY)** Maximum allowable lifetime for personal access tokens in days | +| `max_personal_access_token_lifetime` | integer | no | **(ULTIMATE SELF)** Maximum allowable lifetime for personal access tokens in days | | `metrics_method_call_threshold` | integer | no | A method call is only tracked when it takes longer than the given amount of milliseconds. | | `mirror_available` | boolean | no | Allow repository mirroring to configured by project Maintainers. If disabled, only Admins can configure repository mirroring. | | `mirror_capacity_threshold` | integer | no | **(PREMIUM)** Minimum capacity to be available before scheduling more mirrors preemptively | | `mirror_max_capacity` | integer | no | **(PREMIUM)** Maximum number of mirrors that can be synchronizing at the same time. | | `mirror_max_delay` | integer | no | **(PREMIUM)** Maximum time (in minutes) between updates that a mirror can have when scheduled to synchronize. | -| `npm_package_requests_forwarding` | boolean | no | **(PREMIUM)** Use npmjs.org as a default remote repository when the package is not found in the GitLab NPM Registry | +| `npm_package_requests_forwarding` | boolean | no | **(PREMIUM)** Use npmjs.org as a default remote repository when the package is not found in the GitLab Package Registry for npm | | `outbound_local_requests_whitelist` | array of strings | no | Define a list of trusted domains or IP addresses to which local requests are allowed when local requests for hooks and services are disabled. | `pages_domain_verification_enabled` | boolean | no | Require users to prove ownership of custom domains. Domain verification is an essential security measure for public GitLab sites. Users are required to demonstrate they control a domain before it is enabled. | | `password_authentication_enabled_for_git` | boolean | no | Enable authentication for Git over HTTP(S) via a GitLab account password. Default is `true`. | @@ -341,7 +346,7 @@ listed in the descriptions of the relevant settings. | `receive_max_input_size` | integer | no | Maximum push size (MB). | | `repository_checks_enabled` | boolean | no | GitLab periodically runs `git fsck` in all project and wiki repositories to look for silent disk corruption issues. | | `repository_size_limit` | integer | no | **(PREMIUM)** Size limit per repository (MB) | -| `repository_storages_weighted` | hash of strings to integers | no | (GitLab 13.1 and later) Hash of names of taken from `gitlab.yml` to [weights](../administration/repository_storage_paths.md#choose-where-new-repositories-are-stored). New projects are created in one of these stores, chosen by a weighted random selection. | +| `repository_storages_weighted` | hash of strings to integers | no | (GitLab 13.1 and later) Hash of names of taken from `gitlab.yml` to [weights](../administration/repository_storage_paths.md#configure-where-new-repositories-are-stored). New projects are created in one of these stores, chosen by a weighted random selection. | | `repository_storages` | array of strings | no | (GitLab 13.0 and earlier) List of names of enabled storage paths, taken from `gitlab.yml`. New projects are created in one of these stores, chosen at random. | | `require_admin_approval_after_user_signup` | boolean | no | When enabled, any user that signs up for an account using the registration form is placed under a **Pending approval** state and has to be explicitly [approved](../user/admin_area/approving_users.md) by an administrator. | | `require_two_factor_authentication` | boolean | no | (**If enabled, requires:** `two_factor_grace_period`) Require all users to set up Two-factor authentication. | diff --git a/doc/api/sidekiq_metrics.md b/doc/api/sidekiq_metrics.md index 2f018e67628..4791f066cd2 100644 --- a/doc/api/sidekiq_metrics.md +++ b/doc/api/sidekiq_metrics.md @@ -4,7 +4,7 @@ group: unassigned info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- -# Sidekiq Metrics API **(CORE ONLY)** +# Sidekiq Metrics API **(FREE SELF)** > Introduced in GitLab 8.9. diff --git a/doc/api/snippet_repository_storage_moves.md b/doc/api/snippet_repository_storage_moves.md index f60b1dfb449..393ca30c28d 100644 --- a/doc/api/snippet_repository_storage_moves.md +++ b/doc/api/snippet_repository_storage_moves.md @@ -5,7 +5,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference --- -# Snippet repository storage moves API **(CORE ONLY)** +# Snippet repository storage moves API **(FREE SELF)** > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/49228) in GitLab 13.8. @@ -30,11 +30,10 @@ read-only. Please try again later.` message if they try to push new commits. This API requires you to [authenticate yourself](README.md#authentication) as an administrator. -Project repositories can be moved using the [Project repository storage moves API](project_repository_storage_moves.md). +For other repository types see: -## Limitations - -- Group-level wikis [can't be moved with the API](https://gitlab.com/gitlab-org/gitlab/-/issues/219003). +- [Project repository storage moves API](project_repository_storage_moves.md). +- [Group repository storage moves API](group_repository_storage_moves.md). ## Retrieve all snippet repository storage moves diff --git a/doc/api/suggestions.md b/doc/api/suggestions.md index 9f878cd029a..0fcb6122505 100644 --- a/doc/api/suggestions.md +++ b/doc/api/suggestions.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Suggest Changes API +# Suggest Changes API **(FREE)** Every API call to suggestions must be authenticated. @@ -21,6 +21,7 @@ PUT /suggestions/:id/apply | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID of a suggestion | +| `commit_message` | string | no | A custom commit message to use instead of the default generated message or the project's default message | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/suggestions/5/apply" diff --git a/doc/api/tags.md b/doc/api/tags.md index 126bc010022..eef4504aa5b 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -5,7 +5,7 @@ info: "To determine the technical writer assigned to the Stage/Group associated type: reference, api --- -# Tags API +# Tags API **(FREE)** ## List project repository tags @@ -123,7 +123,7 @@ Parameters: | `tag_name` | string | yes | The name of a tag | | `ref` | string | yes | Create tag using commit SHA, another tag name, or branch name | | `message` | string | no | Creates annotated tag | -| `release_description` | string | no | Add release notes to the Git tag and store it in the GitLab database | +| `release_description` | string | no | This parameter is [deprecated](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) for use in GitLab 11.7, and is planned for [removal](https://gitlab.com/gitlab-org/gitlab/-/issues/290311) in GitLab 14.0. Use the [Releases API](../api/releases/index.md) instead. | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/repository/tags?tag_name=test&ref=master" @@ -186,6 +186,11 @@ Parameters: ## Create a new release +WARNING: +This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) +for use in GitLab 11.7, and is planned for [removal](https://gitlab.com/gitlab-org/gitlab/-/issues/290311) +in GitLab 14.0. Use the [Releases API](../api/releases/index.md) instead. + Add release notes to the existing Git tag. If there already exists a release for the given tag, status code `409` is returned. @@ -221,6 +226,11 @@ Response: ## Update a release +WARNING: +This feature is in its end-of-life process. It is [deprecated](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/41766) +for use in GitLab 11.7, and is planned for [removal](https://gitlab.com/gitlab-org/gitlab/-/issues/290311) +in GitLab 14.0. Use the [Releases API](../api/releases/index.md) instead. + Updates the release notes of a given release. ```plaintext diff --git a/doc/api/todos.md b/doc/api/todos.md index 203d1bc6f03..3b2e3acb38b 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -10,8 +10,9 @@ info: To determine the technical writer assigned to the Stage/Group associated w ## Get a list of to dos -Returns a list of to dos. When no filter is applied, it returns all pending to dos -for the current user. Different filters allow the user to precise the request. +Returns a list of [to-do items](../user/todos.md). When no filter is applied, it +returns all pending to-do items for the current user. Different filters allow the +user to refine the request. ```plaintext GET /todos diff --git a/doc/api/users.md b/doc/api/users.md index ecfd8e26626..76b0bb3491c 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -1,6 +1,6 @@ --- -stage: none -group: unassigned +stage: Manage +group: Access info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments --- @@ -65,7 +65,7 @@ GET /users?active=true GET /users?blocked=true ``` -GitLab supports bot users such as the [alert bot](../operations/incident_management/alert_integrations.md) +GitLab supports bot users such as the [alert bot](../operations/incident_management/integrations.md) or the [support bot](../user/project/service_desk.md#support-bot-user). To exclude these users from the users' list, you can use the parameter `exclude_internal=true` ([introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241144) in GitLab 13.4). @@ -88,7 +88,7 @@ GET /users | `order_by` | string | no | Return users ordered by `id`, `name`, `username`, `created_at`, or `updated_at` fields. Default is `id` | | `sort` | string | no | Return users sorted in `asc` or `desc` order. Default is `desc` | | `two_factor` | string | no | Filter users by Two-factor authentication. Filter values are `enabled` or `disabled`. By default it returns all users | -| `without_projects` | boolean | no | Filter users without projects. Default is `false` | +| `without_projects` | boolean | no | Filter users without projects. Default is `false`, which means that all users are returned, with and without projects. | | `admins` | boolean | no | Return only admin users. Default is `false` | ```json @@ -171,7 +171,7 @@ GET /users ] ``` -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, and `using_license_seat` parameters. +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, `extra_shared_runners_minutes_limit`, and `using_license_seat` parameters. ```json [ @@ -186,7 +186,7 @@ Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) ] ``` -Users on GitLab [Silver or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `group_saml` provider option: ```json @@ -217,7 +217,9 @@ For example: GET /users?extern_uid=1234567&provider=github ``` -You can search for users who are external with: `/users?external=true` +Instance administrators can search for users who are external with: `/users?external=true` + +You cannot search for external users if you are not an instance administrator. You can search users by creation date time range with: @@ -264,6 +266,7 @@ Parameters: "created_at": "2012-05-23T08:00:58Z", "bio": "", "bio_html": "", + "bot": false, "location": null, "public_email": "john@example.com", "skype": "", @@ -271,7 +274,9 @@ Parameters: "twitter": "", "website_url": "", "organization": "", - "job_title": "Operations Specialist" + "job_title": "Operations Specialist", + "followers": 1, + "following": 1 } ``` @@ -337,7 +342,7 @@ Example Responses: NOTE: The `plan` and `trial` parameters are only available on GitLab Enterprise Edition. -Users on GitLab [Starter, Bronze, or higher](https://about.gitlab.com/pricing/) also see +Users on GitLab [Premium or higher](https://about.gitlab.com/pricing/) also see the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` parameters. ```json @@ -350,7 +355,7 @@ the `shared_runners_minutes_limit`, and `extra_shared_runners_minutes_limit` par } ``` -Users on GitLab.com [Silver, or higher](https://about.gitlab.com/pricing/) also +Users on GitLab.com [Premium or higher](https://about.gitlab.com/pricing/) also see the `group_saml` option: ```json @@ -623,7 +628,8 @@ Example response: { "emoji":"coffee", "message":"I crave coffee :coffee:", - "message_html": "I crave coffee <gl-emoji title=\"hot beverage\" data-name=\"coffee\" data-unicode-version=\"4.0\">☕</gl-emoji>" + "message_html": "I crave coffee <gl-emoji title=\"hot beverage\" data-name=\"coffee\" data-unicode-version=\"4.0\">☕</gl-emoji>", + "clear_status_at": null } ``` @@ -649,7 +655,8 @@ Example response: { "emoji":"coffee", "message":"I crave coffee :coffee:", - "message_html": "I crave coffee <gl-emoji title=\"hot beverage\" data-name=\"coffee\" data-unicode-version=\"4.0\">☕</gl-emoji>" + "message_html": "I crave coffee <gl-emoji title=\"hot beverage\" data-name=\"coffee\" data-unicode-version=\"4.0\">☕</gl-emoji>", + "clear_status_at": null } ``` @@ -661,15 +668,16 @@ Set the status of the current user. PUT /user/status ``` -| Attribute | Type | Required | Description | -| --------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `emoji` | string | no | The name of the emoji to use as status. If omitted `speech_balloon` is used. Emoji name can be one of the specified names in the [Gemojione index](https://github.com/bonusly/gemojione/blob/master/config/index.json). | -| `message` | string | no | The message to set as a status. It can also contain emoji codes. | +| Attribute | Type | Required | Description | +| -------------------- | ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `emoji` | string | no | The name of the emoji to use as status. If omitted `speech_balloon` is used. Emoji name can be one of the specified names in the [Gemojione index](https://github.com/bonusly/gemojione/blob/master/config/index.json). | +| `message` | string | no | The message to set as a status. It can also contain emoji codes. | +| `clear_status_after` | string | no | Automatically clean up the status after a given time interval, allowed values: `30_minutes`, `3_hours`, `8_hours`, `1_day`, `3_days`, `7_days`, `30_days` -When both parameters `emoji` and `message` are empty, the status is cleared. +When both parameters `emoji` and `message` are empty, the status is cleared. When the `clear_status_after` parameter is missing from the request, the previously set value for `"clear_status_after` is cleared. ```shell -curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "emoji=coffee" --data "message=I crave coffee" "https://gitlab.example.com/api/v4/user/status" +curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "clear_status_after=1_day" --data "emoji=coffee" --data "message=I crave coffee" "https://gitlab.example.com/api/v4/user/status" ``` Example responses @@ -678,10 +686,93 @@ Example responses { "emoji":"coffee", "message":"I crave coffee", - "message_html": "I crave coffee" + "message_html": "I crave coffee", + "clear_status_at":"2021-02-15T10:49:01.311Z" +} +``` + +## User Follow + +### Follow and unfollow users + +Follow a user. + +```plaintext +POST /users/:id/follow +``` + +Unfollow a user. + +```plaintext +POST /users/:id/unfollow +``` + +| Attribute | Type | Required | Description | +| --------- | ------- | -------- | ---------------------------- | +| `id` | integer | yes | The ID of the user to follow | + +```shell +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/users/3/follow" +``` + +Example response: + +```json +{ + "id": 1, + "username": "john_smith", + "name": "John Smith", + "state": "active", + "avatar_url": "http://localhost:3000/uploads/user/avatar/1/cd8.jpeg", + "web_url": "http://localhost:3000/john_smith" } ``` +### Followers and following + +Get the followers of a user. + +```plaintext +GET /users/:id/followers +``` + +Get the list of users being followed. + +```plaintext +GET /users/:id/following +``` + +| Attribute | Type | Required | Description | +| --------- | ------- | -------- | ---------------------------- | +| `id` | integer | yes | The ID of the user to follow | + +```shell +curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/users/3/followers" +``` + +Example response: + +```json +[ + { + "id": 2, + "name": "Lennie Donnelly", + "username": "evette.kilback", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/7955171a55ac4997ed81e5976287890a?s=80&d=identicon", + "web_url": "http://127.0.0.1:3000/evette.kilback" + }, + { + "id": 4, + "name": "Serena Bradtke", + "username": "cammy", + "state": "active", + "avatar_url": "https://www.gravatar.com/avatar/a2daad869a7b60d3090b7b9bef4baf57?s=80&d=identicon", + "web_url": "http://127.0.0.1:3000/cammy" + } +] +``` + ## User counts Get the counts (same as in top right menu) of the currently signed in user. @@ -1374,7 +1465,7 @@ Example Responses: ``` ```json -{ "message": "The user you are trying to approve is not pending an approval" } +{ "message": "The user you are trying to approve is not pending approval" } ``` ## Get an impersonation token of a user @@ -1481,7 +1572,7 @@ Parameters: | `user_id` | integer | yes | The ID of the user | | `impersonation_token_id` | integer | yes | The ID of the impersonation token | -## Create a personal access token **(CORE ONLY)** +## Create a personal access token **(FREE SELF)** > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/17176) in GitLab 13.6. > - [Feature flag removed](https://gitlab.com/gitlab-org/gitlab/-/issues/267553) in GitLab 13.8. diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md index 00e70d34db6..c63a04228a5 100644 --- a/doc/api/v3_to_v4.md +++ b/doc/api/v3_to_v4.md @@ -71,7 +71,7 @@ Below are the changes made between V3 and V4. - Notes do not return deprecated field `upvote` and `downvote` [!9384](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9384) - Return HTTP status code `400` for all validation errors when creating or updating a member instead of sometimes `422` error. [!9523](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9523) - Remove `GET /groups/owned`. Use `GET /groups?owned=true` instead [!9505](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9505) -- Return 202 with JSON body on async removals on V4 API (`DELETE /projects/:id/repository/merged_branches` and `DELETE /projects/:id`) [!9449](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9449) +- Return 202 with JSON body on asynchronous removals on V4 API (`DELETE /projects/:id/repository/merged_branches` and `DELETE /projects/:id`) [!9449](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9449) - `GET /projects/:id/milestones?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!9096](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9096) - Return basic information about pipeline in `GET /projects/:id/pipelines` [!8875](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8875) - Renamed all `build` references to `job` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9463) diff --git a/doc/api/visual_review_discussions.md b/doc/api/visual_review_discussions.md index 67d9c523862..c3414a4e9ec 100644 --- a/doc/api/visual_review_discussions.md +++ b/doc/api/visual_review_discussions.md @@ -5,9 +5,10 @@ info: To determine the technical writer assigned to the Stage/Group associated w type: reference, api --- -# Visual Review discussions API **(STARTER)** +# Visual Review discussions API **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18710) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.5. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18710) in GitLab 12.5. +> - [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9. Visual Review discussions are notes on Merge Requests sent as feedback from [Visual Reviews](../ci/review_apps/index.md#visual-reviews). diff --git a/doc/api/vulnerability_exports.md b/doc/api/vulnerability_exports.md index e4853920cab..f70662c7c61 100644 --- a/doc/api/vulnerability_exports.md +++ b/doc/api/vulnerability_exports.md @@ -37,7 +37,7 @@ POST /security/projects/:id/vulnerability_exports | `id` | integer or string | yes | The ID or [URL-encoded path](README.md#namespaced-path-encoding) of the project which the authenticated user is a member of | ```shell -curl --header POST "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/vulnerability_exports" +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/projects/1/vulnerability_exports" ``` The created vulnerability export is automatically deleted after 1 hour. @@ -83,7 +83,7 @@ POST /security/groups/:id/vulnerability_exports | `id` | integer or string | yes | The ID or [URL-encoded path](README.md#namespaced-path-encoding) of the group which the authenticated user is a member of | ```shell -curl --header POST "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/groups/1/vulnerability_exports" +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/groups/1/vulnerability_exports" ``` The created vulnerability export is automatically deleted after 1 hour. @@ -116,7 +116,7 @@ POST /security/vulnerability_exports ``` ```shell -curl --header POST "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/vulnerability_exports" +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/security/vulnerability_exports" ``` The created vulnerability export is automatically deleted after one hour. diff --git a/doc/api/wikis.md b/doc/api/wikis.md index dfbedc9bfd1..43587da9473 100644 --- a/doc/api/wikis.md +++ b/doc/api/wikis.md @@ -1,6 +1,6 @@ --- stage: Create -group: Knowledge +group: Editor info: "To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments" type: reference, api --- @@ -175,9 +175,9 @@ POST /projects/:id/wikis/attachments | `file` | string | yes | The attachment to be uploaded | | `branch` | string | no | The name of the branch. Defaults to the wiki repository default branch | -To upload a file from your filesystem, use the `--form` argument. This causes +To upload a file from your file system, use the `--form` argument. This causes cURL to post data using the header `Content-Type: multipart/form-data`. -The `file=` parameter must point to a file on your filesystem and be preceded +The `file=` parameter must point to a file on your file system and be preceded by `@`. For example: ```shell |