Add API documentation for package manager endpoints.
Proposal
The routes/endpoints defined for package managers (Maven, NPM, etc) are in the public GitLab API however they are not documented. We should document the individual endpoints.
Further details / Reasoning
Package manager clients interact with the GitLab package registry by making API requests. So, for example, when you run npm install
, a GET request is made to a route defined in the npm_packages.rb
API file. While it is expected that most users will interact with these endpoints using the package manager clients, they are all public, so there is no reason to hide them from the documentation if a user could manually make requests to each of them anyways. This could benefit some users that want to manually call some of these endpoints in custom scripts. It also benefits developers working on GitLab in that the endpoints are better documented and less time needs to be spent understanding what each route does and why.
Who can address the issue
A ~"group::package" engineer will likely be the best individual to create the initial docs.
List of Docs to be created
-
Conan -
NPM -
Maven -
NuGet -
Composer -
PyPI -
GoProxy - [-] Generic (N/A because the generic package registry is already documented as an API)
- [-] Debian (still in development)
-
RubyGems