Add CLI command details to package API docs
Problem to solve
In #323775 (closed) we added sections to each package manager doc communicating which CLI commands we support for each package manager. In #219419 we added API documentation for the specific endpoints that the package manager clients communicate with.
The problem is, for any given CLI command, we do not document which API requests are being made. For example, when a user type in
conan install, it makes requests to
/ping, recipe download urls, package download urls, recipe snapshot, package snapshot, then individually downloads each file. These request flows are not always obvious, and this information can be extremely helpful for future developers, or for anyone trying to troubleshoot problems.
We should add sections to each API document with details on how various commands make requests. If there already are docs for this in any of the package manager documentation, we can link directly to those.
- Go Proxy
- [-] Generic (n/a because generic packages are a curl API, there is no client)
- [-] Debian (currently in development)
Who can address the issue
Anyone in the package group or with expertise in the package registry.
Inspired by #323775 (comment 542275782)