Comment 0 for bug 1189742

Revision history for this message
Raphaƫl Badin (rvb) wrote :

This is the documentation for the 'get-config' operation from the CLI: http://paste.ubuntu.com/5741796/. A correct invocation would be of the form: "./bin/maascli mymaas maas get-config name=cloud_images_archive". The documentation description of the arguments of the command are really not clear:
it mentions "positional arguments: data" and also the fact that the expected parameter is called 'name' but it's still not very clear how to use the command.

A first step would be to better explain, in plain English, how the list of arguments should be constructed from the list of available parameters (extracted from the API's docstrings). A second step (probably more involved) would parse the docstring, extract the argument names from it, and generate a proper documentation string for the CLI command.

Side node: This is somewhat related to bug 954655 but here, I'm talking about the doc that the CLI itself splits out.