diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-02 21:11:20 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-03-02 21:11:20 +0300 |
commit | bf2439c21308c74e437b872180046b39a61734b5 (patch) | |
tree | d6f1fe33eb4b726e4e9f11350b8838dae2fc53f4 /doc | |
parent | 426384d091a0c229ff849ed6ba481bfbe700fb6a (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/audit_events.md | 2 | ||||
-rw-r--r-- | doc/administration/geo/replication/datatypes.md | 18 | ||||
-rw-r--r-- | doc/administration/geo/replication/version_specific_updates.md | 9 | ||||
-rw-r--r-- | doc/administration/pages/index.md | 20 | ||||
-rw-r--r-- | doc/api/graphql/index.md | 50 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 722 | ||||
-rw-r--r-- | doc/api/graphql/removed_items.md | 2 | ||||
-rw-r--r-- | doc/development/api_graphql_styleguide.md | 21 | ||||
-rw-r--r-- | doc/development/changelog.md | 2 | ||||
-rw-r--r-- | doc/development/feature_flags/development.md | 16 | ||||
-rw-r--r-- | doc/install/installation.md | 5 | ||||
-rw-r--r-- | doc/install/requirements.md | 2 | ||||
-rw-r--r-- | doc/subscriptions/gitlab_com/index.md | 4 | ||||
-rw-r--r-- | doc/user/abuse_reports.md | 4 | ||||
-rw-r--r-- | doc/user/group/saml_sso/index.md | 7 | ||||
-rw-r--r-- | doc/user/group/saml_sso/scim_setup.md | 5 | ||||
-rw-r--r-- | doc/user/packages/pypi_repository/index.md | 10 |
17 files changed, 521 insertions, 378 deletions
diff --git a/doc/administration/audit_events.md b/doc/administration/audit_events.md index d5755474c00..9aa533d54f6 100644 --- a/doc/administration/audit_events.md +++ b/doc/administration/audit_events.md @@ -167,7 +167,7 @@ It may make the user interface for your project or audit events very busy, and t to prevent performance degradations on GitLab instances with very high Git write traffic. In an upcoming release, Audit Events for Git push events will be enabled -by default. Follow [#7865](https://gitlab.com/gitlab-org/gitlab/-/issues/7865) for updates. +by default. Follow our [Partitioning strategy for Audit Events epic](https://gitlab.com/groups/gitlab-org/-/epics/3206) for updates. If you still wish to enable **Repository push** events in your instance, follow the steps bellow. diff --git a/doc/administration/geo/replication/datatypes.md b/doc/administration/geo/replication/datatypes.md index f2913dd55ce..aae31e5cd9d 100644 --- a/doc/administration/geo/replication/datatypes.md +++ b/doc/administration/geo/replication/datatypes.md @@ -45,8 +45,8 @@ verification methods: | Blobs | Archived CI build traces _(object storage)_ | Geo with API/Managed (*2*) | _Not implemented_ | | Blobs | Container registry _(file system)_ | Geo with API/Docker API | _Not implemented_ | | Blobs | Container registry _(object storage)_ | Geo with API/Managed/Docker API (*2*) | _Not implemented_ | -| Blobs | Package registry _(file system)_ | Geo with API | _Not implemented_ | -| Blobs | Package registry _(object storage)_ | Geo with API/Managed (*2*) | _Not implemented_ | +| Blobs | Package registry _(file system)_ | Geo with API | SHA256 checksum | +| Blobs | Package registry _(object storage)_ | Geo with API/Managed (*2*) | SHA256 checksum | | Blobs | Versioned Terraform State _(file system)_ | Geo with API | _Not implemented_ | | Blobs | Versioned Terraform State _(object storage)_ | Geo with API/Managed (*2*) | _Not implemented_ | | Blobs | External Merge Request Diffs _(file system)_ | Geo with API | _Not implemented_ | @@ -186,13 +186,13 @@ successfully, you must replicate their data using some other means. | [Container Registry](../../packages/container_registry.md) | **Yes** (12.3) | No | No | Disabled by default. See [instructions](docker_registry.md) to enable. | | [Content in object storage (beta)](object_storage.md) | **Yes** (12.4) | [No](https://gitlab.com/gitlab-org/gitlab/-/issues/13845) | No | | | [Project designs repository](../../../user/project/issues/design_management.md) | **Yes** (12.7) | [No](https://gitlab.com/gitlab-org/gitlab/-/issues/32467) | Via Object Storage provider if supported. Native Geo support (Beta). | | -| [Package Registry for npm](../../../user/packages/npm_registry/index.md) | **Yes** (13.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | -| [Package Registry for Maven](../../../user/packages/maven_repository/index.md) | **Yes** (13.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | -| [Package Registry for Conan](../../../user/packages/conan_repository/index.md) | **Yes** (13.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | -| [Package Registry for NuGet](../../../user/packages/nuget_repository/index.md) | **Yes** (13.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | -| [Package Registry for PyPI](../../../user/packages/pypi_repository/index.md) | **Yes** (13.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | -| [Package Registry for Composer](../../../user/packages/composer_repository/index.md) | **Yes** (13.2) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | -| [Package Registry for generic packages](../../../user/packages/generic_packages/index.md) | **Yes** (13.5) | [No](https://gitlab.com/groups/gitlab-org/-/epics/1817) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for npm](../../../user/packages/npm_registry/index.md) | **Yes** (13.2) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for Maven](../../../user/packages/maven_repository/index.md) | **Yes** (13.2) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for Conan](../../../user/packages/conan_repository/index.md) | **Yes** (13.2) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for NuGet](../../../user/packages/nuget_repository/index.md) | **Yes** (13.2) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for PyPI](../../../user/packages/pypi_repository/index.md) | **Yes** (13.2) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for Composer](../../../user/packages/composer_repository/index.md) | **Yes** (13.2) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | +| [Package Registry for generic packages](../../../user/packages/generic_packages/index.md) | **Yes** (13.5) | **Yes** (13.10) | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_package_file_replication`, enabled by default | | [Versioned Terraform State](../../terraform_state.md) | **Yes** (13.5) | No | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_terraform_state_version_replication`, enabled by default | | [External merge request diffs](../../merge_request_diffs.md) | **Yes** (13.5) | No | Via Object Storage provider if supported. Native Geo support (Beta). | Behind feature flag `geo_merge_request_diff_replication`, enabled by default | | [Versioned snippets](../../../user/snippets.md#versioned-snippets) | [**Yes** (13.7)](https://gitlab.com/groups/gitlab-org/-/epics/2809) | [No](https://gitlab.com/groups/gitlab-org/-/epics/2810) | No | | diff --git a/doc/administration/geo/replication/version_specific_updates.md b/doc/administration/geo/replication/version_specific_updates.md index be2ce0ac2c0..f0d8d7a86ba 100644 --- a/doc/administration/geo/replication/version_specific_updates.md +++ b/doc/administration/geo/replication/version_specific_updates.md @@ -11,6 +11,15 @@ Review this page for update instructions for your version. These steps accompany the [general steps](updating_the_geo_nodes.md#general-update-steps) for updating Geo nodes. +## Updating to GitLab 13.9 + +We've detected an issue [with a column rename](https://gitlab.com/gitlab-org/gitlab/-/issues/322991) +that prevents regular downtime upgrades to GitLab 13.9.0 and 13.9.1. Zero-downtime upgrades are not +affected. We are working on a patch and recommend delaying any upgrade attempt until a fixed version +is released. + +More details are available [in this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/322991). + ## Updating to GitLab 13.7 We've detected an issue with the `FetchRemove` call used by Geo secondaries. diff --git a/doc/administration/pages/index.md b/doc/administration/pages/index.md index 576441c37ca..33977695ff4 100644 --- a/doc/administration/pages/index.md +++ b/doc/administration/pages/index.md @@ -247,6 +247,7 @@ control over how the Pages daemon runs and serves content in your environment. | `log_directory` | Absolute path to a log directory. | | `log_format` | The log output format: `text` or `json`. | | `log_verbose` | Verbose logging, true/false. | +| `propagate_correlation_id` | Set to true (false by default) to re-use existing Correlation ID from the incoming request header `X-Request-ID` if present. If a reverse proxy sets this header, the value will be propagated in the request chain. | | `max_connections` | Limit on the number of concurrent connections to the HTTP, HTTPS or proxy listeners. | | `metrics_address` | The address to listen on for metrics requests. | | `redirect_http` | Redirect pages from HTTP to HTTPS, true/false. | @@ -526,6 +527,25 @@ Follow the steps below to configure verbose logging of GitLab Pages daemon. 1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). +## Propagating the correlation ID + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-pages/-/merge_requests/438) in GitLab 13.10. + +Setting the `propagate_correlation_id` to true will allow installations behind a reverse proxy generate +and set a correlation ID to requests sent to GitLab Pages. When a reverse proxy sets the header value `X-Request-ID`, +the value will be propagated in the request chain. +Users [can find the correlation ID in the logs](../troubleshooting/tracing_correlation_id.md#identify-the-correlation-id-for-a-request). + +To enable the correlation ID: + +1. Set the parameter to true in `/etc/gitlab/gitlab.rb`: + + ```ruby + gitlab_pages['propagate_correlation_id'] = true + ``` + +1. [Reconfigure GitLab](../restart_gitlab.md#omnibus-gitlab-reconfigure). + ## Change storage path Follow the steps below to change the default path where GitLab Pages' contents diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index 726c448c33b..7057bb68487 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -65,27 +65,49 @@ There are no plans to deprecate the REST API. To reduce the technical burden of supporting two APIs in parallel, they should share implementations as much as possible. -### Deprecation process +## Breaking changes -Fields marked for removal from the GitLab GraphQL API are first **deprecated** but still available -for at least six releases, and then **removed entirely**. -Removals occur at X.0 and X.6 releases. +The GitLab GraphQL API is [versionless](https://graphql.org/learn/best-practices/#versioning) and +changes are made to the API in a way that maintains backwards-compatibility. -For example, a field can be marked as deprecated (but still usable) in %12.7, but can be used until its removal in %13.6. -When marked as deprecated, an alternative should be provided if there is one. -That gives consumers of the GraphQL API a minimum of six months to update their GraphQL queries. +Occassionally GitLab needs to change the GraphQL API in a way that is not backwards-compatible. +These changes include the removal or renaming of fields, arguments or other parts of the schema. -The process is as follows: +In these situations, GitLab follows a [Deprecation and removal process](#deprecation-and-removal-process) +where the deprecated part of the schema is supported for a period of time before being removed. -1. The field is listed as deprecated in [GraphQL API Reference](reference/index.md). -1. Removals are announced at least one release prior in the Deprecation Warnings section of the - release post (at or prior to X.11 and X.5 releases). -1. Fields meeting criteria are removed in X.0 or X.6. +Clients should familiarize themselves with the process to avoid breaking changes affecting their integrations. NOTE: Fields behind a feature flag and disabled by default are exempt from the deprecation process, and can be removed at any time without notice. +### Deprecation and Removal process + +Parts of the schema marked for removal from the GitLab GraphQL API are first **deprecated** but still available +for at least six releases, and then **removed entirely**. +Removals occur at `X.0` and `X.6` releases. + +The process is as follows: + +1. The item is marked as deprecated in the schema. It will be displayed as deprecated in the + [GraphQL API Reference](reference/index.md) and in introspection queries. +1. Removals are announced at least one release prior in the [Deprecations](https://about.gitlab.com/handbook/marketing/blog/release-posts/#deprecations) + section of the release post (at or prior to `X.11` and `X.5` releases). + release post (at or prior to `X.11` and `X.5` releases). +1. Items meeting criteria are removed in `X.0` or `X.6` and added to: + + - The [Removals](https://about.gitlab.com/handbook/marketing/blog/release-posts/#removals) section of the Release Post. + - The [Removed items page](removed_items.md). + +This gives consumers of the GraphQL API a minimum of six months to update their GraphQL queries. + +When an item is deprecated or removed, an alternative is provided if available. + +**Example:** + +A field marked as deprecated in `12.7` can be used until its removal in `13.6`. + ### List of removed items View the [fields, enums, and other items we removed](removed_items.md) from the GraphQL API. @@ -147,8 +169,10 @@ 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. +NOTE: The complexity limits may be revised in future, and additionally, the complexity -of a query may be altered. +of a query may be altered. Changes to complexity can happen on `X.0` or `X.6` +releases without a deprecation period. ### Request timeout diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 059c2985d8b..62472b4590b 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -21,298 +21,344 @@ fields and methods on a model are available via GraphQL. WARNING: 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 +Items (fields, enums, etc) that have been removed according to our [deprecation process](../index.md#deprecation-and-removal-process) can be found in [Removed Items](../removed_items.md). <!-- vale gitlab.Spelling = NO --> -## Queries +## `Query` type -Queries are used to get the resources, filter or query them. +The `Query` type contains the API's top-level entry points for all executable queries. -For more information, visit [Queries and Mutations](https://graphql.org/learn/queries/). - -### CiApplicationSettings +### ciApplicationSettings CI related settings that apply to the entire instance. -### CiConfig +### ciConfig Get linted and processed contents of a CI config. Should not be requested more than once per request. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `content` | Contents of `.gitlab-ci.yml`. | String! | -| `dryRun` | Run pipeline creation simulation, or only do static check. | Boolean | -| `projectPath` | The project of the CI config. | ID! | +#### Arguments -### ContainerRepository +| Name | Type | Description | +| ---- | ---- | ----------- | +| `content` | String! | Contents of `.gitlab-ci.yml`. | +| `dryRun` | Boolean | Run pipeline creation simulation, or only do static check. | +| `projectPath` | ID! | The project of the CI config. | + +### containerRepository Find a container repository. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | The global ID of the container repository. | ContainerRepositoryID! | +#### Arguments -### CurrentUser +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | ContainerRepositoryID! | The global ID of the container repository. | + +### currentUser Get information about current user. -### DesignManagement +### designManagement Fields related to design management. -### DevopsAdoptionSegments +### devopsAdoptionSegments Get configured DevOps adoption segments on the instance. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `last` | Returns the last _n_ elements from the list. | Int | +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | -### Echo +### echo Text to echo back. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `text` | Text to echo back. | String! | +#### Arguments -### GeoNode +| Name | Type | Description | +| ---- | ---- | ----------- | +| `text` | String! | Text to echo back. | + +### geoNode Find a Geo node. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `name` | The name of the Geo node. Defaults to the current Geo node name. | String | +#### Arguments -### Group +| Name | Type | Description | +| ---- | ---- | ----------- | +| `name` | String | The name of the Geo node. Defaults to the current Geo node name. | + +### group Find a group. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! | +#### Arguments -### InstanceSecurityDashboard +| Name | Type | Description | +| ---- | ---- | ----------- | +| `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | + +### instanceSecurityDashboard Fields related to Instance Security Dashboard. -### InstanceStatisticsMeasurements +### instanceStatisticsMeasurements Get statistics on the instance. Deprecated in 13.10: This field was renamed. Use the `usageTrendsMeasurements` field instead. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `identifier` | The type of measurement/statistics to retrieve. | MeasurementIdentifier! | -| `last` | Returns the last _n_ elements from the list. | Int | -| `recordedAfter` | Measurement recorded after this date. | Time | -| `recordedBefore` | Measurement recorded before this date. | Time | +#### Arguments -### Issue +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `identifier` | MeasurementIdentifier! | The type of measurement/statistics to retrieve. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `recordedAfter` | Time | Measurement recorded after this date. | +| `recordedBefore` | Time | Measurement recorded before this date. | + +### issue Find an Issue. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | The global ID of the Issue. | IssueID! | +#### Arguments -### Iteration +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | IssueID! | The global ID of the Issue. | + +### iteration Find an iteration. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | Find an iteration by its ID. | IterationID! | +#### Arguments -### Metadata +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | IterationID! | Find an iteration by its ID. | + +### metadata Metadata about GitLab. -### Milestone +### milestone Find a milestone. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | Find a milestone by its ID. | MilestoneID! | +#### Arguments -### Namespace +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | MilestoneID! | Find a milestone by its ID. | + +### namespace Find a namespace. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! | +#### Arguments -### Package +| Name | Type | Description | +| ---- | ---- | ----------- | +| `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | + +### package Find a package. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | The global ID of the package. | PackagesPackageID! | +#### Arguments -### Project +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | PackagesPackageID! | The global ID of the package. | + +### project Find a project. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `fullPath` | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | ID! | +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `fullPath` | ID! | The full path of the project, group or namespace, e.g., `gitlab-org/gitlab-foss`. | -### Projects +### projects Find projects visible to the current user. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `ids` | Filter projects by IDs. | ID! => Array | -| `last` | Returns the last _n_ elements from the list. | Int | -| `membership` | Limit projects that the current user is a member of. | Boolean | -| `search` | Search query for project name, path, or description. | String | -| `searchNamespaces` | Include namespace in project search. | Boolean | -| `sort` | Sort order of results. | String | +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `ids` | ID! => Array | Filter projects by IDs. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `membership` | Boolean | Limit projects that the current user is a member of. | +| `search` | String | Search query for project name, path, or description. | +| `searchNamespaces` | Boolean | Include namespace in project search. | +| `sort` | String | Sort order of results. | -### RunnerPlatforms +### runnerPlatforms Supported runner platforms. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `last` | Returns the last _n_ elements from the list. | Int | +#### Arguments -### RunnerSetup +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | + +### runnerSetup Get runner setup instructions. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `architecture` | Architecture to generate the instructions for. | String! | -| `groupId` | Group to register the runner for. | GroupID | -| `platform` | Platform to generate the instructions for. | String! | -| `projectId` | Project to register the runner for. | ProjectID | +#### Arguments -### Snippets +| Name | Type | Description | +| ---- | ---- | ----------- | +| `architecture` | String! | Architecture to generate the instructions for. | +| `groupId` | GroupID | Group to register the runner for. | +| `platform` | String! | Platform to generate the instructions for. | +| `projectId` | ProjectID | Project to register the runner for. | + +### snippets Find Snippets visible to the current user. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `authorId` | The ID of an author. | UserID | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `explore` | Explore personal snippets. | Boolean | -| `first` | Returns the first _n_ elements from the list. | Int | -| `ids` | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | SnippetID! => Array | -| `last` | Returns the last _n_ elements from the list. | Int | -| `projectId` | The ID of a project. | ProjectID | -| `type` | The type of snippet. | TypeEnum | -| `visibility` | The visibility of the snippet. | VisibilityScopesEnum | +#### Arguments -### UsageTrendsMeasurements +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `authorId` | UserID | The ID of an author. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `explore` | Boolean | Explore personal snippets. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `ids` | SnippetID! => Array | Array of global snippet IDs. For example, `gid://gitlab/ProjectSnippet/1`. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `projectId` | ProjectID | The ID of a project. | +| `type` | TypeEnum | The type of snippet. | +| `visibility` | VisibilityScopesEnum | The visibility of the snippet. | + +### usageTrendsMeasurements Get statistics on the instance. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `identifier` | The type of measurement/statistics to retrieve. | MeasurementIdentifier! | -| `last` | Returns the last _n_ elements from the list. | Int | -| `recordedAfter` | Measurement recorded after this date. | Time | -| `recordedBefore` | Measurement recorded before this date. | Time | +#### Arguments -### User +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `identifier` | MeasurementIdentifier! | The type of measurement/statistics to retrieve. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `recordedAfter` | Time | Measurement recorded after this date. | +| `recordedBefore` | Time | Measurement recorded before this date. | + +### user Find a user. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | ID of the User. | UserID | -| `username` | Username of the User. | String | +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | UserID | ID of the User. | +| `username` | String | Username of the User. | -### Users +### users Find users. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `admins` | Return only admin users. | Boolean | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `ids` | List of user Global IDs. | ID! => Array | -| `last` | Returns the last _n_ elements from the list. | Int | -| `search` | Query to search users by name, username, or primary email. | String | -| `sort` | Sort users by this criteria. | Sort | -| `usernames` | List of usernames. | String! => Array | +#### Arguments -### Vulnerabilities +| Name | Type | Description | +| ---- | ---- | ----------- | +| `admins` | Boolean | Return only admin users. | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `ids` | ID! => Array | List of user Global IDs. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `search` | String | Query to search users by name, username, or primary email. | +| `sort` | Sort | Sort users by this criteria. | +| `usernames` | String! => Array | List of usernames. | -Vulnerabilities reported on projects on the current user's instance security dashboard. +### vulnerabilities -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `first` | Returns the first _n_ elements from the list. | Int | -| `hasIssues` | Returns only the vulnerabilities which have linked issues. | Boolean | -| `hasResolution` | Returns only the vulnerabilities which have been resolved on default branch. | Boolean | -| `last` | Returns the last _n_ elements from the list. | Int | -| `projectId` | Filter vulnerabilities by project. | ID! => Array | -| `reportType` | Filter vulnerabilities by report type. | VulnerabilityReportType! => Array | -| `scanner` | Filter vulnerabilities by VulnerabilityScanner.externalId. | String! => Array | -| `severity` | Filter vulnerabilities by severity. | VulnerabilitySeverity! => Array | -| `sort` | List vulnerabilities by sort order. | VulnerabilitySort | -| `state` | Filter vulnerabilities by state. | VulnerabilityState! => Array | +Vulnerabilities reported on projects on the current user's instance security dashboard. -### VulnerabilitiesCountByDay +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `hasIssues` | Boolean | Returns only the vulnerabilities which have linked issues. | +| `hasResolution` | Boolean | Returns only the vulnerabilities which have been resolved on default branch. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `projectId` | ID! => Array | Filter vulnerabilities by project. | +| `reportType` | VulnerabilityReportType! => Array | Filter vulnerabilities by report type. | +| `scanner` | String! => Array | Filter vulnerabilities by VulnerabilityScanner.externalId. | +| `severity` | VulnerabilitySeverity! => Array | Filter vulnerabilities by severity. | +| `sort` | VulnerabilitySort | List vulnerabilities by sort order. | +| `state` | VulnerabilityState! => Array | Filter vulnerabilities by state. | + +### vulnerabilitiesCountByDay Number of vulnerabilities per day for the projects on the current user's instance security dashboard. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `endDate` | Last day for which to fetch vulnerability history. | ISO8601Date! | -| `first` | Returns the first _n_ elements from the list. | Int | -| `last` | Returns the last _n_ elements from the list. | Int | -| `startDate` | First day for which to fetch vulnerability history. | ISO8601Date! | +#### Arguments -### VulnerabilitiesCountByDayAndSeverity +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `endDate` | ISO8601Date! | Last day for which to fetch vulnerability history. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `startDate` | ISO8601Date! | First day for which to fetch vulnerability history. | + +### vulnerabilitiesCountByDayAndSeverity 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`. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `after` | Returns the elements in the list that come after the specified cursor. | String | -| `before` | Returns the elements in the list that come before the specified cursor. | String | -| `endDate` | Last day for which to fetch vulnerability history. | ISO8601Date! | -| `first` | Returns the first _n_ elements from the list. | Int | -| `last` | Returns the last _n_ elements from the list. | Int | -| `startDate` | First day for which to fetch vulnerability history. | ISO8601Date! | +#### Arguments -### Vulnerability +| Name | Type | Description | +| ---- | ---- | ----------- | +| `after` | String | Returns the elements in the list that come after the specified cursor. | +| `before` | String | Returns the elements in the list that come before the specified cursor. | +| `endDate` | ISO8601Date! | Last day for which to fetch vulnerability history. | +| `first` | Int | Returns the first _n_ elements from the list. | +| `last` | Int | Returns the last _n_ elements from the list. | +| `startDate` | ISO8601Date! | First day for which to fetch vulnerability history. | + +### vulnerability Find a vulnerability. -| Name | Description | Type | -| ----- | ---- | ----------- | -| `id` | The Global ID of the Vulnerability. | VulnerabilityID! | +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| `id` | VulnerabilityID! | The Global ID of the Vulnerability. | ## Object types @@ -4931,24 +4977,24 @@ Values for sorting alerts. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `CREATED_TIME_ASC` | Created time by ascending order | -| `CREATED_TIME_DESC` | Created time by descending order | -| `ENDED_AT_ASC` | End time by ascending order | -| `ENDED_AT_DESC` | End time by descending order | -| `EVENT_COUNT_ASC` | Events count by ascending order | -| `EVENT_COUNT_DESC` | Events count by descending order | -| `SEVERITY_ASC` | Severity from less critical to more critical | -| `SEVERITY_DESC` | Severity from more critical to less critical | -| `STARTED_AT_ASC` | Start time by ascending order | -| `STARTED_AT_DESC` | Start time by descending order | -| `STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered | -| `STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | -| `UPDATED_TIME_ASC` | Created time by ascending order | -| `UPDATED_TIME_DESC` | Created time by descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `CREATED_TIME_ASC` | Created time by ascending order. | +| `CREATED_TIME_DESC` | Created time by descending order. | +| `ENDED_AT_ASC` | End time by ascending order. | +| `ENDED_AT_DESC` | End time by descending order. | +| `EVENT_COUNT_ASC` | Events count by ascending order. | +| `EVENT_COUNT_DESC` | Events count by descending order. | +| `SEVERITY_ASC` | Severity from less critical to more critical. | +| `SEVERITY_DESC` | Severity from more critical to less critical. | +| `STARTED_AT_ASC` | Start time by ascending order. | +| `STARTED_AT_DESC` | Start time by descending order. | +| `STATUS_ASC` | Status by order: Ignored > Resolved > Acknowledged > Triggered. | +| `STATUS_DESC` | Status by order: Triggered > Acknowledged > Resolved > Ignored. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | +| `UPDATED_TIME_ASC` | Created time by ascending order. | +| `UPDATED_TIME_DESC` | Created time by 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. | @@ -4960,8 +5006,8 @@ Filters the alerts based on given domain. | Value | Description | | ----- | ----------- | -| `operations` | Alerts for operations domain | -| `threat_monitoring` | Alerts for threat monitoring domain | +| `operations` | Alerts for operations domain. | +| `threat_monitoring` | Alerts for threat monitoring domain. | ### AlertManagementIntegrationType @@ -4969,8 +5015,8 @@ Values of types of integrations. | Value | Description | | ----- | ----------- | -| `HTTP` | Integration with any monitoring tool | -| `PROMETHEUS` | Prometheus integration | +| `HTTP` | Integration with any monitoring tool. | +| `PROMETHEUS` | Prometheus integration. | ### AlertManagementPayloadAlertFieldName @@ -4995,9 +5041,9 @@ Values for alert field types used in the custom mapping. | Value | Description | | ----- | ----------- | -| `ARRAY` | Array field type | -| `DATETIME` | DateTime field type | -| `STRING` | String field type | +| `ARRAY` | Array field type. | +| `DATETIME` | DateTime field type. | +| `STRING` | String field type. | ### AlertManagementSeverity @@ -5057,8 +5103,8 @@ Values for YAML processor result. | Value | Description | | ----- | ----------- | -| `INVALID` | The configuration file is not valid | -| `VALID` | The configuration file is valid | +| `INVALID` | The configuration file is not valid. | +| `VALID` | The configuration file is valid. | ### CommitActionMode @@ -5066,18 +5112,18 @@ Mode of a commit action. | Value | Description | | ----- | ----------- | -| `CHMOD` | Chmod command | -| `CREATE` | Create command | -| `DELETE` | Delete command | -| `MOVE` | Move command | -| `UPDATE` | Update command | +| `CHMOD` | Chmod command. | +| `CREATE` | Create command. | +| `DELETE` | Delete command. | +| `MOVE` | Move command. | +| `UPDATE` | Update command. | ### CommitEncoding | Value | Description | | ----- | ----------- | -| `BASE64` | Base64 encoding | -| `TEXT` | Text encoding | +| `BASE64` | Base64 encoding. | +| `TEXT` | Text encoding. | ### ContainerExpirationPolicyCadenceEnum @@ -5126,12 +5172,12 @@ 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` | 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. | @@ -5157,18 +5203,18 @@ Status of a container repository. | Value | Description | | ----- | ----------- | -| `FAILED_VALIDATION` | Site validation process finished but failed | -| `INPROGRESS_VALIDATION` | Site validation process is in progress | -| `NONE` | No site validation exists | -| `PASSED_VALIDATION` | Site validation process finished successfully | -| `PENDING_VALIDATION` | Site validation process has not started | +| `FAILED_VALIDATION` | Site validation process finished but failed. | +| `INPROGRESS_VALIDATION` | Site validation process is in progress. | +| `NONE` | No site validation exists. | +| `PASSED_VALIDATION` | Site validation process finished successfully. | +| `PENDING_VALIDATION` | Site validation process has not started. | ### DastSiteValidationStrategyEnum | Value | Description | | ----- | ----------- | -| `HEADER` | Header validation | -| `TEXT_FILE` | Text file validation | +| `HEADER` | Header validation. | +| `TEXT_FILE` | Text file validation. | ### DataVisualizationColorEnum @@ -5219,7 +5265,7 @@ Mutation event of a design within a version. | `CREATION` | A creation event | | `DELETION` | A deletion event | | `MODIFICATION` | A modification event | -| `NONE` | No change | +| `NONE` | No change. | ### DiffPositionType @@ -5246,10 +5292,10 @@ Roadmap sort values. | Value | Description | | ----- | ----------- | -| `end_date_asc` | End date at ascending order | -| `end_date_desc` | End date at descending order | -| `start_date_asc` | Start date at ascending order | -| `start_date_desc` | Start date at descending order | +| `end_date_asc` | End date at ascending order. | +| `end_date_desc` | End date at descending order. | +| `start_date_asc` | Start date at ascending order. | +| `start_date_desc` | Start date at descending order. | ### EpicState @@ -5267,8 +5313,8 @@ State event of an epic. | Value | Description | | ----- | ----------- | -| `CLOSE` | Close the epic | -| `REOPEN` | Reopen the epic | +| `CLOSE` | Close the epic. | +| `REOPEN` | Reopen the epic. | ### EpicWildcardId @@ -5276,8 +5322,8 @@ Epic ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | Any epic is assigned | -| `NONE` | No epic is assigned | +| `ANY` | Any epic is assigned. | +| `NONE` | No epic is assigned. | ### EventAction @@ -5337,10 +5383,10 @@ State of a GitLab issue or merge request. | Value | Description | | ----- | ----------- | -| `all` | All available | -| `closed` | In closed state | -| `locked` | Discussion has been locked | -| `opened` | In open state | +| `all` | All available. | +| `closed` | In closed state. | +| `locked` | Discussion has been locked. | +| `opened` | In open state. | ### IssueSort @@ -5348,27 +5394,27 @@ Values for sorting issues. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `DUE_DATE_ASC` | Due date by ascending order | -| `DUE_DATE_DESC` | Due date by descending order | -| `LABEL_PRIORITY_ASC` | Label priority by ascending order | -| `LABEL_PRIORITY_DESC` | Label priority by descending order | -| `MILESTONE_DUE_ASC` | Milestone due date by ascending order | -| `MILESTONE_DUE_DESC` | Milestone due date by descending order | -| `PRIORITY_ASC` | Priority by ascending order | -| `PRIORITY_DESC` | Priority by descending order | -| `PUBLISHED_ASC` | Published issues shown last | -| `PUBLISHED_DESC` | Published issues shown first | -| `RELATIVE_POSITION_ASC` | Relative position by ascending order | -| `SEVERITY_ASC` | Severity from less critical to more critical | -| `SEVERITY_DESC` | Severity from more critical to less critical | -| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first | -| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | -| `WEIGHT_ASC` | Weight by ascending order | -| `WEIGHT_DESC` | Weight by descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `DUE_DATE_ASC` | Due date by ascending order. | +| `DUE_DATE_DESC` | Due date by descending order. | +| `LABEL_PRIORITY_ASC` | Label priority by ascending order. | +| `LABEL_PRIORITY_DESC` | Label priority by descending order. | +| `MILESTONE_DUE_ASC` | Milestone due date by ascending order. | +| `MILESTONE_DUE_DESC` | Milestone due date by descending order. | +| `PRIORITY_ASC` | Priority by ascending order. | +| `PRIORITY_DESC` | Priority by descending order. | +| `PUBLISHED_ASC` | Published issues shown last. | +| `PUBLISHED_DESC` | Published issues shown first. | +| `RELATIVE_POSITION_ASC` | Relative position by ascending order. | +| `SEVERITY_ASC` | Severity from less critical to more critical. | +| `SEVERITY_DESC` | Severity from more critical to less critical. | +| `SLA_DUE_AT_ASC` | Issues with earliest SLA due time shown first. | +| `SLA_DUE_AT_DESC` | Issues with latest SLA due time shown first. | +| `UPDATED_ASC` | Updated at ascending order. | +| `UPDATED_DESC` | Updated at descending order. | +| `WEIGHT_ASC` | Weight by ascending order. | +| `WEIGHT_DESC` | Weight by 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. | @@ -5380,10 +5426,10 @@ State of a GitLab issue. | Value | Description | | ----- | ----------- | -| `all` | All available | -| `closed` | In closed state | -| `locked` | Discussion has been locked | -| `opened` | In open state | +| `all` | All available. | +| `closed` | In closed state. | +| `locked` | Discussion has been locked. | +| `opened` | In open state. | ### IssueStateEvent @@ -5391,8 +5437,8 @@ Values for issue state events. | Value | Description | | ----- | ----------- | -| `CLOSE` | Closes the issue | -| `REOPEN` | Reopens the issue | +| `CLOSE` | Closes the issue. | +| `REOPEN` | Reopens the issue. | ### IssueType @@ -5422,9 +5468,9 @@ Iteration ID wildcard values. | Value | Description | | ----- | ----------- | -| `ANY` | An iteration is assigned | -| `CURRENT` | Current iteration | -| `NONE` | No iteration is assigned | +| `ANY` | An iteration is assigned. | +| `CURRENT` | Current iteration. | +| `NONE` | No iteration is assigned. | ### JobArtifactFileType @@ -5474,16 +5520,16 @@ Possible identifier types for a measurement. | Value | Description | | ----- | ----------- | -| `GROUPS` | Group count | -| `ISSUES` | Issue count | -| `MERGE_REQUESTS` | Merge request count | -| `PIPELINES` | Pipeline count | -| `PIPELINES_CANCELED` | Pipeline count with canceled status | -| `PIPELINES_FAILED` | Pipeline count with failed status | -| `PIPELINES_SKIPPED` | Pipeline count with skipped status | -| `PIPELINES_SUCCEEDED` | Pipeline count with success status | -| `PROJECTS` | Project count | -| `USERS` | User count | +| `GROUPS` | Group count. | +| `ISSUES` | Issue count. | +| `MERGE_REQUESTS` | Merge request count. | +| `PIPELINES` | Pipeline count. | +| `PIPELINES_CANCELED` | Pipeline count with canceled status. | +| `PIPELINES_FAILED` | Pipeline count with failed status. | +| `PIPELINES_SKIPPED` | Pipeline count with skipped status. | +| `PIPELINES_SUCCEEDED` | Pipeline count with success status. | +| `PROJECTS` | Project count. | +| `USERS` | User count. | ### MergeRequestNewState @@ -5500,18 +5546,18 @@ Values for sorting merge requests. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `LABEL_PRIORITY_ASC` | Label priority by ascending order | -| `LABEL_PRIORITY_DESC` | Label priority by descending order | -| `MERGED_AT_ASC` | Merge time by ascending order | -| `MERGED_AT_DESC` | Merge time by descending order | -| `MILESTONE_DUE_ASC` | Milestone due date by ascending order | -| `MILESTONE_DUE_DESC` | Milestone due date by descending order | -| `PRIORITY_ASC` | Priority by ascending order | -| `PRIORITY_DESC` | Priority by descending order | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `LABEL_PRIORITY_ASC` | Label priority by ascending order. | +| `LABEL_PRIORITY_DESC` | Label priority by descending order. | +| `MERGED_AT_ASC` | Merge time by ascending order. | +| `MERGED_AT_DESC` | Merge time by descending order. | +| `MILESTONE_DUE_ASC` | Milestone due date by ascending order. | +| `MILESTONE_DUE_DESC` | Milestone due date by descending order. | +| `PRIORITY_ASC` | Priority by ascending order. | +| `PRIORITY_DESC` | Priority 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. | @@ -5523,11 +5569,11 @@ State of a GitLab merge request. | Value | Description | | ----- | ----------- | -| `all` | All available | -| `closed` | In closed state | -| `locked` | Discussion has been locked | -| `merged` | Merge Request has been merged | -| `opened` | In open state | +| `all` | All available. | +| `closed` | In closed state. | +| `locked` | Discussion has been locked. | +| `merged` | Merge Request has been merged. | +| `opened` | In open state. | ### MilestoneStateEnum @@ -5535,8 +5581,8 @@ Current state of milestone. | Value | Description | | ----- | ----------- | -| `active` | Milestone is currently active | -| `closed` | Milestone is closed | +| `active` | Milestone is currently active. | +| `closed` | Milestone is closed. | ### MoveType @@ -5544,8 +5590,8 @@ The position to which the adjacent object should be moved. | Value | Description | | ----- | ----------- | -| `after` | The adjacent object will be moved after the object that is being moved | -| `before` | The adjacent object will be moved before the object that is being moved | +| `after` | The adjacent object will be moved after the object that is being moved. | +| `before` | The adjacent object will be moved before the object that is being moved. | ### MutationOperationMode @@ -5553,9 +5599,9 @@ Different toggles for changing mutator behavior. | Value | Description | | ----- | ----------- | -| `APPEND` | Performs an append operation | -| `REMOVE` | Performs a removal operation | -| `REPLACE` | Performs a replace operation | +| `APPEND` | Performs an append operation. | +| `REMOVE` | Performs a removal operation. | +| `REPLACE` | Performs a replace operation. | ### NamespaceProjectSort @@ -5563,8 +5609,8 @@ Values for sorting projects. | Value | Description | | ----- | ----------- | -| `SIMILARITY` | Most similar to the search query | -| `STORAGE` | Sort by storage size | +| `SIMILARITY` | Most similar to the search query. | +| `STORAGE` | Sort by storage size. | ### OncallRotationUnitEnum @@ -5638,10 +5684,10 @@ State of a Geo registry. | Value | Description | | ----- | ----------- | -| `FAILED` | Registry that failed to sync | -| `PENDING` | Registry waiting to be synced | -| `STARTED` | Registry currently syncing | -| `SYNCED` | Registry that is synced | +| `FAILED` | Registry that failed to sync. | +| `PENDING` | Registry waiting to be synced. | +| `STARTED` | Registry currently syncing. | +| `SYNCED` | Registry that is synced. | ### ReleaseAssetLinkType @@ -5660,10 +5706,10 @@ Values for sorting releases. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `RELEASED_AT_ASC` | Released at by ascending order | -| `RELEASED_AT_DESC` | Released at by descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at descending order. | +| `RELEASED_AT_ASC` | Released at by ascending order. | +| `RELEASED_AT_DESC` | Released at by descending order. | ### RequirementState @@ -5726,10 +5772,10 @@ State of a Sentry error. | Value | Description | | ----- | ----------- | -| `IGNORED` | Error has been ignored | -| `RESOLVED` | Error has been resolved | -| `RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release | -| `UNRESOLVED` | Error is unresolved | +| `IGNORED` | Error has been ignored. | +| `RESOLVED` | Error has been resolved. | +| `RESOLVED_IN_NEXT_RELEASE` | Error has been ignored until next release. | +| `UNRESOLVED` | Error is unresolved. | ### ServiceType @@ -5789,10 +5835,10 @@ Common sort values. | Value | Description | | ----- | ----------- | -| `CREATED_ASC` | Created at ascending order | -| `CREATED_DESC` | Created at descending order | -| `UPDATED_ASC` | Updated at ascending order | -| `UPDATED_DESC` | Updated at descending order | +| `CREATED_ASC` | Created at ascending order. | +| `CREATED_DESC` | Created at 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. | @@ -5830,12 +5876,12 @@ State of a test report. | Value | Description | | ----- | ----------- | -| `ALERT` | An Alert | -| `COMMIT` | A Commit | -| `DESIGN` | A Design | -| `EPIC` | An Epic | -| `ISSUE` | An Issue | -| `MERGEREQUEST` | A MergeRequest | +| `ALERT` | An Alert. | +| `COMMIT` | A Commit. | +| `DESIGN` | A Design. | +| `EPIC` | An Epic. | +| `ISSUE` | An Issue. | +| `MERGEREQUEST` | A MergeRequest. | ### TypeEnum @@ -5850,9 +5896,9 @@ Possible states of a user. | Value | Description | | ----- | ----------- | -| `active` | The user is active and is able to use the system | -| `blocked` | The user has been blocked and is prevented from using the system | -| `deactivated` | The user is no longer active and is unable to use the system | +| `active` | The user is active and is able to use the system. | +| `blocked` | The user has been blocked and is prevented from using the system. | +| `deactivated` | The user is no longer active and is unable to use the system. | ### VisibilityLevelsEnum @@ -5952,16 +5998,16 @@ Vulnerability sort values. | Value | Description | | ----- | ----------- | -| `detected_asc` | Detection timestamp in ascending order | -| `detected_desc` | Detection timestamp in descending order | -| `report_type_asc` | Report Type in ascending order | -| `report_type_desc` | Report Type in descending order | -| `severity_asc` | Severity in ascending order | -| `severity_desc` | Severity in descending order | -| `state_asc` | State in ascending order | -| `state_desc` | State in descending order | -| `title_asc` | Title in ascending order | -| `title_desc` | Title in descending order | +| `detected_asc` | Detection timestamp in ascending order. | +| `detected_desc` | Detection timestamp in descending order. | +| `report_type_asc` | Report Type in ascending order. | +| `report_type_desc` | Report Type in descending order. | +| `severity_asc` | Severity in ascending order. | +| `severity_desc` | Severity in descending order. | +| `state_asc` | State in ascending order. | +| `state_desc` | State in descending order. | +| `title_asc` | Title in ascending order. | +| `title_desc` | Title in descending order. | ### VulnerabilityState diff --git a/doc/api/graphql/removed_items.md b/doc/api/graphql/removed_items.md index 2761c1a1c84..a76f1fb7418 100644 --- a/doc/api/graphql/removed_items.md +++ b/doc/api/graphql/removed_items.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w GraphQL is a versionless API, unlike the REST API. Occasionally, items have to be updated or removed from the GraphQL API. -According to our [process for removing items](index.md#deprecation-process), here are the items that have been removed. +According to our [process for removing items](index.md#deprecation-and-removal-process), here are the items that have been removed. ## GitLab 13.6 diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 54e2cb9c68d..c8e32d8d089 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -76,6 +76,25 @@ Rake task. Requests time out at 30 seconds. +## Breaking changes + +The GitLab GraphQL API is [versionless](https://graphql.org/learn/best-practices/#versioning) which means +developers must familiarize themselves with our [deprecation cycle of breaking changes](#breaking-changes). + +Breaking changes are: + +- Removing or renaming a field, argument, enum value or mutation. +- Changing the type of a field, argument or enum value. +- Raising the [complexity](#max-complexity) of a field or complexity multipliers in a resolver. +- Changing the [max page size](#page-size-limit) of a connection. +- Lowering the global limits for query complexity and depth. +- Anything else that can result in queries hitting a limit that previously was allowed. + +Fields that use the [`feature_flag` property](#feature_flag-property) and the flag is disabled by default are exempt +from the deprecation process, and can be removed at any time without notice. + +See the [deprecating fields and enum values](#deprecating-fields-arguments-and-enum-values) section for how to deprecate items. + ## Global IDs The GitLab GraphQL API uses Global IDs (i.e: `"gid://gitlab/MyObject/123"`) @@ -499,7 +518,7 @@ Rather than removing fields, arguments, or [enum values](#enums), they must be _deprecated_ instead. The deprecated parts of the schema can then be removed in a future release -in accordance with the [GitLab deprecation process](../api/graphql/index.md#deprecation-process). +in accordance with the [GitLab deprecation process](../api/graphql/index.md#deprecation-and-removal-process). Fields, arguments, and enum values are deprecated using the `deprecated` property. The value of the property is a `Hash` of: diff --git a/doc/development/changelog.md b/doc/development/changelog.md index 44be6e9548b..fa771f96259 100644 --- a/doc/development/changelog.md +++ b/doc/development/changelog.md @@ -45,7 +45,7 @@ the `author` field. GitLab team members **should not**. **must** have a changelog entry, without `merge_request` value and with `type` set to `security`. - Any user-facing change **must** have a changelog entry. This includes both visual changes (regardless of how minor), and changes to the rendered DOM which impact how a screen reader may announce the content. -- Any client-facing change to our REST and GraphQL APIs **must** have a changelog entry. This includes modifying complexity of GraphQL fields. +- Any client-facing change to our REST and GraphQL APIs **must** have a changelog entry. See the [complete list what comprises a GraphQL breaking change](api_graphql_styleguide.md#breaking-changes). - Performance improvements **should** have a changelog entry. - Changes that need to be documented in the Product Intelligence [Event Dictionary](https://about.gitlab.com/handbook/product/product-intelligence-guide/#event-dictionary) also require a changelog entry. diff --git a/doc/development/feature_flags/development.md b/doc/development/feature_flags/development.md index 792b4a1a27f..93f8fef74fa 100644 --- a/doc/development/feature_flags/development.md +++ b/doc/development/feature_flags/development.md @@ -410,11 +410,21 @@ Feature.enable(:feature_flag_name, Project.find_by_full_path("root/my-project")) ### Removing a feature flag locally (in development) -When manually enabling or disabling a feature flag from the Rails console, its default value gets overwritten. +Once you have manually enabled or disabled a feature flag to test in your local environment, +the flag's default value gets overwritten and it takes precedence over the `default_enabled` value. This can cause confusion when changing the flag's `default_enabled` attribute. -To reset the feature flag to the default status, you can remove it in the rails console (`rails c`) -as follows: +For example, flags are commonly enabled and disabled several times during the development process. +When we finally enable the flag by default, we set `default_enabled: true` in the YAML file. + +- If the flag was manually enabled before setting `default_enabled: true`, the feature will be enabled. +Not because of the `default_enabled: true` value of the flag but because it was manually enabled. +- If the flag was manually disabled before setting `default_enabled: true`, the feature will +remain disabled. The `default_enabled: true` value does not take precendence over the explicit `false` +value set when disabling it manually. + +To reset the feature flag to the default status set in its YAML file, remove it using the Rails console +(`rails c`) as follows: ```ruby Feature.remove(:feature_flag_name) diff --git a/doc/install/installation.md b/doc/install/installation.md index 6eea89b074a..5d42d497d4d 100644 --- a/doc/install/installation.md +++ b/doc/install/installation.md @@ -108,9 +108,8 @@ Install the required packages (needed to compile Ruby and native extensions to R ```shell sudo apt-get install -y build-essential zlib1g-dev libyaml-dev libssl-dev libgdbm-dev libre2-dev \ - libreadline-dev libncurses5-dev libffi-dev curl openssh-server checkinstall libxml2-dev \ - libxslt-dev libcurl4-openssl-dev libicu-dev logrotate rsync python-docutils pkg-config cmake \ - runit-systemd + libreadline-dev libncurses5-dev libffi-dev curl openssh-server libxml2-dev libxslt-dev \ + libcurl4-openssl-dev libicu-dev logrotate rsync python-docutils pkg-config cmake runit-systemd ``` Ubuntu 14.04 (Trusty Tahr) doesn't have the `libre2-dev` package available, but diff --git a/doc/install/requirements.md b/doc/install/requirements.md index 2ab81e3cce9..ccd7c324e9a 100644 --- a/doc/install/requirements.md +++ b/doc/install/requirements.md @@ -80,7 +80,7 @@ From GitLab 13.1: Beginning in GitLab 12.9, we only support Node.js 10.13.0 or higher, and we have dropped support for Node.js 8. (Node.js 6 support was dropped in GitLab 11.8) -We recommend Node 12.x, as it's faster. +We recommend Node 14.x, as it's faster. GitLab uses [webpack](https://webpack.js.org/) to compile frontend assets, which requires a minimum version of Node.js 10.13.0. diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index b7a1243be72..317c14fef75 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -37,7 +37,9 @@ Every occupied seat is counted in the subscription, with the following exception NOTE: To support the open source community and encourage the development of open source projects, GitLab grants access to **Ultimate** features for all GitLab SaaS -**public** projects, regardless of the subscription. +**public** projects, regardless of the subscription. GitLab also provides qualifying +open source projects with 50,000 CI minutes and free access to the Ultimate tier for +groups through the [GitLab for Open Source program](https://about.gitlab.com/solutions/open-source/). ## Obtain a GitLab SaaS subscription diff --git a/doc/user/abuse_reports.md b/doc/user/abuse_reports.md index 935fca8209f..e2f2038f240 100644 --- a/doc/user/abuse_reports.md +++ b/doc/user/abuse_reports.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 --- -# Abuse reports +# Abuse reports **(FREE)** You can report abuse from other GitLab users to GitLab administrators. @@ -12,7 +12,7 @@ A GitLab administrator [can then choose](admin_area/abuse_reports.md) to: - Remove the user, which deletes them from the instance. - Block the user, which denies them access to the instance. -- Or remove the report, which retains the users access to the instance. +- Or remove the report, which retains the user's access to the instance. You can report a user through their: diff --git a/doc/user/group/saml_sso/index.md b/doc/user/group/saml_sso/index.md index f4f9054d455..3ac8f523fc1 100644 --- a/doc/user/group/saml_sso/index.md +++ b/doc/user/group/saml_sso/index.md @@ -162,8 +162,11 @@ For NameID, the following settings are recommended; for SCIM, the following sett ### OneLogin setup notes -The GitLab app listed in the OneLogin app catalog is for self-managed GitLab instances. -For GitLab.com, use a generic SAML Test Connector such as the SAML Test Connector (Advanced). +OneLogin supports their own [GitLab (SaaS)](https://onelogin.service-now.com/support?id=kb_article&sys_id=92e4160adbf16cd0ca1c400e0b961923&kb_category=50984e84db738300d5505eea4b961913) +application. + +If you decide to use the OneLogin generic [SAML Test Connector (Advanced)](https://onelogin.service-now.com/support?id=kb_article&sys_id=b2c19353dbde7b8024c780c74b9619fb&kb_category=93e869b0db185340d5505eea4b961934), +we recommend the following settings: | GitLab Setting | OneLogin Field | |--------------|----------------| diff --git a/doc/user/group/saml_sso/scim_setup.md b/doc/user/group/saml_sso/scim_setup.md index 41373161a9a..d248729b615 100644 --- a/doc/user/group/saml_sso/scim_setup.md +++ b/doc/user/group/saml_sso/scim_setup.md @@ -161,6 +161,11 @@ The Okta GitLab application currently only supports SCIM. Continue using the separate Okta [SAML SSO](index.md) configuration along with the new SCIM application described above. +### OneLogin + +OneLogin provides a "GitLab (SaaS)" app in their catalog, which includes a SCIM integration. +As the app is developed by OneLogin, please reach out to OneLogin if you encounter issues. + ## User access and linking setup The following diagram is a general outline on what happens when you add users to your SCIM app: diff --git a/doc/user/packages/pypi_repository/index.md b/doc/user/packages/pypi_repository/index.md index 763dbee3a82..6b6690f1b38 100644 --- a/doc/user/packages/pypi_repository/index.md +++ b/doc/user/packages/pypi_repository/index.md @@ -317,18 +317,24 @@ more than once, a `404 Bad Request` error occurs. To install the latest version of a package, use the following command: ```shell -pip install --extra-index-url https://__token__:<personal_access_token>@gitlab.example.com/api/v4/projects/<project_id>/packages/pypi/simple --no-deps <package_name> +pip install --index-url https://__token__:<personal_access_token>@gitlab.example.com/api/v4/projects/<project_id>/packages/pypi/simple --no-deps <package_name> ``` - `<package_name>` is the package name. - `<personal_access_token>` is a personal access token with the `read_api` scope. - `<project_id>` is the project ID. +In these commands, you can use `--extra-index-url` instead of `--index-url`. However, using +`--extra-index-url` makes you vulnerable to dependency confusion attacks because it checks the PyPi +repository for the package before it checks the custom repository. `--extra-index-url` adds the +provided URL as an additional registry which the client checks if the package is present. +`--index-url` tells the client to check for the package on the provided URL only. + If you were following the guide and want to install the `MyPyPiPackage` package, you can run: ```shell -pip install mypypipackage --no-deps --extra-index-url https://__token__:<personal_access_token>@gitlab.example.com/api/v4/projects/<your_project_id>/packages/pypi/simple +pip install mypypipackage --no-deps --index-url https://__token__:<personal_access_token>@gitlab.example.com/api/v4/projects/<your_project_id>/packages/pypi/simple ``` This message indicates that the package was installed successfully: |