diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-04-26 15:09:18 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-04-26 15:09:18 +0300 |
commit | 9edf852c3a851d84b85bc94f7a3b41d5ef04dd32 (patch) | |
tree | f79a739a455d5d02758e225582688c0451465aa6 /doc/api | |
parent | 6f22c85c38b7a896178879172f4c0f82353308f8 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/releases/index.md | 23 | ||||
-rw-r--r-- | doc/api/releases/links.md | 41 |
2 files changed, 52 insertions, 12 deletions
diff --git a/doc/api/releases/index.md b/doc/api/releases/index.md index 8956a71e403..86c23283588 100644 --- a/doc/api/releases/index.md +++ b/doc/api/releases/index.md @@ -26,7 +26,11 @@ For authentication, the Releases API accepts either: ## List Releases -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/72448) to allow for `JOB-TOKEN` in GitLab 14.5. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/72448) to allow for `JOB-TOKEN` in GitLab 14.5. +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> +> - The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. +<!--- end_remove --> Returns a paginated list of releases, sorted by `released_at`. @@ -158,14 +162,12 @@ Example response: "id":2, "name":"awesome-v0.2.msi", "url":"http://192.168.10.15:3000/msi", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" }, { "id":1, "name":"awesome-v0.2.dmg", "url":"http://192.168.10.15:3000", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ], @@ -256,7 +258,11 @@ Example response: ## Get a Release by a tag name -> [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/72448) to allow for `JOB-TOKEN` in GitLab 14.5. +> - [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/72448) to allow for `JOB-TOKEN` in GitLab 14.5. +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> +> - The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. +<!--- end_remove --> Gets a release for the given tag. @@ -386,7 +392,6 @@ Example response: "id":3, "name":"hoge", "url":"https://gitlab.example.com/root/awesome-app/-/tags/v0.11.1/binaries/linux-amd64", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ] @@ -466,6 +471,13 @@ By default, GitLab fetches the release using `released_at` time. The use of the ## Create a release +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> + +> The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. + +<!--- end_remove --> + Creates a release. Developer level access to the project is required to create a release. ```plaintext @@ -594,7 +606,6 @@ Example response: "id":3, "name":"hoge", "url":"https://gitlab.example.com/root/awesome-app/-/tags/v0.11.1/binaries/linux-amd64", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ], diff --git a/doc/api/releases/links.md b/doc/api/releases/links.md index 7c2cac90a3d..a1abded5ed4 100644 --- a/doc/api/releases/links.md +++ b/doc/api/releases/links.md @@ -15,6 +15,13 @@ GitLab supports links to `http`, `https`, and `ftp` assets. ## List links of a release +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> + +> The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. + +<!--- end_remove --> + Get assets as links from a release. ```plaintext @@ -40,14 +47,12 @@ Example response: "id":2, "name":"awesome-v0.2.msi", "url":"http://192.168.10.15:3000/msi", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" }, { "id":1, "name":"awesome-v0.2.dmg", "url":"http://192.168.10.15:3000", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ] @@ -55,6 +60,13 @@ Example response: ## Get a release link +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> + +> The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. + +<!--- end_remove --> + Get an asset as a link from a release. ```plaintext @@ -80,13 +92,19 @@ Example response: "id":1, "name":"awesome-v0.2.dmg", "url":"http://192.168.10.15:3000", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ``` ## Create a release link +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> + +> The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. + +<!--- end_remove --> + Creates an asset as a link from a release. ```plaintext @@ -122,13 +140,19 @@ Example response: "name":"hellodarwin-amd64", "url":"https://gitlab.example.com/mynamespace/hello/-/jobs/688/artifacts/raw/bin/hello-darwin-amd64", "direct_asset_url":"https://gitlab.example.com/mynamespace/hello/-/releases/v1.7.0/downloads/bin/hellodarwin-amd64", - "external":false, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ``` ## Update a release link +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> + +> The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. + +<!--- end_remove --> + Updates an asset as a link from a release. ```plaintext @@ -164,13 +188,19 @@ Example response: "id":1, "name":"new name", "url":"http://192.168.10.15:3000", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"runbook" } ``` ## Delete a release link +<!--- start_remove The following content will be removed on remove_date: '2023-08-22' --> + +> The `external` field in Release Links was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/388975) in GitLab 15.9 +and [removed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/112490) in 16.0. + +<!--- end_remove --> + Deletes an asset as a link from a release. ```plaintext @@ -196,7 +226,6 @@ Example response: "id":1, "name":"new name", "url":"http://192.168.10.15:3000", - "external":true, // deprecated in GitLab 15.9, will be removed in GitLab 16.0. "link_type":"other" } ``` |