Merge lp:~rvb/maas/add-power-params-doc into lp:~maas-committers/maas/trunk
Proposed by
Raphaël Badin
Status: | Merged |
---|---|
Approved by: | Raphaël Badin |
Approved revision: | no longer in the source branch. |
Merged at revision: | 2289 |
Proposed branch: | lp:~rvb/maas/add-power-params-doc |
Merge into: | lp:~maas-committers/maas/trunk |
Diff against target: |
183 lines (+86/-1) 4 files modified
src/maasserver/api.py (+9/-0) src/maasserver/apidoc.py (+46/-0) src/maasserver/tests/test_apidoc.py (+30/-0) src/provisioningserver/power_schema.py (+1/-1) |
To merge this branch: | bzr merge lp:~rvb/maas/add-power-params-doc |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Gavin Panella (community) | Approve | ||
Review via email: mp+216894@code.launchpad.net |
Commit message
Add documentation about the power types and the related power parameters.
Description of the change
Here is how it looks like: http://
The tests are minimal but testing the exact formatting would be a bit pointless I think. A test that the whole API doc can be translated from rST into HTML already exists.
To post a comment you must log in.
I don't think we should be documenting this like this, other than some
examples perhaps.
This is because clusters can and will have varying power types available
- it's not a heterogeneous environment, especially during staged cluster
upgrades.
What I think we should do is implement an API function that returns
available power types and each one's parameters based on the cluster and
encourage API users to derive from that when editing/adding nodes.