diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-05-04 15:10:04 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-05-04 15:10:04 +0300 |
commit | 998adcc422d4161515bf2960ef4dce71258f69a3 (patch) | |
tree | 34ffbf53b8587d3367457d4175fc8dfd71477dca /doc | |
parent | e2c471038ab2b4f09487c1feb74520f74f834986 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
13 files changed, 391 insertions, 51 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 6c170bab6e7..84279fd0b90 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -283,6 +283,18 @@ four standard [pagination arguments](#connection-pagination-arguments): | <a id="queryprojectssearchnamespaces"></a>`searchNamespaces` | [`Boolean`](#boolean) | Include namespace in project search. | | <a id="queryprojectssort"></a>`sort` | [`String`](#string) | Sort order of results. | +### `Query.runner` + +Find a runner. Available only when feature flag `runner_graphql_query` is enabled. + +Returns [`CiRunner`](#cirunner). + +#### Arguments + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="queryrunnerid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | Runner ID. | + ### `Query.runnerPlatforms` Supported runner platforms. @@ -7242,6 +7254,7 @@ Represents the total number of issues and their weights for a particular day. | <a id="cijobstatus"></a>`status` | [`CiJobStatus`](#cijobstatus) | Status of the job. | | <a id="cijobtags"></a>`tags` | [`[String!]`](#string) | Tags for the current job. | | <a id="cijobtriggered"></a>`triggered` | [`Boolean`](#boolean) | Whether the job was triggered. | +| <a id="cijobuserpermissions"></a>`userPermissions` | [`JobPermissions!`](#jobpermissions) | Permissions for the current user on the resource. | ### `CiJobArtifact` @@ -7252,6 +7265,28 @@ Represents the total number of issues and their weights for a particular day. | <a id="cijobartifactdownloadpath"></a>`downloadPath` | [`String`](#string) | URL for downloading the artifact's file. | | <a id="cijobartifactfiletype"></a>`fileType` | [`JobArtifactFileType`](#jobartifactfiletype) | File type of the artifact. | +### `CiRunner` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="cirunneraccesslevel"></a>`accessLevel` | [`CiRunnerAccessLevel!`](#cirunneraccesslevel) | Access level of the runner. | +| <a id="cirunneractive"></a>`active` | [`Boolean!`](#boolean) | Indicates the runner is allowed to receive jobs. | +| <a id="cirunnercontactedat"></a>`contactedAt` | [`Time`](#time) | Last contact from the runner. | +| <a id="cirunnerdescription"></a>`description` | [`String`](#string) | Description of the runner. | +| <a id="cirunnerid"></a>`id` | [`CiRunnerID!`](#cirunnerid) | ID of the runner. | +| <a id="cirunneripaddress"></a>`ipAddress` | [`String!`](#string) | IP address of the runner. | +| <a id="cirunnerlocked"></a>`locked` | [`Boolean`](#boolean) | Indicates the runner is locked. | +| <a id="cirunnermaximumtimeout"></a>`maximumTimeout` | [`Int`](#int) | Maximum timeout (in seconds) for jobs processed by the runner. | +| <a id="cirunnerrevision"></a>`revision` | [`String!`](#string) | Revision of the runner. | +| <a id="cirunnerrununtagged"></a>`runUntagged` | [`Boolean!`](#boolean) | Indicates the runner is able to run untagged jobs. | +| <a id="cirunnerrunnertype"></a>`runnerType` | [`CiRunnerType!`](#cirunnertype) | Type of the runner. | +| <a id="cirunnershortsha"></a>`shortSha` | [`String`](#string) | First eight characters of the runner's token used to authenticate new job requests. Used as the runner's unique ID. | +| <a id="cirunnerstatus"></a>`status` | [`CiRunnerStatus!`](#cirunnerstatus) | Status of the runner. | +| <a id="cirunnertaglist"></a>`tagList` | [`[String!]`](#string) | Tags associated with the runner. | +| <a id="cirunnerversion"></a>`version` | [`String!`](#string) | Version of the runner. | + ### `CiStage` #### Fields @@ -9455,6 +9490,16 @@ four standard [pagination arguments](#connection-pagination-arguments): | <a id="jirauserjiradisplayname"></a>`jiraDisplayName` | [`String!`](#string) | Display name of the Jira user. | | <a id="jirauserjiraemail"></a>`jiraEmail` | [`String`](#string) | Email of the Jira user, returned only for users with public emails. | +### `JobPermissions` + +#### Fields + +| Name | Type | Description | +| ---- | ---- | ----------- | +| <a id="jobpermissionsreadbuild"></a>`readBuild` | [`Boolean!`](#boolean) | Indicates the user can perform `read_build` on this resource. | +| <a id="jobpermissionsreadjobartifacts"></a>`readJobArtifacts` | [`Boolean!`](#boolean) | Indicates the user can perform `read_job_artifacts` on this resource. | +| <a id="jobpermissionsupdatebuild"></a>`updateBuild` | [`Boolean!`](#boolean) | Indicates the user can perform `update_build` on this resource. | + ### `Label` #### Fields @@ -13329,6 +13374,30 @@ Values for YAML processor result. | <a id="cijobstatussuccess"></a>`SUCCESS` | A job that is success. | | <a id="cijobstatuswaiting_for_resource"></a>`WAITING_FOR_RESOURCE` | A job that is waiting for resource. | +### `CiRunnerAccessLevel` + +| Value | Description | +| ----- | ----------- | +| <a id="cirunneraccesslevelnot_protected"></a>`NOT_PROTECTED` | A runner that is not protected. | +| <a id="cirunneraccesslevelref_protected"></a>`REF_PROTECTED` | A runner that is ref protected. | + +### `CiRunnerStatus` + +| Value | Description | +| ----- | ----------- | +| <a id="cirunnerstatusactive"></a>`ACTIVE` | A runner that is active. | +| <a id="cirunnerstatusoffline"></a>`OFFLINE` | A runner that is offline. | +| <a id="cirunnerstatusonline"></a>`ONLINE` | A runner that is online. | +| <a id="cirunnerstatuspaused"></a>`PAUSED` | A runner that is paused. | + +### `CiRunnerType` + +| Value | Description | +| ----- | ----------- | +| <a id="cirunnertypegroup_type"></a>`GROUP_TYPE` | A runner that is group type. | +| <a id="cirunnertypeinstance_type"></a>`INSTANCE_TYPE` | A runner that is instance type. | +| <a id="cirunnertypeproject_type"></a>`PROJECT_TYPE` | A runner that is project type. | + ### `CommitActionMode` Mode of a commit action. @@ -14434,6 +14503,12 @@ A `CiPipelineID` is a global ID. It is encoded as a string. An example `CiPipelineID` is: `"gid://gitlab/Ci::Pipeline/1"`. +### `CiRunnerID` + +A `CiRunnerID` is a global ID. It is encoded as a string. + +An example `CiRunnerID` is: `"gid://gitlab/Ci::Runner/1"`. + ### `ClustersAgentID` A `ClustersAgentID` is a global ID. It is encoded as a string. diff --git a/doc/api/issues.md b/doc/api/issues.md index a9a3f04a064..cd720748cae 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -27,6 +27,8 @@ When requested across groups or projects, it's expected to be the same as the `f ## List issues +> Moved `weight` to [GitLab Premium](https://about.gitlab.com/pricing/) due to Starter/Bronze being [discontinued](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) in 13.9. + Get all issues the authenticated user has access to. By default it returns only issues created by the current user. To get all issues, use parameter `scope=all`. @@ -75,7 +77,7 @@ GET /issues?state=opened | `state` | string | no | Return `all` issues or just those that are `opened` or `closed` | | `updated_after` | datetime | no | Return issues updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return issues updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | +| `weight` **(PREMIUM)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `with_labels_details` | boolean | no | If `true`, the response returns more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)| ```shell @@ -169,8 +171,7 @@ Example response: ] ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json [ @@ -183,8 +184,25 @@ the `weight` parameter: ] ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -201,6 +219,10 @@ WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account @@ -208,6 +230,8 @@ that closed the issue still exists. ## List group issues +> Moved `weight` to [GitLab Premium](https://about.gitlab.com/pricing/) due to Starter/Bronze being [discontinued](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) in 13.9. + Get a list of a group's issues. If the group is private, credentials need to be provided for authorization. @@ -256,7 +280,7 @@ GET /groups/:id/issues?state=opened | `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `updated_after` | datetime | no | Return issues updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return issues updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | +| `weight` **(PREMIUM)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `with_labels_details` | boolean | no | If `true`, the response returns more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. The `description_html` attribute was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | ```shell @@ -349,8 +373,7 @@ Example response: ] ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json [ @@ -363,8 +386,25 @@ the `weight` parameter: ] ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -380,6 +420,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed @@ -387,6 +431,8 @@ the issue still exists. ## List project issues +> Moved `weight` to [GitLab Premium](https://about.gitlab.com/pricing/) due to Starter/Bronze being [discontinued](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) in 13.9. + Get a list of a project's issues. If the project is private, you need to provide credentials to authorize. @@ -434,7 +480,7 @@ GET /projects/:id/issues?state=opened | `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `updated_after` | datetime | no | Return issues updated on or after the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | | `updated_before` | datetime | no | Return issues updated on or before the given time. Expected in ISO 8601 format (`2019-03-15T08:00:00Z`) | -| `weight` **(STARTER)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | +| `weight` **(PREMIUM)** | integer | no | Return issues with the specified `weight`. `None` returns issues with no weight assigned. `Any` returns issues with a weight assigned. | | `with_labels_details` | boolean | no | If `true`, the response returns more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` was introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | ```shell @@ -534,8 +580,7 @@ Example response: ] ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json [ @@ -548,8 +593,25 @@ the `weight` parameter: ] ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -565,6 +627,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -672,14 +738,11 @@ Example response: "project": "http://gitlab.example:3000/api/v4/projects/1" }, "moved_to_id": null, - "service_desk_reply_to": "service.desk@gitlab.com", - "epic_iid": null, - "epic": null + "service_desk_reply_to": "service.desk@gitlab.com" } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -690,10 +753,9 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `epic` property: +Issues created by users on GitLab Premium or higher include the `epic` property: -```javascript +```json { "project_id" : 4, "description" : "Omnis vero earum sunt corporis dolor et placeat.", @@ -706,10 +768,24 @@ the `epic` property: "url" : "/groups/h5bp/-/epics/5", "group_id": 8 }, - // ... + ... } ``` +Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see the `health_status` +property: + +```json +[ + { + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "health_status": "on_track", + ... + } +] +``` + WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. @@ -827,8 +903,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -839,10 +914,9 @@ the `weight` parameter: } ``` -Users of [GitLab Premium](https://about.gitlab.com/pricing/) can also see -the `epic` property: +Issues created by users on GitLab Premium or higher include the `epic` property: -```javascript +```json { "project_id" : 4, "description" : "Omnis vero earum sunt corporis dolor et placeat.", @@ -854,7 +928,7 @@ the `epic` property: "url" : "/groups/h5bp/-/epics/5", "group_id": 8 }, - // ... + ... } ``` @@ -885,6 +959,8 @@ the issue still exists. ## New issue +> Moved `weight` to [GitLab Premium](https://about.gitlab.com/pricing/) due to Starter/Bronze being [discontinued](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) in 13.9. + Creates a new project issue. ```plaintext @@ -908,7 +984,7 @@ POST /projects/:id/issues | `merge_request_to_resolve_discussions_of` | integer | no | The IID of a merge request in which to resolve all issues. This fills out the issue with a default description and mark all discussions as resolved. When passing a description or title, these values take precedence over the default values.| | `milestone_id` | integer | no | The global ID of a milestone to assign issue | | `title` | string | yes | The title of an issue | -| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. | +| `weight` **(PREMIUM)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. | ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues?title=Issues%20with%20auth&labels=bug" @@ -975,8 +1051,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -987,8 +1062,25 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -1004,6 +1096,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -1015,6 +1111,8 @@ See [Issues rate limits](../user/admin_area/settings/rate_limit_on_issues_creati ## Edit issue +> Moved `weight` to [GitLab Premium](https://about.gitlab.com/pricing/) due to Starter/Bronze being [discontinued](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) in 13.9. + Updates an existing project issue. This call is also used to mark an issue as closed. @@ -1054,7 +1152,7 @@ PUT /projects/:id/issues/:issue_iid | `state_event` | string | no | The state event of an issue. Set `close` to close the issue and `reopen` to reopen it | | `title` | string | no | The title of an issue | | `updated_at` | string | no | When the issue was updated. Date time string, ISO 8601 formatted, for example `2016-03-11T03:45:40Z` (requires administrator or project owner rights). Empty string or null values are not accepted.| -| `weight` **(STARTER)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 | +| `weight` **(PREMIUM)** | integer | no | The weight of the issue. Valid values are greater than or equal to 0. 0 | ```shell curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/4/issues/85?state_event=close" @@ -1128,8 +1226,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -1140,8 +1237,25 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -1159,6 +1273,10 @@ The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/git the issue still exists. WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + +WARNING: `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. ## Delete an issue @@ -1293,8 +1411,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -1305,8 +1422,25 @@ the `weight` parameter: } ``` -Users of [GitLab Ultimate](https://about.gitlab.com/pricing/) can also see -the `health_status` parameter: +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: ```json [ @@ -1322,6 +1456,10 @@ the `health_status` parameter: WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. @@ -1416,8 +1554,7 @@ Example response: } ``` -Users of [GitLab Premium or higher](https://about.gitlab.com/pricing/) can also see -the `weight` parameter: +Issues created by users on GitLab Premium or higher include the `weight` property: ```json { @@ -1428,9 +1565,44 @@ the `weight` parameter: } ``` +Issues created by users on GitLab Premium or higher include the `epic` property: + +```json +{ + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "epic_iid" : 5, //deprecated, use `iid` of the `epic` attribute + "epic": { + "id" : 42, + "iid" : 5, + "title": "My epic epic", + "url" : "/groups/h5bp/-/epics/5", + "group_id": 8 + }, + ... +} +``` + +Issues created by users on GitLab Ultimate include the `health_status` property: + +```json +[ + { + "project_id" : 4, + "description" : "Omnis vero earum sunt corporis dolor et placeat.", + "health_status": "on_track", + ... + } +] +``` + WARNING: The `assignee` column is deprecated. We now show it as a single-sized array `assignees` to conform to the GitLab EE API. +WARNING: +The `epic_iid` attribute is deprecated and [scheduled for removal in API version 5](https://gitlab.com/gitlab-org/gitlab/-/issues/35157). +Please use `iid` of the `epic` attribute instead. + NOTE: The `closed_by` attribute was [introduced in GitLab 10.6](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042). This value is only present for issues closed after GitLab 10.6 and if the user account that closed the issue still exists. diff --git a/doc/development/import_export.md b/doc/development/import_export.md index fd795880d2d..bc1927fffde 100644 --- a/doc/development/import_export.md +++ b/doc/development/import_export.md @@ -284,6 +284,27 @@ methods: - :type ``` +Customize the export order of the model relationships: + +```yaml +# Specify a custom export reordering for a given relationship +# For example for issues we use a custom export reordering by relative_position, so that on import, we can reset the +# relative position value, but still keep the issues order to the order in which issues were in the exported project. +# By default the ordering of relations is done by PK. +# column - specify the column by which to reorder, by default it is relation's PK +# direction - specify the ordering direction :asc or :desc, default :asc +# nulls_position - specify where would null values be positioned. Because custom ordering column can contain nulls we +# need to also specify where would the nulls be placed. It can be :nulls_last or :nulls_first, defaults +# to :nulls_last + +export_reorders: + project: + issues: + column: :relative_position + direction: :asc + nulls_position: :nulls_last +``` + ### Import The import job status moves from `none` to `finished` or `failed` into different states: diff --git a/doc/development/usage_ping/dictionary.md b/doc/development/usage_ping/dictionary.md index e15048adfb3..7d0da849cef 100644 --- a/doc/development/usage_ping/dictionary.md +++ b/doc/development/usage_ping/dictionary.md @@ -1100,6 +1100,54 @@ Status: `data_available` Tiers: `free` +### `counts.g_project_management_users_checking_epic_task_monthly` + +Counts of MAU checking epic task + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210421080207_g_project_management_users_checking_epic_task_monthly.yml) + +Group: `group::product planning` + +Status: `implemented` + +Tiers: `premium`, `ultimate` + +### `counts.g_project_management_users_checking_epic_task_weekly` + +Counts of WAU checking epic task + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210421075943_g_project_management_users_checking_epic_task_weekly.yml) + +Group: `group::product planning` + +Status: `implemented` + +Tiers: `premium`, `ultimate` + +### `counts.g_project_management_users_unchecking_epic_task_monthly` + +Counts of MAU unchecking epic task + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_28d/20210421102516_g_project_management_users_unchecking_epic_task_monthly.yml) + +Group: `group::product planning` + +Status: `implemented` + +Tiers: `premium`, `ultimate` + +### `counts.g_project_management_users_unchecking_epic_task_weekly` + +Counts of WAU unchecking epic task + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210421102812_g_project_management_users_unchecking_epic_task_weekly.yml) + +Group: `group::product planning` + +Status: `implemented` + +Tiers: `premium`, `ultimate` + ### `counts.geo_event_log_max_id` Number of replication events on a Geo primary @@ -6430,7 +6478,7 @@ Tiers: `free`, `premium`, `ultimate` ### `database.pg_system_id` -Missing description +TBD [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210216183248_pg_system_id.yml) @@ -7764,7 +7812,7 @@ Tiers: `free`, `premium`, `ultimate` Number of projects using 5 min production app CI template in last 7 days. -[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_7d/20210216184515_p_ci_templates_5_min_production_app_weekly.yml) +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_7d/20210216184515_p_ci_templates_5_min_production_app_weekly.yml) Group: `group::5-min-app` @@ -15370,6 +15418,18 @@ Status: `data_available` Tiers: `free` +### `usage_activity_by_stage.manage.custom_compliance_frameworks` + +Total count of all custom compliance framework labels + +[YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/config/metrics/counts_all/20210430081610_custom_compliance_frameworks.yml) + +Group: `compliance` + +Status: `implemented` + +Tiers: `premium`, `ultimate` + ### `usage_activity_by_stage.manage.events` Missing description @@ -16010,6 +16070,8 @@ Tiers: `free` Histogram (buckets 1 to 100) of projects with at least 1 enabled integration. +[Object JSON schema](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/objects_schemas/projects_with_enabled_alert_integrations_histogram.json) + [YAML definition](https://gitlab.com/gitlab-org/gitlab/-/blob/master/config/metrics/counts_all/20210309165717_projects_with_enabled_alert_integrations_histogram.yml) Group: `group::monitor` diff --git a/doc/user/project/repository/branches/img/branch_filter_search_box_v13_10.png b/doc/user/project/repository/branches/img/branch_filter_search_box_v13_10.png Binary files differdeleted file mode 100644 index fdda3858c3b..00000000000 --- a/doc/user/project/repository/branches/img/branch_filter_search_box_v13_10.png +++ /dev/null diff --git a/doc/user/project/repository/branches/img/branch_filter_search_box_v13_12.png b/doc/user/project/repository/branches/img/branch_filter_search_box_v13_12.png Binary files differnew file mode 100644 index 00000000000..a1cf9f10122 --- /dev/null +++ b/doc/user/project/repository/branches/img/branch_filter_search_box_v13_12.png diff --git a/doc/user/project/repository/branches/img/compare_branches_v13_10.png b/doc/user/project/repository/branches/img/compare_branches_v13_10.png Binary files differdeleted file mode 100644 index 2b9a5751938..00000000000 --- a/doc/user/project/repository/branches/img/compare_branches_v13_10.png +++ /dev/null diff --git a/doc/user/project/repository/branches/img/compare_branches_v13_12.png b/doc/user/project/repository/branches/img/compare_branches_v13_12.png Binary files differnew file mode 100644 index 00000000000..29627406729 --- /dev/null +++ b/doc/user/project/repository/branches/img/compare_branches_v13_12.png diff --git a/doc/user/project/repository/branches/img/repository_filter_search_box_v13_10.png b/doc/user/project/repository/branches/img/repository_filter_search_box_v13_10.png Binary files differdeleted file mode 100644 index fdda3858c3b..00000000000 --- a/doc/user/project/repository/branches/img/repository_filter_search_box_v13_10.png +++ /dev/null diff --git a/doc/user/project/repository/branches/img/repository_filter_search_box_v13_12.png b/doc/user/project/repository/branches/img/repository_filter_search_box_v13_12.png Binary files differnew file mode 100644 index 00000000000..230abf0d875 --- /dev/null +++ b/doc/user/project/repository/branches/img/repository_filter_search_box_v13_12.png diff --git a/doc/user/project/repository/branches/img/swap_revisions_after_v13_12.png b/doc/user/project/repository/branches/img/swap_revisions_after_v13_12.png Binary files differnew file mode 100644 index 00000000000..7eb10d10938 --- /dev/null +++ b/doc/user/project/repository/branches/img/swap_revisions_after_v13_12.png diff --git a/doc/user/project/repository/branches/img/swap_revisions_before_v13_12.png b/doc/user/project/repository/branches/img/swap_revisions_before_v13_12.png Binary files differnew file mode 100644 index 00000000000..f92c4279871 --- /dev/null +++ b/doc/user/project/repository/branches/img/swap_revisions_before_v13_12.png diff --git a/doc/user/project/repository/branches/index.md b/doc/user/project/repository/branches/index.md index 2924703ac26..5239f2bbf32 100644 --- a/doc/user/project/repository/branches/index.md +++ b/doc/user/project/repository/branches/index.md @@ -53,7 +53,7 @@ To compare branches in a repository: 1. Select branches to compare using the [branch filter search box](#branch-filter-search-box). 1. Click **Compare** to view the changes inline: - ![compare branches](img/compare_branches_v13_10.png) + ![compare branches](img/compare_branches_v13_12.png) ## Delete merged branches @@ -74,7 +74,7 @@ automatically when a merge request was merged. This feature allows you to search and select a repository quickly when [comparing branches](#compare). -![Repository filter search box](img/repository_filter_search_box_v13_10.png) +![Repository filter search box](img/repository_filter_search_box_v13_12.png) Search results appear in the following order: @@ -85,7 +85,7 @@ Search results appear in the following order: > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22166) in GitLab 11.5. -![Branch filter search box](img/branch_filter_search_box_v13_10.png) +![Branch filter search box](img/branch_filter_search_box_v13_12.png) This feature allows you to search and select branches quickly. Search results appear in the following order: @@ -97,6 +97,16 @@ Sometimes when you have hundreds of branches you may want a more flexible matchi - `^feature` matches only branch names that begin with 'feature'. - `feature$` matches only branch names that end with 'feature'. +## Swap revisions + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/60491) in GitLab 13.12. + +![Before swap revisions](img/swap_revisions_before_v13_12.png) + +The Swap revisions feature allows you to swap the Source and Target revisions. When the Swap revisions button is clicked, the selected revisions for Source and Targed will be swapped. + +![After swap revisions](img/swap_revisions_after_v13_12.png) + <!-- ## Troubleshooting Include any troubleshooting steps that you can foresee. If you know beforehand what issues |