summaryrefslogtreecommitdiff
path: root/doc/api/packages
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api/packages')
-rw-r--r--doc/api/packages/composer.md15
-rw-r--r--doc/api/packages/conan.md2
-rw-r--r--doc/api/packages/go_proxy.md2
-rw-r--r--doc/api/packages/helm.md10
-rw-r--r--doc/api/packages/maven.md2
-rw-r--r--doc/api/packages/npm.md12
-rw-r--r--doc/api/packages/nuget.md4
-rw-r--r--doc/api/packages/pypi.md10
-rw-r--r--doc/api/packages/rubygems.md2
9 files changed, 31 insertions, 28 deletions
diff --git a/doc/api/packages/composer.md b/doc/api/packages/composer.md
index 4f8e0a23c9c..b3a27519729 100644
--- a/doc/api/packages/composer.md
+++ b/doc/api/packages/composer.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Composer API
+# Composer API **(FREE)**
This is the API documentation for [Composer Packages](../../user/packages/composer_repository/index.md).
@@ -108,13 +108,14 @@ V1.
GET group/:id/-/packages/composer/:package_name$:sha
```
-Note the `$` symbol in the URL. When making requests, you may need to use the URL-encoded version of
-the symbol `%24` (see example below).
+Note the `$` symbol in the URL. When making requests, you may need the
+URL-encoded version of the symbol `%24`. Refer to the example after
+the table:
-| Attribute | Type | Required | Description |
-| -------------- | ------ | -------- | ----------- |
-| `id` | string | yes | The ID or full path of the group. |
-| `package_name` | string | yes | The name of the package. |
+| Attribute | Type | Required | Description |
+|----------------|--------|----------|---------------------------------------------------------------------------------------|
+| `id` | string | yes | The ID or full path of the group. |
+| `package_name` | string | yes | The name of the package. |
| `sha` | string | yes | The SHA digest of the package, provided by the [V1 packages list](#v1-packages-list). |
```shell
diff --git a/doc/api/packages/conan.md b/doc/api/packages/conan.md
index 88ed2524173..f5d08ed7ef8 100644
--- a/doc/api/packages/conan.md
+++ b/doc/api/packages/conan.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Conan API
+# Conan API **(FREE)**
This is the API documentation for [Conan Packages](../../user/packages/conan_repository/index.md).
diff --git a/doc/api/packages/go_proxy.md b/doc/api/packages/go_proxy.md
index 2f81435db42..ffafc387951 100644
--- a/doc/api/packages/go_proxy.md
+++ b/doc/api/packages/go_proxy.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Go Proxy API
+# Go Proxy API **(FREE SELF)**
This is the API documentation for [Go Packages](../../user/packages/go_proxy/index.md).
This API is behind a feature flag that is disabled by default. GitLab administrators with access to
diff --git a/doc/api/packages/helm.md b/doc/api/packages/helm.md
index f1d5f24cd99..8c3b9869368 100644
--- a/doc/api/packages/helm.md
+++ b/doc/api/packages/helm.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Helm API
+# Helm API **(FREE)**
This is the API documentation for [Helm](../../user/packages/helm_repository/index.md).
@@ -38,14 +38,14 @@ GET projects/:id/packages/helm/:channel/index.yaml
```shell
curl --user <username>:<personal_access_token> \
- https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml
+ "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml"
```
Write the output to a file:
```shell
curl --user <username>:<personal_access_token> \
- https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml \
+ "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/index.yaml" \
--remote-name
```
@@ -67,7 +67,7 @@ GET projects/:id/packages/helm/:channel/charts/:file_name.tgz
```shell
curl --user <username>:<personal_access_token> \
- https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/charts/mychart.tgz \
+ "https://gitlab.example.com/api/v4/projects/1/packages/helm/stable/charts/mychart.tgz" \
--remote-name
```
@@ -91,5 +91,5 @@ POST projects/:id/packages/helm/api/:channel/charts
curl --request POST \
--form 'chart=@mychart.tgz' \
--user <username>:<personal_access_token> \
- https://gitlab.example.com/api/v4/projects/1/packages/helm/api/stable/charts
+ "https://gitlab.example.com/api/v4/projects/1/packages/helm/api/stable/charts"
```
diff --git a/doc/api/packages/maven.md b/doc/api/packages/maven.md
index d03c9be3060..b4b3d579ffb 100644
--- a/doc/api/packages/maven.md
+++ b/doc/api/packages/maven.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Maven API
+# Maven API **(FREE)**
This is the API documentation for [Maven Packages](../../user/packages/maven_repository/index.md).
diff --git a/doc/api/packages/npm.md b/doc/api/packages/npm.md
index 3992a042915..24ac1a640c9 100644
--- a/doc/api/packages/npm.md
+++ b/doc/api/packages/npm.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.example/handbook/engineering/ux/technical-writing/#assignments
---
-# npm API
+# npm API **(FREE)**
This is the API documentation for [npm Packages](../../user/packages/npm_registry/index.md).
@@ -58,11 +58,11 @@ Upload a package.
PUT projects/:id/packages/npm/:package_name
```
-| Attribute | Type | Required | Description |
-| ----------------- | ------ | -------- | ----------- |
-| `id` | string | yes | The ID or full path of the project. |
-| `package_name` | string | yes | The name of the package. |
-| `versions` | string | yes | Package version info. |
+| Attribute | Type | Required | Description |
+|----------------|--------|----------|-------------------------------------|
+| `id` | string | yes | The ID or full path of the project. |
+| `package_name` | string | yes | The name of the package. |
+| `versions` | string | yes | Package version information. |
```shell
curl --request PUT
diff --git a/doc/api/packages/nuget.md b/doc/api/packages/nuget.md
index d19e2dfa65b..aee3a4fe542 100644
--- a/doc/api/packages/nuget.md
+++ b/doc/api/packages/nuget.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about..example/handbook/engineering/ux/technical-writing/#assignments
---
-# NuGet API
+# NuGet API **(FREE)**
This is the API documentation for [NuGet Packages](../../user/packages/nuget_repository/index.md).
@@ -73,7 +73,7 @@ curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v
Write the output to a file:
```shell
-curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/mynugetpkg.1.3.0.17.nupkg" >> MyNuGetPkg.1.3.0.17.nupkg
+curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/nuget/download/MyNuGetPkg/1.3.0.17/mynugetpkg.1.3.0.17.nupkg" > MyNuGetPkg.1.3.0.17.nupkg
```
This writes the downloaded file to `MyNuGetPkg.1.3.0.17.nupkg` in the current directory.
diff --git a/doc/api/packages/pypi.md b/doc/api/packages/pypi.md
index dd301e9fab8..a1c96d03297 100644
--- a/doc/api/packages/pypi.md
+++ b/doc/api/packages/pypi.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# PyPI API
+# PyPI API **(FREE)**
This is the API documentation for [PyPI Packages](../../user/packages/pypi_repository/index.md).
@@ -47,7 +47,8 @@ To write the output to a file:
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/groups/1/packages/pypi/files/5y57017232013c8ac80647f4ca153k3726f6cba62d055cd747844ed95b3c65ff/my.pypi.package-0.0.1.tar.gz" >> my.pypi.package-0.0.1.tar.gz
```
-This writes the downloaded file to `my.pypi.package-0.0.1.tar.gz` in the current directory.
+This writes the downloaded file to `my.pypi.package-0.0.1.tar.gz` in the current
+directory.
## Group level simple API entry point
@@ -106,7 +107,7 @@ GET projects/:id/packages/pypi/files/:sha256/:file_identifier
| --------- | ---- | -------- | ----------- |
| `id` | string | yes | The ID or full path of the project. |
| `sha256` | string | yes | PyPI package file sha256 check sum. |
-| `file_identifier` | string | yes | The PyPI package file name. |
+| `file_identifier` | string | yes | The PyPI package filename. |
```shell
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/pypi/files/5y57017232013c8ac80647f4ca153k3726f6cba62d055cd747844ed95b3c65ff/my.pypi.package-0.0.1.tar.gz"
@@ -118,7 +119,8 @@ To write the output to a file:
curl --user <username>:<personal_access_token> "https://gitlab.example.com/api/v4/projects/1/packages/pypi/files/5y57017232013c8ac80647f4ca153k3726f6cba62d055cd747844ed95b3c65ff/my.pypi.package-0.0.1.tar.gz" >> my.pypi.package-0.0.1.tar.gz
```
-This writes the downloaded file to `my.pypi.package-0.0.1.tar.gz` in the current directory.
+This writes the downloaded file to `my.pypi.package-0.0.1.tar.gz` in the current
+directory.
## Project-level simple API entry point
diff --git a/doc/api/packages/rubygems.md b/doc/api/packages/rubygems.md
index 426548d5ed2..10dcaafda42 100644
--- a/doc/api/packages/rubygems.md
+++ b/doc/api/packages/rubygems.md
@@ -4,7 +4,7 @@ group: Package
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---
-# Ruby gems API
+# Ruby gems API **(FREE SELF)**
This is the API documentation for [Ruby gems](../../user/packages/rubygems_registry/index.md).
View Lorry Controller Status