diff options
Diffstat (limited to 'doc/api/packages.md')
| -rw-r--r-- | doc/api/packages.md | 28 |
1 files changed, 25 insertions, 3 deletions
diff --git a/doc/api/packages.md b/doc/api/packages.md index bab3f91bc40..5b490b872da 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -72,19 +72,32 @@ Example response: "id": 1, "name": "com/mycompany/my-app", "version": "1.0-SNAPSHOT", - "package_type": "maven" + "package_type": "maven", + "_links": { + "web_path": "/namespace1/project1/-/packages/1", + "delete_api_path": "/namespace1/project1/-/packages/1" + } }, { "id": 2, "name": "@foo/bar", "version": "1.0.3", - "package_type": "npm" + "package_type": "npm", + "_links": { + "web_path": "/namespace1/project1/-/packages/1", + "delete_api_path": "/namespace1/project1/-/packages/1" + } } ] ``` By default, the `GET` request will return 20 results, since the API is [paginated](README.md#pagination). +The `_links` object contains the following properties: + +- `web_path`: The path which you can visit in GitLab and see the details of the package. +- `delete_api_path`: The API path to delete the package. Only available if the request user has permission to do so. + ## Get a project package > [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9667) in GitLab 11.9. @@ -111,10 +124,19 @@ Example response: "id": 1, "name": "com/mycompany/my-app", "version": "1.0-SNAPSHOT", - "package_type": "maven" + "package_type": "maven", + "_links": { + "web_path": "/namespace1/project1/-/packages/1", + "delete_api_path": "/namespace1/project1/-/packages/1" + } } ``` +The `_links` object contains the following properties: + +- `web_path`: The path which you can visit in GitLab and see the details of the package. +- `delete_api_path`: The API path to delete the package. Only available if the request user has permission to do so. + ## List package files > [Introduced](https://gitlab.com/gitlab-org/gitlab/merge_requests/9305) in GitLab 11.8. |