diff options
Diffstat (limited to 'doc/api/packages')
-rw-r--r-- | doc/api/packages/conan.md | 2 | ||||
-rw-r--r-- | doc/api/packages/debian.md | 67 | ||||
-rw-r--r-- | doc/api/packages/terraform-modules.md | 6 |
3 files changed, 67 insertions, 8 deletions
diff --git a/doc/api/packages/conan.md b/doc/api/packages/conan.md index 3ac2eeb40b1..637c3d27d75 100644 --- a/doc/api/packages/conan.md +++ b/doc/api/packages/conan.md @@ -38,7 +38,7 @@ The examples in this document all use the instance-level prefix. /packages/conan/v1 ``` -When using the instance-level routes, be aware that there is a +When using the instance-level routes, be aware that there is a [naming restriction](../../user/packages/conan_repository/index.md#package-recipe-naming-convention-for-instance-remotes) for Conan recipes. diff --git a/doc/api/packages/debian.md b/doc/api/packages/debian.md index 4abb7bc7112..598124ba2b9 100644 --- a/doc/api/packages/debian.md +++ b/doc/api/packages/debian.md @@ -212,11 +212,11 @@ curl --header "Private-Token: <personal_access_token>" \ This writes the downloaded file using the remote filename in the current directory. -## Download a binary file's index +## Download a packages index > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/64923) in GitLab 14.2. -Download a distribution index. +Download a packages index. ```plaintext GET <route-prefix>/dists/*distribution/:component/binary-:architecture/Packages @@ -229,14 +229,73 @@ GET <route-prefix>/dists/*distribution/:component/binary-:architecture/Packages | `architecture` | string | yes | The distribution architecture type. | ```shell -curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/amd64/Packages" +curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/binary-amd64/Packages" ``` Write the output to a file: ```shell curl --header "Private-Token: <personal_access_token>" \ - "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/amd64/Packages" \ + "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/binary-amd64/Packages" \ + --remote-name +``` + +This writes the downloaded file using the remote filename in the current directory. + +## Download a Debian Installer packages index + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71918) in GitLab 15.4. + +Download a Debian Installer packages index. + +```plaintext +GET <route-prefix>/dists/*distribution/:component/debian-installer/binary-:architecture/Packages +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `distribution` | string | yes | The codename or suite of the Debian distribution. | +| `component` | string | yes | The distribution component name. | +| `architecture` | string | yes | The distribution architecture type. | + +```shell +curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/debian-installer/binary-amd64/Packages" +``` + +Write the output to a file: + +```shell +curl --header "Private-Token: <personal_access_token>" \ + "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/debian-installer/binary-amd64/Packages" \ + --remote-name +``` + +This writes the downloaded file using the remote filename in the current directory. + +## Download a source packages index + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/71918) in GitLab 15.4. + +Download a source packages index. + +```plaintext +GET <route-prefix>/dists/*distribution/:component/source/Sources +``` + +| Attribute | Type | Required | Description | +| ----------------- | ------ | -------- | ----------- | +| `distribution` | string | yes | The codename or suite of the Debian distribution. | +| `component` | string | yes | The distribution component name. | + +```shell +curl --header "Private-Token: <personal_access_token>" "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/source/Sources" +``` + +Write the output to a file: + +```shell +curl --header "Private-Token: <personal_access_token>" \ + "https://gitlab.example.com/api/v4/projects/1/packages/debian/dists/my-distro/main/source/Sources" \ --remote-name ``` diff --git a/doc/api/packages/terraform-modules.md b/doc/api/packages/terraform-modules.md index 24db7094a3c..daafe0579e7 100644 --- a/doc/api/packages/terraform-modules.md +++ b/doc/api/packages/terraform-modules.md @@ -12,8 +12,8 @@ WARNING: This API is used by the [terraform cli](https://www.terraform.io/) and is generally not meant for manual consumption. -For instructions on how to upload and install Maven packages from the GitLab -package registry, see the [Terraform modules registry documentation](../../user/packages/terraform_module_registry/index.md). +For instructions on how to upload and install Terraform modules from the GitLab +infrastructure registry, see the [Terraform modules registry documentation](../../user/packages/terraform_module_registry/index.md). ## List available versions for a specific module @@ -114,7 +114,7 @@ Example response: ## Get specific version for a specific module -Get information about the latest version for a given module. +Get information about a specific version for a given module. ```plaintext GET packages/terraform/modules/v1/:module_namespace/:module_name/:module_system/1.0.0 |