diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-18 14:02:45 +0000 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-09-18 14:02:45 +0000 |
| commit | 80f61b4035607d7cd87de993b8f5e996bde3481f (patch) | |
| tree | 06b12f51e97d87192e3dd0e05edf55143645b894 /doc/api | |
| parent | 4ab54c2233e91f60a80e5b6fa2181e6899fdcc3e (diff) | |
| download | gitlab-ce-80f61b4035607d7cd87de993b8f5e996bde3481f.tar.gz | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
52 files changed, 153 insertions, 153 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 036b46da6e5..d037ab1a95f 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -53,7 +53,7 @@ between v3 and v4; please read the [v3 to v4 documentation](v3_to_v4.md) ### Current status Currently only API version v4 is available. Version v3 was removed in -[GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819). +[GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-foss/issues/36819). ## Basic usage @@ -180,7 +180,7 @@ Impersonation tokens are used exactly like regular personal access tokens, and c #### Disable impersonation -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/40385) in GitLab +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/40385) in GitLab 11.6. By default, impersonation is enabled. To disable impersonation: @@ -377,7 +377,7 @@ Additional pagination headers are also sent back. CAUTION: **Caution:** For performance reasons since -[GitLab 11.8](https://gitlab.com/gitlab-org/gitlab-ce/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 @@ -573,8 +573,8 @@ specifically used by GitLab.com, see [GitLab.com-specific rate limits](../user/gitlab_com/index.md#gitlabcom-specific-rate-limits). [GitLab website]: https://about.gitlab.com/applications/#api-clients "Clients using the GitLab API" -[lib-api-url]: https://gitlab.com/gitlab-org/gitlab-ce/tree/master/lib/api/api.rb -[ce-3749]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/3749 -[ce-5951]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5951 -[ce-9099]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9099 +[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 [pat]: ../user/profile/personal_access_tokens.md diff --git a/doc/api/applications.md b/doc/api/applications.md index 807a0e57e8b..bcd119d1969 100644 --- a/doc/api/applications.md +++ b/doc/api/applications.md @@ -1,6 +1,6 @@ # Applications API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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 e55fffba4b2..376d8e930c7 100644 --- a/doc/api/avatar.md +++ b/doc/api/avatar.md @@ -1,6 +1,6 @@ # Avatar API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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 1d0e39e6bbf..22ddab4bf79 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-ce/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 b848d7788cd..151ab5487dd 100644 --- a/doc/api/boards.md +++ b/doc/api/boards.md @@ -482,4 +482,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-ee/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 1f17eaea46d..cf1bca7b193 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -725,8 +725,8 @@ Example response if commit is unsigned: } ``` -[ce-6096]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6096 "Multi-file commit" -[ce-8047]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8047 -[ce-15026]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15026 -[ce-18004]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/18004 -[ce-22919]: https://gitlab.com/gitlab-org/gitlab-ce/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/container_registry.md b/doc/api/container_registry.md index 0957b502340..cb1a81b97b6 100644 --- a/doc/api/container_registry.md +++ b/doc/api/container_registry.md @@ -1,6 +1,6 @@ # Container Registry API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/55978) in GitLab 11.8. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/55978) in GitLab 11.8. This is the API docs of the [GitLab Container Registry](../user/packages/container_registry/index.md). @@ -252,7 +252,7 @@ This action does not delete blobs. In order to delete them and recycle disk spac [run the garbage collection](https://docs.gitlab.com/omnibus/maintenance/README.html#removing-unused-layers-not-referenced-by-manifests). NOTE: **Note:** -Due to a [Docker Distribution deficiency](https://gitlab.com/gitlab-org/gitlab-ce/issues/21405), +Due to a [Docker Distribution deficiency](https://gitlab.com/gitlab-org/gitlab-foss/issues/21405), it doesn't remove tags whose manifest is shared by multiple tags. Examples: diff --git a/doc/api/epic_links.md b/doc/api/epic_links.md index 6089198e46a..665c902355f 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-ee/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 d6b22c3dc54..92b534fc187 100644 --- a/doc/api/epics.md +++ b/doc/api/epics.md @@ -367,4 +367,4 @@ Example response: } ``` -[ee-6448]: https://gitlab.com/gitlab-org/gitlab-ee/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 bdc7c1959d2..eb5faac5ede 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-ce/merge_requests/30444) +> - [Always enabled](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/30444) in GitLab 12.1. [GraphQL](https://graphql.org/) is a query language for APIs that @@ -58,5 +58,5 @@ It is automatically generated from GitLab's GraphQL schema and embedded in a Mar The API can be explored by using the GraphiQL IDE, it is available on your instance on `gitlab.example.com/-/graphql-explorer`. -[ce-19008]: https://gitlab.com/gitlab-org/gitlab-ce/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 f88689d80c6..afefc3925cd 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-ce/merge_requests/17082) +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/17082) in GitLab 10.6. ## Placeholder tokens @@ -99,7 +99,7 @@ POST /groups/:id/badges | `image_url` | string | yes | URL of the badge image | ```bash -curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-ce/commits/master&image_url=https://shields.io/my/badge1&position=0" https://gitlab.example.com/api/v4/groups/:id/badges +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0" https://gitlab.example.com/api/v4/groups/:id/badges ``` Example response: @@ -107,9 +107,9 @@ Example response: ```json { "id": 1, - "link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge1", - "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "rendered_image_url": "https://shields.io/my/badge1", "kind": "group" } @@ -139,9 +139,9 @@ Example response: ```json { "id": 1, - "link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge", - "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "rendered_image_url": "https://shields.io/my/badge", "kind": "group" } diff --git a/doc/api/group_boards.md b/doc/api/group_boards.md index 99b522a7ae9..444cb90a7e8 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-ee/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 29e58d9279a..8a85b5b8763 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-ce/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 e2ba0dea642..5030bba3159 100644 --- a/doc/api/group_labels.md +++ b/doc/api/group_labels.md @@ -1,6 +1,6 @@ # Group Labels API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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. @@ -15,7 +15,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-ce/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))_ | ```bash curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/5/labels?with_counts=true diff --git a/doc/api/group_level_variables.md b/doc/api/group_level_variables.md index 7b00df6d775..f4d98bf454f 100644 --- a/doc/api/group_level_variables.md +++ b/doc/api/group_level_variables.md @@ -133,4 +133,4 @@ DELETE /groups/:id/variables/:key curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/variables/VARIABLE_1" ``` -[ce-34519]: https://gitlab.com/gitlab-org/gitlab-ce/issues/34519 +[ce-34519]: https://gitlab.com/gitlab-org/gitlab-foss/issues/34519 diff --git a/doc/api/group_milestones.md b/doc/api/group_milestones.md index a819e06bcd9..61edd2522be 100644 --- a/doc/api/group_milestones.md +++ b/doc/api/group_milestones.md @@ -135,11 +135,11 @@ 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-ce/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)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/4737) in GitLab 12.1 +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4737) in GitLab 12.1 Get all burndown chart events for a single milestone. diff --git a/doc/api/groups.md b/doc/api/groups.md index 18e71f488ce..b0d60d58049 100644 --- a/doc/api/groups.md +++ b/doc/api/groups.md @@ -648,7 +648,7 @@ And to switch pages add: /groups?per_page=100&page=2 ``` -[ce-15142]: https://gitlab.com/gitlab-org/gitlab-ce/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 a991baef230..e323ebce7ca 100644 --- a/doc/api/issues.md +++ b/doc/api/issues.md @@ -1564,7 +1564,7 @@ Example response: } ``` -[ce-13004]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/13004 -[ce-14016]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14016 -[ce-17042]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/17042 -[ce-18935]: https://gitlab.com/gitlab-org/gitlab-ce/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 2a1c1b5f6f3..8ee4facc018 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-ce/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-ce/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-ce/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-ce/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-ee/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 9692cc8b710..93833fd81cb 100644 --- a/doc/api/labels.md +++ b/doc/api/labels.md @@ -11,7 +11,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-ce/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))_ | ```bash curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/1/labels?with_counts=true @@ -188,7 +188,7 @@ Example response: ## Promote a project label to a group label -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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 dacd3f4c493..80750992c51 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-ce/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 f406838e887..f5aee725c6a 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-ce/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 8784d577f99..da62dc53659 100644 --- a/doc/api/members.md +++ b/doc/api/members.md @@ -64,7 +64,7 @@ Example response: Gets a list of group or project members viewable by the authenticated user, including inherited members through ancestor groups. When a user is a member of the project/group and of one or more ancestor groups the user is returned only once with the project access_level (if exists) or the access_level for the user in the first group which he belongs to in the project groups ancestors chain. -**Note:** We plan to [change](https://gitlab.com/gitlab-org/gitlab-ce/issues/62284) this behavior to return highest access_level instead. +**Note:** We plan to [change](https://gitlab.com/gitlab-org/gitlab-foss/issues/62284) this behavior to return highest access_level instead. ``` GET /groups/:id/members/all diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md index d19f11ba1d4..264e198c596 100644 --- a/doc/api/merge_request_approvals.md +++ b/doc/api/merge_request_approvals.md @@ -527,7 +527,7 @@ PUT /projects/:id/merge_requests/:merge_request_iid/approvers ### Get the approval state of merge requests -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/13712) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/13712) in [GitLab Starter](https://about.gitlab.com/pricing/) 12.3. You can request information about a merge request's approval state by using the following endpoint: diff --git a/doc/api/merge_requests.md b/doc/api/merge_requests.md index c7637ad23de..21e24dc7934 100644 --- a/doc/api/merge_requests.md +++ b/doc/api/merge_requests.md @@ -823,7 +823,7 @@ Parameters: ## Create MR Pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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. @@ -2318,10 +2318,10 @@ Example response: } ``` -[ce-13060]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/13060 -[ce-14016]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/14016 -[ce-15454]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15454 -[ce-18935]: https://gitlab.com/gitlab-org/gitlab-ce/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/milestones.md b/doc/api/milestones.md index a6ded7d3bd2..44844470430 100644 --- a/doc/api/milestones.md +++ b/doc/api/milestones.md @@ -135,7 +135,7 @@ Parameters: ## Promote project milestone to a group milestone -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/53861) in GitLab 11.9 +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/53861) in GitLab 11.9 Only for users with developer access to the group. @@ -150,7 +150,7 @@ Parameters: ## Get all burndown chart events for a single milestone **(STARTER)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/4737) in GitLab 12.1 +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4737) in GitLab 12.1 Gets all burndown chart events for a single milestone. diff --git a/doc/api/notification_settings.md b/doc/api/notification_settings.md index c6667784617..1bd9ea7bcfd 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-ce/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-ee/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-ee/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 c852be0ad7b..13d773e4f99 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -4,7 +4,7 @@ This is the API docs of [GitLab Packages](../administration/packages/index.md). ## List project packages -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/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. @@ -44,7 +44,7 @@ By default, the `GET` request will return 20 results, since the API is [paginate ## Get a project package -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/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. @@ -74,7 +74,7 @@ Example response: ## List package files -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/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. @@ -129,7 +129,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-ee/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/pipeline_schedules.md b/doc/api/pipeline_schedules.md index acf1ac90315..59e89c3d256 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -281,7 +281,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gi ## Pipeline schedule variables -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/34518) in GitLab 10.0. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/34518) in GitLab 10.0. ## Create a new pipeline schedule variable diff --git a/doc/api/pipelines.md b/doc/api/pipelines.md index e36f74e7c77..c012c947c3a 100644 --- a/doc/api/pipelines.md +++ b/doc/api/pipelines.md @@ -268,7 +268,7 @@ Response: ## Delete a pipeline -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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 @@ -283,5 +283,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-ce/merge_requests/5837 -[ce-7209]: https://gitlab.com/gitlab-org/gitlab-ce/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_aliases.md b/doc/api/project_aliases.md index 271632b61c3..9d59ca1e3b5 100644 --- a/doc/api/project_aliases.md +++ b/doc/api/project_aliases.md @@ -1,6 +1,6 @@ # Project Aliases API **(PREMIUM ONLY)** -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/issues/3264) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/3264) in [GitLab Premium](https://about.gitlab.com/pricing/) 12.1. All methods require administrator authorization. diff --git a/doc/api/project_badges.md b/doc/api/project_badges.md index 1c382232837..527db478a50 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-ce/merge_requests/17082) +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/17082) in GitLab 10.6. ## Placeholder tokens @@ -96,7 +96,7 @@ POST /projects/:id/badges | `image_url` | string | yes | URL of the badge image | ```bash -curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-ce/commits/master&image_url=https://shields.io/my/badge1&position=0" https://gitlab.example.com/api/v4/projects/:id/badges +curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "link_url=https://gitlab.com/gitlab-org/gitlab-foss/commits/master&image_url=https://shields.io/my/badge1&position=0" https://gitlab.example.com/api/v4/projects/:id/badges ``` Example response: @@ -104,9 +104,9 @@ Example response: ```json { "id": 1, - "link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge1", - "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "rendered_image_url": "https://shields.io/my/badge1", "kind": "project" } @@ -136,9 +136,9 @@ Example response: ```json { "id": 1, - "link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "image_url": "https://shields.io/my/badge", - "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-ce/commits/master", + "rendered_link_url": "https://gitlab.com/gitlab-org/gitlab-foss/commits/master", "rendered_image_url": "https://shields.io/my/badge", "kind": "project" } diff --git a/doc/api/project_clusters.md b/doc/api/project_clusters.md index 762a4ad95ab..633ef20deb4 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-ce/merge_requests/23922) +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/23922) in GitLab 11.7. NOTE: **Note:** diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index 5155e996158..e285c721d11 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -196,4 +196,4 @@ If the status is `failed`, it will include the import error message under `impor } ``` -[ce-41899]: https://gitlab.com/gitlab-org/gitlab-ce/issues/41899 +[ce-41899]: https://gitlab.com/gitlab-org/gitlab-foss/issues/41899 diff --git a/doc/api/project_snippets.md b/doc/api/project_snippets.md index 58d9d1cd4d8..c2a39fd2178 100644 --- a/doc/api/project_snippets.md +++ b/doc/api/project_snippets.md @@ -17,7 +17,7 @@ NOTE: **Note:** From July 2019, the `Internal` visibility setting is disabled for new projects, groups, and snippets on GitLab.com. Existing projects, groups, and snippets using the `Internal` visibility setting keep this setting. You can read more about the change in the -[relevant issue](https://gitlab.com/gitlab-org/gitlab-ee/issues/12388). +[relevant issue](https://gitlab.com/gitlab-org/gitlab/issues/12388). ## List snippets @@ -212,4 +212,4 @@ Example response: } ``` -[ce-29508]: https://gitlab.com/gitlab-org/gitlab-ce/issues/29508 +[ce-29508]: https://gitlab.com/gitlab-org/gitlab-foss/issues/29508 diff --git a/doc/api/project_templates.md b/doc/api/project_templates.md index cc932e3ef58..d6ad77de429 100644 --- a/doc/api/project_templates.md +++ b/doc/api/project_templates.md @@ -16,7 +16,7 @@ Support will be added for [Issue and Merge Request templates](../user/project/de in a future release. Support for [Group-level file templates](../user/group/index.md#group-file-templates-premium) -**(PREMIUM)** was [added](https://gitlab.com/gitlab-org/gitlab-ee/issues/5987) +**(PREMIUM)** was [added](https://gitlab.com/gitlab-org/gitlab/issues/5987) in GitLab 11.5 ## Get all templates of a particular type diff --git a/doc/api/projects.md b/doc/api/projects.md index 7617620e52d..af0c8ed7c5b 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-ee/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-ee/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) | When `simple=true` or the user is unauthenticated this returns something like: @@ -815,10 +815,10 @@ If the project is a fork, and you provide a valid token to authenticate, the "default_branch":"master", "tag_list":[], "ssh_url_to_repo":"git@gitlab.com:gitlab-org/gitlab-ce.git", - "http_url_to_repo":"https://gitlab.com/gitlab-org/gitlab-ce.git", - "web_url":"https://gitlab.com/gitlab-org/gitlab-ce", + "http_url_to_repo":"https://gitlab.com/gitlab-org/gitlab-foss.git", + "web_url":"https://gitlab.com/gitlab-org/gitlab-foss", "avatar_url":"https://assets.gitlab-static.net/uploads/-/system/project/avatar/13083/logo-extra-whitespace.png", - "license_url": "https://gitlab.com/gitlab-org/gitlab-ce/blob/master/LICENSE", + "license_url": "https://gitlab.com/gitlab-org/gitlab-foss/blob/master/LICENSE", "license": { "key": "mit", "name": "MIT License", @@ -2062,4 +2062,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-ce/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 ffb4a70168b..a14c9046ca7 100644 --- a/doc/api/protected_branches.md +++ b/doc/api/protected_branches.md @@ -234,7 +234,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-ee/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. ```bash 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/releases/index.md b/doc/api/releases/index.md index 4279821d8ed..c856a06b57d 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -1,6 +1,6 @@ # Releases API -> - [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41766) in GitLab 11.7. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/41766) in GitLab 11.7. > - Using this API you can manipulate GitLab's [Release](../../user/project/releases/index.md) entries. > - For manipulating links as a release asset, see [Release Links API](links.md). @@ -592,7 +592,7 @@ Example response: ## Upcoming Releases -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/38105) in GitLab 12.1. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/38105) in GitLab 12.1. A release with a `released_at` attribute set to a future date will be labeled an **Upcoming Release** in the UI: diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index b1b75abe32f..3392cf765c1 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -1,6 +1,6 @@ # Release links API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41766) in GitLab 11.7. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/41766) in GitLab 11.7. Using this API you can manipulate GitLab's [Release](../../user/project/releases/index.md) links. For manipulating other Release assets, see [Release API](index.md). GitLab supports links links to `http`, `https`, and `ftp` assets. diff --git a/doc/api/repository_files.md b/doc/api/repository_files.md index 513dc996c91..d2ad4558641 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-ce/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/repository_submodules.md b/doc/api/repository_submodules.md index 5a722a75cb9..556a351ac1d 100644 --- a/doc/api/repository_submodules.md +++ b/doc/api/repository_submodules.md @@ -1,6 +1,6 @@ # Repository submodules API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/41213) in GitLab 11.5 +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/41213) in GitLab 11.5 ## Update existing submodule reference in repository diff --git a/doc/api/runners.md b/doc/api/runners.md index e6962d17a98..51a546e91dc 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-ce/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-ce/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 ece7f56e394..bc4f2bf9040 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-ee/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/search.md b/doc/api/search.md index 60acf600ac7..ca08f5ca0d7 100644 --- a/doc/api/search.md +++ b/doc/api/search.md @@ -1081,4 +1081,4 @@ Example response: ] ``` -[ce-41763]: https://gitlab.com/gitlab-org/gitlab-ce/issues/41763 +[ce-41763]: https://gitlab.com/gitlab-org/gitlab-foss/issues/41763 diff --git a/doc/api/services.md b/doc/api/services.md index 8c6c5738bb8..ff181f2ba61 100644 --- a/doc/api/services.md +++ b/doc/api/services.md @@ -418,7 +418,7 @@ GET /projects/:id/services/flowdock Google GSuite team collaboration tool. ->**Note:** This service was [introduced in v11.2](https://gitlab.com/gitlab-org/gitlab-ce/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 @@ -746,8 +746,8 @@ Parameters: | `recipients` | string | yes | Comma-separated list of recipient email addresses | | `add_pusher` | boolean | no | Add pusher to recipients list | | `notify_only_broken_pipelines` | boolean | no | Notify only broken pipelines | -| `notify_only_default_branch` | boolean | no | DEPRECATED: This parameter has been replaced with `branches_to_be_notified` ([introduced in GitLab 12.0](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/28271)) | | `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)) | | `pipeline_events` | boolean | false | Enable notifications for pipeline events | ### Delete Pipeline-Emails service @@ -1189,7 +1189,7 @@ GET /projects/:id/services/jenkins-deprecated ``` [jira-doc]: ../user/project/integrations/jira.md -[old-jira-api]: https://gitlab.com/gitlab-org/gitlab-ce/blob/8-13-stable/doc/api/services.md#jira +[old-jira-api]: https://gitlab.com/gitlab-org/gitlab-foss/blob/8-13-stable/doc/api/services.md#jira ## MockCI @@ -1227,7 +1227,7 @@ Get MockCI service settings for a project. GET /projects/:id/services/mock-ci ``` -[11435]: https://gitlab.com/gitlab-org/gitlab-ce/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 f90447e124e..b953c3c094a 100644 --- a/doc/api/snippets.md +++ b/doc/api/snippets.md @@ -1,6 +1,6 @@ # Snippets API -> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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/tags.md b/doc/api/tags.md index 88f63d6b34b..3807688ffe3 100644 --- a/doc/api/tags.md +++ b/doc/api/tags.md @@ -19,7 +19,7 @@ Parameters: | `sort` | string | no | Return tags sorted in `asc` or `desc` order. Default is `desc` | | `search` | string | no | Return list of tags matching the search criteria | -> Support for `search` was [introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/54401) in GitLab 11.8. +> Support for `search` was [introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/54401) in GitLab 11.8. ```json [ diff --git a/doc/api/todos.md b/doc/api/todos.md index c54c90d9f06..bc2eeccacbe 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-ce/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-ce/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-ce/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-ce/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 b41fd106fc5..380396c7377 100644 --- a/doc/api/users.md +++ b/doc/api/users.md @@ -350,7 +350,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-ce/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 @@ -1320,7 +1320,7 @@ The activities that update the timestamp are: - Git HTTP/SSH activities (such as clone, push) - User logging in into GitLab -- User visiting pages related to Dashboards, Projects, Issues and Merge Requests ([introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/54947) in GitLab 11.8) +- User visiting pages related to Dashboards, Projects, Issues and Merge Requests ([introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/54947) in GitLab 11.8) By default, it shows the activity for all users in the last 6 months, but this can be amended by using the `from` parameter. diff --git a/doc/api/v3_to_v4.md b/doc/api/v3_to_v4.md index b6059c71b27..969841b3677 100644 --- a/doc/api/v3_to_v4.md +++ b/doc/api/v3_to_v4.md @@ -3,26 +3,26 @@ Since GitLab 9.0, API V4 is the preferred version to be used. API V3 was unsupported from GitLab 9.5, released on August -22, 2017. API v3 was removed in [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-ce/issues/36819). +22, 2017. API v3 was removed in [GitLab 11.0](https://gitlab.com/gitlab-org/gitlab-foss/issues/36819). The V3 API documentation is still -[available](https://gitlab.com/gitlab-org/gitlab-ce/blob/8-16-stable/doc/api/README.md). +[available](https://gitlab.com/gitlab-org/gitlab-foss/blob/8-16-stable/doc/api/README.md). 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-ce/merge_requests/8877) -- `iid` filter has been removed from `GET /projects/:id/issues` [!8967](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/merge_requests/8793) -- Project snippets do not return deprecated field `expires_at` [!8723](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/merge_requests/9093) -- Moved `DELETE /projects/:id/star` to `POST /projects/:id/unstar` [!9328](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9328) -- Removed the following deprecated Templates endpoints (these are still accessible with `/templates` prefix) [!8853](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/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-ce/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-ce/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-ce/merge_requests/8606) -- Added `POST /environments/:environment_id/stop` to stop an environment [!8808](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/merge_requests/9366) -- Moved `PUT /users/:id/(block|unblock)` to `POST /users/:id/(block|unblock)` [!9371](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/merge_requests/8849) -- Renamed param `branch_name` to `branch` on the following endpoints [!8936](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/merge_requests/8936) -- Remove `public` param from create and edit actions of projects [!8736](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/merge_requests/9661) -- Use `visibility` as string parameter everywhere [!9337](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9337) -- Notes do not return deprecated field `upvote` and `downvote` [!9384](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/merge_requests/9523) -- Remove `GET /groups/owned`. Use `GET /groups?owned=true` instead [!9505](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/merge_requests/9096) -- Return basic info about pipeline in `GET /projects/:id/pipelines` [!8875](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8875) -- Renamed all `build` references to `job` [!9463](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9463) -- Drop `GET /projects/:id/repository/commits/:sha/jobs` [!9463](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9463) -- Rename Build Triggers to be Pipeline Triggers API [!9713](https://gitlab.com/gitlab-org/gitlab-ce/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-ce/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-ce/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-ce/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-ce/merge_requests/9679) -- Return correct `Link` header data for `GET /projects/:id/repository/commits` [!9679](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/9679) -- Update endpoints for repository files [!9637](https://gitlab.com/gitlab-org/gitlab-ce/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/wikis.md b/doc/api/wikis.md index 12f048ac09b..570fb2168b2 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-ce/merge_requests/13372 +[ce-13372]: https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/13372 ## Upload an attachment to the wiki repository |