cache: emit list of supported GitHub v3 API resource paths #72
Labels
priority: 2 (soon)
severity: 7 (wishlist)
status:acknowledged
type:feature
Adds a new capability or behavioral property
This issue applies to the
ads-github-cache
program as shipped withads-github-tools-0.3.3
.The
ads-github-cache
program supports many invocations that accept one or moreURL_OR_PATH
parameters:As documented in
ads-github-cache(1)
, two equivalent examples of using such parameters are:$ ads-github-cache --get '/user/repos'
and:
$ ads-github-cache --get 'https://api.github.com/user/repos
Both of the above forms require that the user be familiar not only with the "resource path" strucutre of the GitHub v3 API, but also know which particular resource paths are supported by the
ads-github-cache
program. While the list of supported paths are documented inads-github-cache(1)
, it would be handy (for ad hoc command line usage) if there were a way to get the tool to emit the list of supported resource paths. Maybe something like:$ ads-github-cache --list-resource-paths
or maybe:
$ ads-github-cache --list-gh-api-resource-paths
Such a feature would make it easier for the user to map a rough idea of the data wanted (e.g., "my repo names") with the specific resource path construction necessary to obtain the data ("/user/repos").
The text was updated successfully, but these errors were encountered: