diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-06 15:09:11 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-02-06 15:09:11 +0000 |
| commit | 0eb3d2f799ce4f4de87fb9fc6fd98e592323bc89 (patch) | |
| tree | fd70d5bc63fe152e0a67aaa5a70e4c9f16dc6ffc /doc/api | |
| parent | 5564275a0b378298dc6281599cbfe71a937109ff (diff) | |
| download | gitlab-ce-0eb3d2f799ce4f4de87fb9fc6fd98e592323bc89.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
40 files changed, 131 insertions, 131 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 30e1f1ed79c..f179885c525 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -389,7 +389,7 @@ Additional pagination headers are also sent back. CAUTION: **Caution:** For performance reasons since -[GitLab 11.8](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/23931) +[GitLab 11.8](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23931) and **behind the `api_kaminari_count_with_limit` [feature flag](../development/feature_flags.md)**, if the number of resources is more than 10,000, the `X-Total` and `X-Total-Pages` headers as well as the @@ -627,7 +627,7 @@ specifically used by GitLab.com, see [GitLab.com-specific rate limits](../user/gitlab_com/index.md#gitlabcom-specific-rate-limits). [lib-api-url]: https://gitlab.com/gitlab-org/gitlab-foss/tree/master/lib/api/api.rb -[ce-3749]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/3749 -[ce-5951]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/5951 -[ce-9099]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9099 +[ce-3749]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3749 +[ce-5951]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5951 +[ce-9099]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9099 [pat]: ../user/profile/personal_access_tokens.md diff --git a/doc/api/applications.md b/doc/api/applications.md index cb45fc742ca..37e0ad17e46 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -1,6 +1,6 @@ # Applications API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8160) in GitLab 10.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8160) in GitLab 10.5. Applications API operates on OAuth applications for: diff --git a/doc/api/avatar.md b/doc/api/avatar.md index fb664ccad82..55d5f1e613a 100644 --- a/doc/api/avatar.md +++ b/doc/api/avatar.md @@ -1,6 +1,6 @@ # Avatar API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/19121) in GitLab 11.0. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19121) in GitLab 11.0. ## Get a single avatar URL diff --git a/doc/api/award_emoji.md b/doc/api/award_emoji.md index 0b1593aba26..7fb96f4f1c0 100644 --- a/doc/api/award_emoji.md +++ b/doc/api/award_emoji.md @@ -1,6 +1,6 @@ # Award Emoji API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/4575) in GitLab 8.9. Snippet support added in 8.12. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/4575) in GitLab 8.9. Snippet support added in 8.12. An [awarded emoji](../user/award_emojis.md) tells a thousand words. diff --git a/doc/api/boards.md b/doc/api/boards.md index 326c8476ffc..54b92a7511c 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -512,4 +512,4 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1 ``` -[ee-5954]: https://gitlab.com/gitlab-org/gitlab/merge_requests/5954 +[ee-5954]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954 diff --git a/doc/api/commits.md b/doc/api/commits.md index 8eb90d10536..fb090f51a2e 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -755,8 +755,8 @@ Example response if commit is unsigned: } ``` -[ce-6096]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/6096 "Multi-file commit" -[ce-8047]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8047 -[ce-15026]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15026 -[ce-18004]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/18004 -[ce-22919]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/22919 +[ce-6096]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/6096 "Multi-file commit" +[ce-8047]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8047 +[ce-15026]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15026 +[ce-18004]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18004 +[ce-22919]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22919 diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index 4b88de6a37d..84034ee1b96 100644 --- a/doc/api/epic_links.md +++ b/doc/api/epic_links.md @@ -1,7 +1,7 @@ # Epic Links API **(ULTIMATE)** >**Note:** -> This endpoint was [introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9188) in GitLab 11.8. +> This endpoint was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) in GitLab 11.8. Manages parent-child [epic relationships](../user/group/epics/index.md#multi-level-child-epics). diff --git a/doc/api/epics.md b/doc/api/epics.md index 34b0bcba303..078bdfdba69 100644 --- a/doc/api/epics.md +++ b/doc/api/epics.md @@ -31,7 +31,7 @@ Read more on [pagination](README.md#pagination). CAUTION: **Deprecation** > `reference` attribute in response is deprecated in favour of `references`. -> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/merge_requests/20354) +> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) NOTE: **Note** > `references.relative` is relative to the group that the epic is being requested. When epic is fetched from its origin group @@ -53,7 +53,7 @@ GET /groups/:id/epics?state=opened | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `author_id` | integer | no | Return epics created by the given user `id` | | `labels` | string | no | Return epics matching a comma separated list of labels names. Label names from the epic group or a parent group can be used | -| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413)| +| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)| | `order_by` | string | no | Return epics ordered by `created_at` or `updated_at` fields. Default is `created_at` | | `sort` | string | no | Return epics sorted in `asc` or `desc` order. Default is `desc` | | `search` | string | no | Search epics against their `title` and `description` | @@ -461,4 +461,4 @@ Example response: } ``` -[ee-6448]: https://gitlab.com/gitlab-org/gitlab/merge_requests/6448 +[ee-6448]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6448 diff --git a/doc/api/graphql/index.md b/doc/api/graphql/index.md index 5675895222e..6b977d05bf5 100644 --- a/doc/api/graphql/index.md +++ b/doc/api/graphql/index.md @@ -1,7 +1,7 @@ # GraphQL API > - [Introduced][ce-19008] in GitLab 11.0 (enabled by feature flag `graphql`). -> - [Always enabled](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/30444) +> - [Always enabled](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30444) in GitLab 12.1. ## Getting Started @@ -88,5 +88,5 @@ Machine-readable versions are also available: - [JSON format](reference/gitlab_schema.json) - [IDL format](reference/gitlab_schema.graphql) -[ce-19008]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/19008 +[ce-19008]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/19008 [features-api]: ../features.md diff --git a/doc/api/group_badges.md b/doc/api/group_badges.md index d46f7198571..4fa2fa2b577 100644 --- a/doc/api/group_badges.md +++ b/doc/api/group_badges.md @@ -1,6 +1,6 @@ # Group badges API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/17082) +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6. ## Placeholder tokens diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md index dfa430cca8b..186e00022cf 100644 --- a/doc/api/group_boards.md +++ b/doc/api/group_boards.md @@ -302,7 +302,7 @@ Example response: ## Update a group issue board **(PREMIUM)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/5954) in GitLab 11.1. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954) in GitLab 11.1. Updates a Group Issue Board. diff --git a/doc/api/group_clusters.md b/doc/api/group_clusters.md index fd8b22b070b..b94b4773a1d 100644 --- a/doc/api/group_clusters.md +++ b/doc/api/group_clusters.md @@ -1,6 +1,6 @@ # Group clusters API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/30213) +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/30213) in GitLab 12.1. NOTE: **Note:** diff --git a/doc/api/group_labels.md b/doc/api/group_labels.md index 2c5406bbc21..c9c084c6d11 100644 --- a/doc/api/group_labels.md +++ b/doc/api/group_labels.md @@ -1,11 +1,11 @@ # Group Labels API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/21368) in GitLab 11.8. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/21368) in GitLab 11.8. This API supports managing of [group labels](../user/project/labels.md#project-labels-and-group-labels). It allows to list, create, update, and delete group labels. Furthermore, users can subscribe and unsubscribe to and from group labels. NOTE: **Note:** -The `description_html` - was added to response JSON in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413). +The `description_html` - was added to response JSON in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413). ## List group labels @@ -18,7 +18,7 @@ GET /groups/:id/labels | Attribute | Type | Required | Description | | --------- | ---- | -------- | ----------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user. | -| `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. _([Introduced in GitLab 12.2](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/31543))_ | +| `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. _([Introduced in GitLab 12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31543))_ | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | ```shell diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index e469217db78..c86ddab5793 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -135,7 +135,7 @@ Parameters: - `id` (required) - The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user - `milestone_id` (required) - The ID of a group milestone -[ce-12819]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/12819 +[ce-12819]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12819 ## Get all burndown chart events for a single milestone **(STARTER)** diff --git a/doc/api/groups.md b/doc/api/groups.md index 25a61632bd3..0a2446a8be9 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -870,7 +870,7 @@ And to switch pages add: /groups?per_page=100&page=2 ``` -[ce-15142]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15142 +[ce-15142]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15142 ## Group badges diff --git a/doc/api/issues.md b/doc/api/issues.md index 2bb25c6e7d5..9405851fb6f 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -14,7 +14,7 @@ Read more on [pagination](README.md#pagination). CAUTION: **Deprecation** > `reference` attribute in response is deprecated in favour of `references`. -> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/merge_requests/20354) +> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) NOTE: **Note** > `references.relative` is relative to the group / project that the issue is being requested. When issue is fetched from its project @@ -47,7 +47,7 @@ GET /issues?confidential=true | ------------------- | ---------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | `state` | string | no | Return `all` issues or just those that are `opened` or `closed` | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | -| `with_labels_details` | Boolean | no | If `true`, response will return 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)| +| `with_labels_details` | Boolean | no | If `true`, response will return 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)| | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`. Defaults to `created_by_me`<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ | @@ -203,7 +203,7 @@ GET /groups/:id/issues?confidential=true | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.md#namespaced-path-encoding) owned by the authenticated user | | `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | -| `with_labels_details` | Boolean | no | If `true`, response will return 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) | +| `with_labels_details` | Boolean | no | If `true`, response will return 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) | | `iids[]` | integer array | no | Return only the issues having the given `iid` | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | @@ -359,7 +359,7 @@ GET /projects/:id/issues?confidential=true | `iids[]` | integer array | no | Return only the milestone having the given `iid` | | `state` | string | no | Return all issues or just those that are `opened` or `closed` | | `labels` | string | no | Comma-separated list of label names, issues must have all labels to be returned. `None` lists all issues with no labels. `Any` lists all issues with at least one label. `No+Label` (Deprecated) lists all issues with no labels. Predefined names are case-insensitive. | -| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413) | +| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. `description_html` Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | | `milestone` | string | no | The milestone title. `None` lists all issues with no milestone. `Any` lists all issues that have an assigned milestone. | | `scope` | string | no | Return issues for the given scope: `created_by_me`, `assigned_to_me` or `all`.<br> For versions before 11.0, use the now deprecated `created-by-me` or `assigned-to-me` scopes instead.<br> _([Introduced][ce-13004] in GitLab 9.5. [Changed to snake_case][ce-18935] in GitLab 11.0)_ | | `author_id` | integer | no | Return issues created by the given user `id`. Mutually exclusive with `author_username`. Combine with `scope=all` or `scope=assigned_to_me`. _([Introduced][ce-13004] in GitLab 9.5)_ | @@ -1715,7 +1715,7 @@ Example response: } ``` -[ce-13004]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/13004 -[ce-14016]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/14016 -[ce-17042]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/17042 -[ce-18935]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/18935 +[ce-13004]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13004 +[ce-14016]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016 +[ce-17042]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17042 +[ce-18935]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935 diff --git a/doc/api/jobs.md b/doc/api/jobs.md index b9efb20d140..00920f94610 100644 --- a/doc/api/jobs.md +++ b/doc/api/jobs.md @@ -399,7 +399,7 @@ Possible response status codes: | 200 | Serves the artifacts file. | | 404 | Build not found or no artifacts.| -[ce-2893]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/2893 +[ce-2893]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2893 ## Download the artifacts archive @@ -466,7 +466,7 @@ Possible response status codes: | 200 | Serves the artifacts file. | | 404 | Build not found or no artifacts.| -[ce-5347]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/5347 +[ce-5347]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5347 ## Download a single artifact file by job ID @@ -504,7 +504,7 @@ Possible response status codes: ## Download a single artifact file from specific tag or branch -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/23538) in GitLab 11.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23538) in GitLab 11.5. Download a single artifact file for a specific job of the latest successful pipeline for the given reference name from within the job's artifacts archive. @@ -769,7 +769,7 @@ Example response: ## Delete artifacts -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/25522) in GitLab 11.9. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25522) in GitLab 11.9. Delete artifacts of a job. @@ -843,5 +843,5 @@ Example of response ``` [ee]: https://about.gitlab.com/pricing/ -[ee-2346]: https://gitlab.com/gitlab-org/gitlab/merge_requests/2346 +[ee-2346]: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/2346 [triggers]: ../ci/triggers/README.md#when-a-pipeline-depends-on-the-artifacts-of-another-pipeline-premium diff --git a/doc/api/labels.md b/doc/api/labels.md index f8757b71339..4ee7484d301 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -1,7 +1,7 @@ # Labels API NOTE: **Note:** -The `description_html` - was added to response JSON in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413). +The `description_html` - was added to response JSON in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413). ## List labels @@ -14,7 +14,7 @@ GET /projects/:id/labels | Attribute | Type | Required | Description | | --------- | ------- | -------- | --------------------- | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | -| `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. _([Introduced in GitLab 12.2](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/31543))_ | +| `with_counts` | boolean | no | Whether or not to include issue and merge request counts. Defaults to `false`. _([Introduced in GitLab 12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31543))_ | | `include_ancestor_groups` | boolean | no | Include ancestor groups. Defaults to `true`. | ```shell @@ -238,7 +238,7 @@ NOTE: **Note:** An older endpoint `PUT /projects/:id/labels` with `name` or `lab ## Promote a project label to a group label -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/25218) in GitLab 12.3. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/25218) in GitLab 12.3. Promotes a project label to a group label. diff --git a/doc/api/lint.md b/doc/api/lint.md index c24d891a7e2..c495bfaa7cb 100644 --- a/doc/api/lint.md +++ b/doc/api/lint.md @@ -48,4 +48,4 @@ Example responses: } ``` -[ce-5953]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/5953 +[ce-5953]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5953 diff --git a/doc/api/markdown.md b/doc/api/markdown.md index 5f6aa72903b..b9207b7ba15 100644 --- a/doc/api/markdown.md +++ b/doc/api/markdown.md @@ -26,4 +26,4 @@ Response example: { "html": "<p dir=\"auto\">Hello world! <gl-emoji title=\"party popper\" data-name=\"tada\" data-unicode-version=\"6.0\">🎉</gl-emoji></p>" } ``` -[ce-18926]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/18926 +[ce-18926]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18926 diff --git a/doc/api/members.md b/doc/api/members.md index a81a9097c3f..3b424c2deff 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -155,7 +155,7 @@ Example response: ## Get a member of a group or project, including inherited members -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/17744) in GitLab 12.4. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17744) in GitLab 12.4. Gets a member of a group or project, including members inherited through ancestor groups. See the corresponding [endpoint to list all inherited members](#list-all-members-of-a-group-or-project-including-inherited-members) for details. diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index 750bdbcb050..981a8847926 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -4,7 +4,7 @@ Every API call to merge requests must be authenticated. CAUTION: **Deprecation** > `reference` attribute in response is deprecated in favour of `references`. -> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/merge_requests/20354) +> Introduced [GitLab 12.6](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/20354) NOTE: **Note** > `references.relative` is relative to the group / project that the merge request is being requested. When merge request is fetched from its project @@ -45,7 +45,7 @@ Parameters: | `milestone` | string | no | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. | | `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request | | `labels` | string | no | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. | -| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413) | +| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | | `created_after` | datetime | no | Return merge requests created on or after the given time | | `created_before` | datetime | no | Return merge requests created on or before the given time | | `updated_after` | datetime | no | Return merge requests updated on or after the given time | @@ -221,7 +221,7 @@ Parameters: | `milestone` | string | no | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. | | `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request | | `labels` | string | no | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. | -| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413) | +| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413) | | `created_after` | datetime | no | Return merge requests created on or after the given time | | `created_before` | datetime | no | Return merge requests created on or before the given time | | `updated_after` | datetime | no | Return merge requests updated on or after the given time | @@ -383,7 +383,7 @@ Parameters: | `milestone` | string | no | Return merge requests for a specific milestone. `None` returns merge requests with no milestone. `Any` returns merge requests that have an assigned milestone. | | `view` | string | no | If `simple`, returns the `iid`, URL, title, description, and basic state of merge request | | `labels` | string | no | Return merge requests matching a comma separated list of labels. `None` lists all merge requests with no labels. `Any` lists all merge requests with at least one label. `No+Label` (Deprecated) lists all merge requests with no labels. Predefined names are case-insensitive. | -| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/merge_requests/21413)| +| `with_labels_details` | Boolean | no | If `true`, response will return more details for each label in labels field: `:name`, `:color`, `:description`, `:description_html`, `:text_color`. Default is `false`. Introduced in [GitLab 12.7](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21413)| | `created_after` | datetime | no | Return merge requests created on or after the given time | | `created_before` | datetime | no | Return merge requests created on or before the given time | | `updated_after` | datetime | no | Return merge requests updated on or after the given time | @@ -886,7 +886,7 @@ Parameters: ## Create MR Pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/31722) in GitLab 12.3. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31722) in GitLab 12.3. Create a new [pipeline for a merge request](../ci/merge_request_pipelines/index.md). A pipeline created via this endpoint will not run a regular branch/tag pipeline, it requires `.gitlab-ci.yml` to be configured with `only: [merge_requests]` to create jobs. @@ -2424,10 +2424,10 @@ Example response: } ``` -[ce-13060]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/13060 -[ce-14016]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/14016 -[ce-15454]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15454 -[ce-18935]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/18935 +[ce-13060]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13060 +[ce-14016]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/14016 +[ce-15454]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15454 +[ce-18935]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/18935 ## Approvals **(STARTER)** diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index b6b74c8ee96..71223669d5c 100644 --- a/doc/api/notification_settings.md +++ b/doc/api/notification_settings.md @@ -1,6 +1,6 @@ # Notification settings API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/5632) in GitLab 8.12. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5632) in GitLab 8.12. ## Valid notification levels @@ -84,7 +84,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab. | `merge_merge_request` | boolean | no | Enable/disable this notification | | `failed_pipeline` | boolean | no | Enable/disable this notification | | `success_pipeline` | boolean | no | Enable/disable this notification | -| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/6626) in 11.3) **(ULTIMATE)** | +| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6626) in 11.3) **(ULTIMATE)** | Example response: @@ -153,7 +153,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab. | `merge_merge_request` | boolean | no | Enable/disable this notification | | `failed_pipeline` | boolean | no | Enable/disable this notification | | `success_pipeline` | boolean | no | Enable/disable this notification | -| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/6626) in 11.3) **(ULTIMATE)** | +| `new_epic` | boolean | no | Enable/disable this notification ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6626) in 11.3) **(ULTIMATE)** | Example responses: diff --git a/doc/api/packages.md b/doc/api/packages.md index 798c83e65d4..1d39e19bbf3 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -6,7 +6,7 @@ This is the API docs of [GitLab Packages](../administration/packages/index.md). ### Within a project -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9259) in GitLab 11.8. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9259) in GitLab 11.8. Get a list of project packages. Both Maven and NPM packages are included in results. When accessed without authentication, only packages of public projects are returned. @@ -48,7 +48,7 @@ By default, the `GET` request will return 20 results, since the API is [paginate ### Within a group -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/18871) in GitLab 12.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18871) in GitLab 12.5. Get a list of project packages at the group level. When accessed without authentication, only packages of public projects are returned. @@ -126,7 +126,7 @@ The `_links` object contains the following properties: ## Get a project package -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9667) in GitLab 11.9. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9667) in GitLab 11.9. Get a single project package. @@ -177,7 +177,7 @@ The `_links` object contains the following properties: ## List package files -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9305) in GitLab 11.8. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9305) in GitLab 11.8. Get a list of package files of a single package. @@ -232,7 +232,7 @@ By default, the `GET` request will return 20 results, since the API is [paginate ## Delete a project package -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9623) in GitLab 11.9. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9623) in GitLab 11.9. Deletes a project package. diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index 4bf44723065..a3835045e5c 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -274,7 +274,7 @@ Response: ## Delete a pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/22988) in GitLab 11.6. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/22988) in GitLab 11.6. ``` DELETE /projects/:id/pipelines/:pipeline_id @@ -289,5 +289,5 @@ DELETE /projects/:id/pipelines/:pipeline_id curl --header "PRIVATE-TOKEN: <your_access_token>" --request "DELETE" "https://gitlab.example.com/api/v4/projects/1/pipelines/46" ``` -[ce-5837]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/5837 -[ce-7209]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/7209 +[ce-5837]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/5837 +[ce-7209]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/7209 diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index df3a0b9f5af..77c5d6cf37e 100644 --- a/doc/api/project_badges.md +++ b/doc/api/project_badges.md @@ -1,6 +1,6 @@ # Project badges API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/17082) +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/17082) in GitLab 10.6. ## Placeholder tokens diff --git a/doc/api/project_clusters.md b/doc/api/project_clusters.md index b52f96d0f2e..78d32acd0d2 100644 --- a/doc/api/project_clusters.md +++ b/doc/api/project_clusters.md @@ -1,6 +1,6 @@ # Project clusters API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/23922) in GitLab 11.7. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23922) in GitLab 11.7. NOTE: **Note:** User will need at least maintainer access to use these endpoints. diff --git a/doc/api/projects.md b/doc/api/projects.md index dbd21ef8c59..dd80e3ce8f3 100644 --- a/doc/api/projects.md +++ b/doc/api/projects.md @@ -55,8 +55,8 @@ GET /projects | `with_issues_enabled` | boolean | no | Limit by enabled issues feature | | `with_merge_requests_enabled` | boolean | no | Limit by enabled merge requests feature | | `with_programming_language` | string | no | Limit by projects which use the given programming language | -| `wiki_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | -| `repository_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | +| `wiki_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the wiki checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | +| `repository_checksum_failed` | boolean | no | **(PREMIUM)** Limit projects where the repository checksum calculation has failed ([Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/6137) in [GitLab Premium](https://about.gitlab.com/pricing/) 11.2) | | `min_access_level` | integer | no | Limit by current user minimal [access level](members.md) | | `id_after` | integer | no | Limit results to projects with IDs greater than the specified ID | | `id_before` | integer | no | Limit results to projects with IDs less than the specified ID | @@ -2233,4 +2233,4 @@ GET /projects/:id/snapshot | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) | | `wiki` | boolean | no | Whether to download the wiki, rather than project, repository | -[ce-27427]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/27427 +[ce-27427]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/27427 diff --git a/doc/api/protected_branches.md b/doc/api/protected_branches.md index d95aa1323f7..fe950a38b69 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -247,7 +247,7 @@ Example response: ### Example with user / group level access **(STARTER)** Elements in the `allowed_to_push` / `allowed_to_merge` / `allowed_to_unprotect` array should take the -form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in](https://gitlab.com/gitlab-org/gitlab/merge_requests/3516) in GitLab 10.3 EE. +form `{user_id: integer}`, `{group_id: integer}` or `{access_level: integer}`. Each user must have access to the project and each group must [have this project shared](../user/project/members/share_project_with_groups.md). These access levels allow [more granular control over protected branch access](../user/project/protected_branches.md#restricting-push-and-merge-access-to-certain-users-starter) and were [added to the API in](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/3516) in GitLab 10.3 EE. ```shell curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/projects/5/protected_branches?name=*-stable&allowed_to_push%5B%5D%5Buser_id%5D=1' diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index a4e63fbe21d..33611af0fe2 100644 --- a/doc/api/repository_files.md +++ b/doc/api/repository_files.md @@ -12,7 +12,7 @@ in the following table. | `read_repository` | Allows read-access to the repository files. | | `api` | Allows read-write access to the repository files. | -> `read_repository` scope was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/23534) in GitLab 11.6. +> `read_repository` scope was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/23534) in GitLab 11.6. ## Get file from repository diff --git a/doc/api/runners.md b/doc/api/runners.md index 45d68e40777..53ca97b9e41 100644 --- a/doc/api/runners.md +++ b/doc/api/runners.md @@ -2,7 +2,7 @@ > [Introduced][ce-2640] in GitLab 8.5 -[ce-2640]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/2640 +[ce-2640]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/2640 ## Registration and authentication tokens @@ -279,7 +279,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ## List runner's jobs -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/15432) in GitLab 10.3. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/15432) in GitLab 10.3. List jobs that are being processed or were processed by specified Runner. diff --git a/doc/api/scim.md b/doc/api/scim.md index be36f0e8053..11721517cbb 100644 --- a/doc/api/scim.md +++ b/doc/api/scim.md @@ -1,6 +1,6 @@ # SCIM API **(SILVER ONLY)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9388) in [GitLab Silver](https://about.gitlab.com/pricing/) 11.10. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9388) in [GitLab Silver](https://about.gitlab.com/pricing/) 11.10. The SCIM API implements the [the RFC7644 protocol](https://tools.ietf.org/html/rfc7644). diff --git a/doc/api/services.md b/doc/api/services.md index 52123320651..2f70cb21964 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -4,7 +4,7 @@ ## List all active services -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/21330) in GitLab 12.7. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/21330) in GitLab 12.7. Get a list of all active project services. @@ -557,7 +557,7 @@ GET /projects/:id/services/github Google GSuite team collaboration tool. ->**Note:** This service was [introduced in v11.2](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/20290) +>**Note:** This service was [introduced in v11.2](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/20290) ### Create/Edit Hangouts Chat service @@ -890,7 +890,7 @@ Parameters: | `add_pusher` | boolean | no | Add pusher to recipients list | | `notify_only_broken_pipelines` | boolean | no | Notify only broken pipelines | | `branches_to_be_notified` | string | all | Branches to send notifications for. Valid options are "all", "default", "protected", and "default_and_protected" | -| `notify_only_default_branch` | boolean | no | Send notifications only for the default branch ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/28271)) | +| `notify_only_default_branch` | boolean | no | Send notifications only for the default branch ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/28271)) | | `pipeline_events` | boolean | false | Enable notifications for pipeline events | ### Delete Pipeline-Emails service @@ -1369,7 +1369,7 @@ Get MockCI service settings for a project. GET /projects/:id/services/mock-ci ``` -[11435]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/11435 +[11435]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/11435 ## YouTrack diff --git a/doc/api/snippets.md b/doc/api/snippets.md index 5d9cc42d147..5c24cc60eca 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -1,6 +1,6 @@ # Snippets API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/6373) in GitLab 8.15. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/6373) in GitLab 8.15. Snippets API operates on [snippets](../user/snippets.md). @@ -351,7 +351,7 @@ Example response: ## Get user agent details -> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/12655) in GitLab 9.4. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/12655) in GitLab 9.4. NOTE: **Note:** Available only for administrators. diff --git a/doc/api/todos.md b/doc/api/todos.md index 5b92f4fb5f1..a83b045f9a4 100644 --- a/doc/api/todos.md +++ b/doc/api/todos.md @@ -98,7 +98,7 @@ Example Response: "subscribed": true, "user_notes_count": 7 }, - "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/merge_requests/7", + "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/merge_requests/7", "body": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.", "state": "pending", "created_at": "2016-06-17T07:52:35.225Z" @@ -171,7 +171,7 @@ Example Response: "subscribed": true, "user_notes_count": 7 }, - "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/merge_requests/7", + "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/merge_requests/7", "body": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.", "state": "pending", "created_at": "2016-06-17T07:49:24.624Z" @@ -269,7 +269,7 @@ Example Response: "subscribed": true, "user_notes_count": 7 }, - "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/merge_requests/7", + "target_url": "https://gitlab.example.com/gitlab-org/gitlab-foss/-/merge_requests/7", "body": "Dolores in voluptatem tenetur praesentium omnis repellendus voluptatem quaerat.", "state": "done", "created_at": "2016-06-17T07:52:35.225Z" @@ -288,4 +288,4 @@ POST /todos/mark_as_done curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/todos/mark_as_done ``` -[ce-3188]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/3188 +[ce-3188]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/3188 diff --git a/doc/api/users.md b/doc/api/users.md index e71278696de..d77df9bc6c7 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -356,7 +356,7 @@ over `password`. In addition, `reset_password` and `force_random_password` can be used together. NOTE: **Note:** -From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/29888/), `private_profile` will default to `false`. +From [GitLab 12.1](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29888/), `private_profile` will default to `false`. ``` POST /users @@ -1416,7 +1416,7 @@ Please note that `last_activity_at` is deprecated, please use `last_activity_on` ## User memberships (admin only) -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/22518) in GitLab 12.8. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/22518) in GitLab 12.8. Lists all projects and groups a user is a member of. This endpoint is available for admins only. It returns the `source_id`, `source_name`, `source_type` and `access_level` of a membership. diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md index 969841b3677..758e749e034 100644 --- a/doc/api/v3_to_v4.md +++ b/doc/api/v3_to_v4.md @@ -11,18 +11,18 @@ Below are the changes made between V3 and V4. ## 8.17 -- Removed `GET /projects/:search` (use: `GET /projects?search=x`) [!8877](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8877) -- `iid` filter has been removed from `GET /projects/:id/issues` [!8967](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8967) -- `GET /projects/:id/merge_requests?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!8793](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8793) -- Endpoints under `GET /projects/merge_request/:id` have been removed (use: `GET /projects/merge_requests/:id`) [!8793](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8793) -- Project snippets do not return deprecated field `expires_at` [!8723](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8723) -- Endpoints under `GET /projects/:id/keys` have been removed (use `GET /projects/:id/deploy_keys`) [!8716](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8716) +- Removed `GET /projects/:search` (use: `GET /projects?search=x`) [!8877](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8877) +- `iid` filter has been removed from `GET /projects/:id/issues` [!8967](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8967) +- `GET /projects/:id/merge_requests?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!8793](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8793) +- Endpoints under `GET /projects/merge_request/:id` have been removed (use: `GET /projects/merge_requests/:id`) [!8793](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8793) +- Project snippets do not return deprecated field `expires_at` [!8723](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8723) +- Endpoints under `GET /projects/:id/keys` have been removed (use `GET /projects/:id/deploy_keys`) [!8716](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8716) ## 9.0 -- Status 409 returned for `POST /projects/:id/members` when a member already exists [!9093](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9093) -- Moved `DELETE /projects/:id/star` to `POST /projects/:id/unstar` [!9328](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9328) -- Removed the following deprecated Templates endpoints (these are still accessible with `/templates` prefix) [!8853](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8853) +- Status 409 returned for `POST /projects/:id/members` when a member already exists [!9093](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9093) +- Moved `DELETE /projects/:id/star` to `POST /projects/:id/unstar` [!9328](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9328) +- Removed the following deprecated Templates endpoints (these are still accessible with `/templates` prefix) [!8853](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8853) - `/licenses` - `/licenses/:key` - `/gitignores` @@ -31,54 +31,54 @@ Below are the changes made between V3 and V4. - `/gitignores/:key` - `/gitlab_ci_ymls/:key` - `/dockerfiles/:key` -- Moved `POST /projects/fork/:id` to `POST /projects/:id/fork` [!8940](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8940) -- Moved `DELETE /todos` to `POST /todos/mark_as_done` and `DELETE /todos/:todo_id` to `POST /todos/:todo_id/mark_as_done` [!9410](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9410) -- Project filters are no longer available as `GET /projects/foo`, but as `GET /projects?foo=true` instead [!8962](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8962) +- Moved `POST /projects/fork/:id` to `POST /projects/:id/fork` [!8940](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8940) +- Moved `DELETE /todos` to `POST /todos/mark_as_done` and `DELETE /todos/:todo_id` to `POST /todos/:todo_id/mark_as_done` [!9410](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9410) +- Project filters are no longer available as `GET /projects/foo`, but as `GET /projects?foo=true` instead [!8962](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8962) - `GET /projects/visible` & `GET /projects/all` are consolidated into `GET /projects` and can be used with or without authorization - `GET /projects/owned` moved to `GET /projects?owned=true` - `GET /projects/starred` moved to `GET /projects?starred=true` -- `GET /projects` returns all projects visible to current user, even if the user is not a member [!9674](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9674) +- `GET /projects` returns all projects visible to current user, even if the user is not a member [!9674](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9674) - To get projects the user is a member of, use `GET /projects?membership=true` -- Return pagination headers for all endpoints that return an array [!8606](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8606) -- Added `POST /environments/:environment_id/stop` to stop an environment [!8808](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8808) -- Removed `DELETE /projects/:id/deploy_keys/:key_id/disable`. Use `DELETE /projects/:id/deploy_keys/:key_id` instead [!9366](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9366) -- Moved `PUT /users/:id/(block|unblock)` to `POST /users/:id/(block|unblock)` [!9371](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9371) -- Make subscription API more RESTful. Use `POST /projects/:id/:subscribable_type/:subscribable_id/subscribe` to subscribe and `POST /projects/:id/:subscribable_type/:subscribable_id/unsubscribe` to unsubscribe from a resource. [!9325](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9325) -- Labels filter on `GET /projects/:id/issues` and `GET /issues` now matches only issues containing all labels (i.e.: Logical AND, not OR) [!8849](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8849) -- Renamed param `branch_name` to `branch` on the following endpoints [!8936](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8936) +- Return pagination headers for all endpoints that return an array [!8606](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8606) +- Added `POST /environments/:environment_id/stop` to stop an environment [!8808](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8808) +- Removed `DELETE /projects/:id/deploy_keys/:key_id/disable`. Use `DELETE /projects/:id/deploy_keys/:key_id` instead [!9366](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9366) +- Moved `PUT /users/:id/(block|unblock)` to `POST /users/:id/(block|unblock)` [!9371](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9371) +- Make subscription API more RESTful. Use `POST /projects/:id/:subscribable_type/:subscribable_id/subscribe` to subscribe and `POST /projects/:id/:subscribable_type/:subscribable_id/unsubscribe` to unsubscribe from a resource. [!9325](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9325) +- Labels filter on `GET /projects/:id/issues` and `GET /issues` now matches only issues containing all labels (i.e.: Logical AND, not OR) [!8849](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8849) +- Renamed param `branch_name` to `branch` on the following endpoints [!8936](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8936) - `POST /projects/:id/repository/branches` - `POST /projects/:id/repository/commits` - `POST/PUT/DELETE :id/repository/files` -- Renamed the `merge_when_build_succeeds` parameter to `merge_when_pipeline_succeeds` on the following endpoints: [!9335](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/) +- Renamed the `merge_when_build_succeeds` parameter to `merge_when_pipeline_succeeds` on the following endpoints: [!9335](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/) - `PUT /projects/:id/merge_requests/:merge_request_id/merge` - `POST /projects/:id/merge_requests/:merge_request_id/cancel_merge_when_pipeline_succeeds` - `POST /projects` - `POST /projects/user/:user_id` - `PUT /projects/:id` -- Renamed `branch_name` to `branch` on `DELETE /projects/:id/repository/branches/:branch` response [!8936](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8936) -- Remove `public` param from create and edit actions of projects [!8736](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8736) +- Renamed `branch_name` to `branch` on `DELETE /projects/:id/repository/branches/:branch` response [!8936](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8936) +- Remove `public` param from create and edit actions of projects [!8736](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8736) - Remove `subscribed` field from responses returning list of issues or merge requests. Fetch individual issues or merge requests to obtain the value of `subscribed` - [!9661](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9661) -- Use `visibility` as string parameter everywhere [!9337](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9337) -- Notes do not return deprecated field `upvote` and `downvote` [!9384](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9384) -- Return HTTP status code `400` for all validation errors when creating or updating a member instead of sometimes `422` error. [!9523](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9523) -- Remove `GET /groups/owned`. Use `GET /groups?owned=true` instead [!9505](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9505) -- Return 202 with JSON body on async removals on V4 API (`DELETE /projects/:id/repository/merged_branches` and `DELETE /projects/:id`) [!9449](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9449) -- `GET /projects/:id/milestones?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!9096](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9096) -- Return basic info about pipeline in `GET /projects/:id/pipelines` [!8875](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/8875) -- Renamed all `build` references to `job` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9463) -- Drop `GET /projects/:id/repository/commits/:sha/jobs` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9463) -- Rename Build Triggers to be Pipeline Triggers API [!9713](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9713) + [!9661](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9661) +- Use `visibility` as string parameter everywhere [!9337](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9337) +- Notes do not return deprecated field `upvote` and `downvote` [!9384](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9384) +- Return HTTP status code `400` for all validation errors when creating or updating a member instead of sometimes `422` error. [!9523](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9523) +- Remove `GET /groups/owned`. Use `GET /groups?owned=true` instead [!9505](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9505) +- Return 202 with JSON body on async removals on V4 API (`DELETE /projects/:id/repository/merged_branches` and `DELETE /projects/:id`) [!9449](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9449) +- `GET /projects/:id/milestones?iid[]=x&iid[]=y` array filter has been renamed to `iids` [!9096](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9096) +- Return basic info about pipeline in `GET /projects/:id/pipelines` [!8875](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8875) +- Renamed all `build` references to `job` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9463) +- Drop `GET /projects/:id/repository/commits/:sha/jobs` [!9463](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9463) +- Rename Build Triggers to be Pipeline Triggers API [!9713](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9713) - `POST /projects/:id/trigger/builds` to `POST /projects/:id/trigger/pipeline` - Require description when creating a new trigger `POST /projects/:id/triggers` -- Simplify project payload exposed on Environment endpoints [!9675](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9675) -- API uses merge request `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the merge requests, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9530) -- API uses issue `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the issues, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9530) -- Change initial page from `0` to `1` on `GET /projects/:id/repository/commits` (like on the rest of the API) [!9679](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9679) -- Return correct `Link` header data for `GET /projects/:id/repository/commits` [!9679](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9679) -- Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/9637) +- Simplify project payload exposed on Environment endpoints [!9675](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9675) +- API uses merge request `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the merge requests, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530) +- API uses issue `IID`s (internal ID, as in the web UI) rather than `ID`s. This affects the issues, award emoji, todos, and time tracking APIs. [!9530](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9530) +- Change initial page from `0` to `1` on `GET /projects/:id/repository/commits` (like on the rest of the API) [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679) +- Return correct `Link` header data for `GET /projects/:id/repository/commits` [!9679](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9679) +- Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/9637) - Moved `GET /projects/:id/repository/files?file_path=:file_path` to `GET /projects/:id/repository/files/:file_path` (`:file_path` should be URL-encoded) - `GET /projects/:id/repository/blobs/:sha` now returns JSON attributes for the blob identified by `:sha`, instead of finding the commit identified by `:sha` and returning the raw content of the blob in that commit identified by the required `?filepath=:filepath` - Moved `GET /projects/:id/repository/commits/:sha/blob?file_path=:file_path` and `GET /projects/:id/repository/blobs/:sha?file_path=:file_path` to `GET /projects/:id/repository/files/:file_path/raw?ref=:sha` diff --git a/doc/api/visual_review_discussions.md b/doc/api/visual_review_discussions.md index a1076e09fc8..3d1c5e5c4c8 100644 --- a/doc/api/visual_review_discussions.md +++ b/doc/api/visual_review_discussions.md @@ -1,6 +1,6 @@ # Visual Review discussions API **(STARTER)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/18710) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18710) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.5. Visual Review discussions are notes on Merge Requests sent as feedback from [Visual Reviews](../ci/review_apps/index.md#visual-reviews-starter). diff --git a/doc/api/vulnerability_findings.md b/doc/api/vulnerability_findings.md index 18b9fb6c630..833a46ccce5 100644 --- a/doc/api/vulnerability_findings.md +++ b/doc/api/vulnerability_findings.md @@ -1,6 +1,6 @@ # Vulnerability Findings API **(ULTIMATE)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/19029) in GitLab Ultimate 12.5. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/19029) in GitLab Ultimate 12.5. NOTE: **Note:** This API resource is renamed from Vulnerabilities to Vulnerability Findings because the Vulnerabilities are reserved diff --git a/doc/api/wikis.md b/doc/api/wikis.md index 57e5621277f..6cde2ebb7a7 100644 --- a/doc/api/wikis.md +++ b/doc/api/wikis.md @@ -153,7 +153,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git On success the HTTP status code is `204` and no JSON response is expected. -[ce-13372]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/13372 +[ce-13372]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/13372 ## Upload an attachment to the wiki repository |