Commit 7578529c authored by Dmitriy Zaporozhets's avatar Dmitriy Zaporozhets

Improve packages API documentation based on review

Signed-off-by: default avatarDmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com>
parent 063bd189
...@@ -48,6 +48,7 @@ The following API resources are available: ...@@ -48,6 +48,7 @@ The following API resources are available:
- [Namespaces](namespaces.md) - [Namespaces](namespaces.md)
- [Notes](notes.md) (comments) - [Notes](notes.md) (comments)
- [Notification settings](notification_settings.md) - [Notification settings](notification_settings.md)
- [Packages](packages.md) **[PREMIUM]**
- [Pages domains](pages_domains.md) - [Pages domains](pages_domains.md)
- [Pipelines](pipelines.md) - [Pipelines](pipelines.md)
- [Pipeline schedules](pipeline_schedules.md) - [Pipeline schedules](pipeline_schedules.md)
...@@ -65,7 +66,6 @@ The following API resources are available: ...@@ -65,7 +66,6 @@ The following API resources are available:
- [Project templates](project_templates.md) (see also [Templates API Resources](#templates-api-resources)) - [Project templates](project_templates.md) (see also [Templates API Resources](#templates-api-resources))
- [Protected branches](protected_branches.md) - [Protected branches](protected_branches.md)
- [Protected tags](protected_tags.md) - [Protected tags](protected_tags.md)
- [Packages](packages.md) **[PREMIUM]**
- [Repositories](repositories.md) - [Repositories](repositories.md)
- [Repository files](repository_files.md) - [Repository files](repository_files.md)
- [Repository submodules](repository_submodules.md) - [Repository submodules](repository_submodules.md)
......
# Packages API # Packages API **[PREMIUM]**
This is the API docs of [GitLab Packages](../administration/packages.md).
## List project packages ## List project packages
> [Introduced][ee-9259] in GitLab 11.8. > [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9259) in GitLab 11.8.
Get a list of project packages. Both Maven and NPM packages are included in results. 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. When accessed without authentication, only packages of public projects are returned.
...@@ -13,7 +15,7 @@ GET /projects/:id/packages ...@@ -13,7 +15,7 @@ GET /projects/:id/packages
| Attribute | Type | Required | Description | | 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 | | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user. |
```bash ```bash
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/packages curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/:id/packages
...@@ -38,12 +40,4 @@ Example response: ...@@ -38,12 +40,4 @@ Example response:
] ]
``` ```
By default, `GET` request return 20 results at a time because the API results By default, the `GET` request will return 20 results, since the API is [paginated](README.md#pagination).
are paginated.
Read more on [pagination](README.md#pagination).
This API is for listing project packages. For how to upload or install
Maven or NPM packages please visit [Packages](../administration/packages.md) documentation.
[ee-9259]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/9259
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment