CLI commands documentation does not explain how to pass parameters

Bug #1189742 reported by Raphaël Badin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Fix Released
High
Jeroen T. Vermeulen

Bug Description

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 spits out.

Tags: api cli

Related branches

Changed in maas:
milestone: none → 13.10
importance: Low → High
tags: added: api cli
removed: cpi
Graham Binns (gmb)
Changed in maas:
assignee: nobody → Graham Binns (gmb)
Changed in maas:
milestone: 13.10 → 14.04
Raphaël Badin (rvb)
Changed in maas:
status: Triaged → In Progress
Graham Binns (gmb)
Changed in maas:
status: In Progress → Triaged
assignee: Graham Binns (gmb) → nobody
Changed in maas:
assignee: nobody → Jeroen T. Vermeulen (jtv)
status: Triaged → In Progress
Raphaël Badin (rvb)
description: updated
Changed in maas:
status: In Progress → Fix Committed
Changed in maas:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.