You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: doc/api/packages.md
+25-39
Original file line number
Diff line number
Diff line change
@@ -8,11 +8,11 @@ info: To determine the technical writer assigned to the Stage/Group associated w
8
8
9
9
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349418) support for [GitLab CI/CD job token](../ci/jobs/ci_job_token.md) authentication for the project-level API in GitLab 15.3.
10
10
11
-
This is the API documentation of [GitLab Packages](../administration/packages/index.md).
11
+
The API documentation of [GitLab Packages](../administration/packages/index.md).
12
12
13
13
## List packages
14
14
15
-
### Within a project
15
+
### For a project
16
16
17
17
Get a list of project packages. All package types are included in results. When
18
18
accessed without authentication, only packages of public projects are returned.
@@ -23,16 +23,16 @@ packages.
23
23
GET /projects/:id/packages
24
24
```
25
25
26
-
| Attribute | Type | Required | Description |
27
-
|---------|----|--------|-----------|
28
-
|`id`| integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding)|
29
-
|`order_by`| string | no | The field to use as order. One of `created_at` (default), `name`, `version`, or `type`. |
30
-
|`sort`| string | no | The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. |
31
-
| `package_type` | string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, `helm`, `terraform_module`, or `golang`. (_Introduced in GitLab 12.9_)
32
-
| `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_Introduced in GitLab 12.9_)
33
-
| `package_version` | string | no | Filter the project packages by version. (_[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349065) in GitLab 16.6_)
34
-
| `include_versionless` | boolean | no | When set to true, versionless packages are included in the response. (_Introduced in GitLab 13.8_)
35
-
| `status` | string | no | Filter the returned packages by status. One of `default` (default), `hidden`, `processing`, `error`, or `pending_destruction`. (_Introduced in GitLab 13.9_)
|`id`| integer/string | yes | ID or [URL-encoded path of the project](rest/index.md#namespaced-path-encoding).|
29
+
|`order_by`| string | no| The field to use as order. One of `created_at` (default), `name`, `version`, or `type`. |
30
+
|`sort`| string | no| The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. |
31
+
|`package_type`| string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, `helm`, `terraform_module`, or `golang`. |
32
+
|`package_name`| string | no | Filter the project packages with a fuzzy search by name. |
33
+
|`package_version`| string | no | Filter the project packages by version. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349065) in GitLab 16.6. |
34
+
|`include_versionless`| boolean | no | When set to true, versionless packages are included in the response. |
35
+
|`status`| string | no | Filter the returned packages by status. One of `default` (default), `hidden`, `processing`, `error`, or `pending_destruction`. |
@@ -77,9 +77,7 @@ By default, the `GET` request returns 20 results, because the API is [paginated]
77
77
Although you can filter packages by status, working with packages that have a `processing` status
78
78
can result in malformed data or broken packages.
79
79
80
-
### Within a group
81
-
82
-
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18871) in GitLab 12.5.
80
+
### For a group
83
81
84
82
Get a list of project packages at the group level.
85
83
When accessed without authentication, only packages of public projects are returned.
@@ -90,27 +88,22 @@ packages.
90
88
GET /groups/:id/packages
91
89
```
92
90
93
-
| Attribute | Type | Required | Description |
94
-
|---------|----|--------|-----------|
95
-
|`id`| integer/string | yes | ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). |
96
-
|`exclude_subgroups`| boolean | false | If the parameter is included as true, packages from projects from subgroups are not listed. Default is `false`. |
97
-
|`order_by`| string | no | The field to use as order. One of `created_at` (default), `name`, `version`, `type`, or `project_path`. |
98
-
|`sort`| string | no | The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. |
99
-
|`package_type`| string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, `helm`, or `golang`. (_Introduced in GitLab 12.9_)|
100
-
| `package_name` | string | no | Filter the project packages with a fuzzy search by name. (_[Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/30980) in GitLab 13.0_)
101
-
| `package_version` | string | no | Filter the returned packages by version. (_[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349065) in GitLab 16.6_)
102
-
| `include_versionless` | boolean | no | When set to true, versionless packages are included in the response. (_Introduced in GitLab 13.8_)
103
-
| `status` | string | no | Filter the returned packages by status. One of `default` (default), `hidden`, `processing`, `error`, or `pending_destruction`. (_Introduced in GitLab 13.9_)
|`id`| integer/string | yes| ID or [URL-encoded path of the group](rest/index.md#namespaced-path-encoding). |
94
+
|`exclude_subgroups`| boolean | false| If the parameter is included as true, packages from projects from subgroups are not listed. Default is `false`. |
95
+
|`order_by`| string | no| The field to use as order. One of `created_at` (default), `name`, `version`, `type`, or `project_path`. |
96
+
|`sort`| string | no| The direction of the order, either `asc` (default) for ascending order or `desc` for descending order. |
97
+
|`package_type`| string | no | Filter the returned packages by type. One of `conan`, `maven`, `npm`, `pypi`, `composer`, `nuget`, `helm`, or `golang`. |
98
+
|`package_name`| string | no | Filter the project packages with a fuzzy search by name. |
99
+
|`package_version`| string | no | Filter the returned packages by version. [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/349065) in GitLab 16.6. |
100
+
|`include_versionless`| boolean | no | When set to true, versionless packages are included in the response. |
101
+
|`status`| string | no | Filter the returned packages by status. One of `default` (default), `hidden`, `processing`, `error`, or `pending_destruction`. |
> The `pipeline` attribute in the response is deprecated in favor of `pipelines`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44348) in GitLab 13.6. Both are available until 13.7.
112
-
> The `build_info` attribute in the response is deprecated in favor of `pipeline`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040) in GitLab 12.10.
113
-
114
107
Example response:
115
108
116
109
```json
@@ -197,11 +190,6 @@ GET /projects/:id/packages/:package_id
> The `pipeline` attribute in the response is deprecated in favor of `pipelines`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44348) in GitLab 13.6. Both are available until 13.7.
203
-
> The `build_info` attribute in the response is deprecated in favor of `pipeline`, which was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28040) in GitLab 12.10.
Copy file name to clipboardExpand all lines: doc/user/storage_management_automation.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -780,7 +780,7 @@ default:
780
780
781
781
## Manage Container Registries storage
782
782
783
-
Container registries are available [in a project](../api/container_registry.md#within-a-project) or [in a group](../api/container_registry.md#within-a-group). You can analyze both locations to implement a cleanup strategy.
783
+
Container registries are available [for projects](../api/container_registry.md#within-a-project) or [for groups](../api/container_registry.md#within-a-group). You can analyze both locations to implement a cleanup strategy.
784
784
785
785
### List container registries
786
786
@@ -894,7 +894,7 @@ You can optimize container images to reduce the image size and overall storage c
894
894
895
895
## Manage Package Registry storage
896
896
897
-
Package registries are available [in a project](../api/packages.md#within-a-project) or [in a group](../api/packages.md#within-a-group).
897
+
Package registries are available [for projects](../api/packages.md#for-a-project) or [for groups](../api/packages.md#for-a-group).
0 commit comments