diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-05-19 15:09:09 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-05-19 15:09:09 +0000 |
| commit | d0bb0e04f40b962576353ce56e270aa7bd25a5c0 (patch) | |
| tree | 8d78f5e9adf8d965f84869c936ac997e8748900e /doc/api | |
| parent | 0eea37aefa31ed22e32eadbe6164dd92e3c64ec2 (diff) | |
| download | gitlab-ce-d0bb0e04f40b962576353ce56e270aa7bd25a5c0.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/dora4_project_analytics.md | 49 | ||||
| -rw-r--r-- | doc/api/graphql/reference/index.md | 11 | ||||
| -rw-r--r-- | doc/api/pipelines.md | 9 | ||||
| -rw-r--r-- | doc/api/usage_data.md | 8 |
4 files changed, 29 insertions, 48 deletions
diff --git a/doc/api/dora4_project_analytics.md b/doc/api/dora4_project_analytics.md index 53170c3a77f..19c7afd9d22 100644 --- a/doc/api/dora4_project_analytics.md +++ b/doc/api/dora4_project_analytics.md @@ -3,52 +3,11 @@ stage: Manage group: Optimize 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 +remove_date: '2022-05-18' +redirect_to: 'dora/metrics.md' --- -# DORA4 Analytics Project API **(ULTIMATE)** - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/279039) in GitLab 13.7. +# DORA4 Analytics Project API (removed) **(ULTIMATE)** WARNING: -These endpoints have been removed in GitLab 14.0. Use the [DORA metrics API](dora/metrics.md) instead. - -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 | -| `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 - } -] -``` +This feature was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/323713) in 13.11 and removed in GitLab 14.0. Use the [DORA metrics API](dora/metrics.md) instead. diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 669ba3bc13d..482d5c926d1 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -145,6 +145,17 @@ Returns [`String!`](#string). | ---- | ---- | ----------- | | <a id="queryechotext"></a>`text` | [`String!`](#string) | Text to echo back. | +### `Query.epicBoardList` + +Returns [`EpicList`](#epiclist). + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="queryepicboardlistepicfilters"></a>`epicFilters` | [`EpicFilters`](#epicfilters) | Filters applied when getting epic metadata in the epic board list. | +| <a id="queryepicboardlistid"></a>`id` | [`BoardsEpicListID!`](#boardsepiclistid) | Global ID of the list. | + ### `Query.geoNode` Find a Geo node. diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index b05c71d2748..3f5274edc0a 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -422,6 +422,15 @@ Response: > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22988) in GitLab 11.6. +Deleting a pipeline expires all pipeline caches, and deletes all immediately +related objects, such as builds, logs, artifacts, and triggers. +**This action cannot be undone.** + +Deleting a pipeline does not automatically delete its +[child pipelines](../ci/pipelines/parent_child_pipelines.md). +See the [related issue](https://gitlab.com/gitlab-org/gitlab/-/issues/39503) +for details. + ```plaintext DELETE /projects/:id/pipelines/:pipeline_id ``` diff --git a/doc/api/usage_data.md b/doc/api/usage_data.md index c7064ebf65b..be816a0f864 100644 --- a/doc/api/usage_data.md +++ b/doc/api/usage_data.md @@ -50,10 +50,10 @@ Example response: ## Export Service Ping SQL queries -This action is available only for the GitLab instance [Administrator](../user/permissions.md) users. +This action is behind the `usage_data_queries_api` feature flag and is available only for the GitLab instance [Administrator](../user/permissions.md) users. > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57016) in GitLab 13.11. -> - [Deployed behind a feature flag](../user/feature_flags.md), disabled by default. +> - [Deployed behind a feature flag](../user/feature_flags.md) named `usage_data_queries_api`, disabled by default. Return all of the raw SQL queries used to compute Service Ping. @@ -113,8 +113,10 @@ Example response: ## UsageDataNonSqlMetrics API +This action is behind the `usage_data_non_sql_metrics` feature flag and is available only for the GitLab instance [Administrator](../user/permissions.md) users. + > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57050) in GitLab 13.11. -> - [Deployed behind a feature flag](../user/feature_flags.md), disabled by default. +> - [Deployed behind a feature flag](../user/feature_flags.md), named `usage_data_non_sql_metrics`, disabled by default. Return all non-SQL metrics data used in the Service ping. |
