doc: https://docs.ubuntu.com/maas/2.1/en/api states "bond-mode" instead of bond_mode
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
MAAS |
Fix Released
|
High
|
Graham Morrison |
Bug Description
$ curl -s https:/
<p><code>param bond-mode</code>
<p>Supported bonding modes (bond-mode):</p>
<p>Supported bonding modes (bond-mode): balance-rr - Transmit packets in
while it's actually:
$ maas maas-root interfaces create-bond --help |egrep bond.mode
:param bond_mode: The operating mode of the bond.
Supported bonding modes (bond-mode):
$ dpkg-query -W maas
maas 2.1.3+bzr5573-
NOTE also that maas maas-root interfaces create-bond
silently ignores being passed eg bond-mode=
(ie doesn't fail as it should).
NOTE also that this "small" difference has quite time
consuming implications, as fixing these interfaces
requires releasing deployed machines (after finding
out incorrect /e/n/i).
summary: |
- doc: https://docs.ubuntu.com/maas/2.1/en/api says "bond-mode" instead of - bond_mode + doc: https://docs.ubuntu.com/maas/2.1/en/api states "bond-mode" instead + of bond_mode |
description: | updated |
Changed in maas: | |
assignee: | Peter Matulis (petermatulis) → Graham Morrison (morrisong) |
tags: | added: doc internal |
Changed in maas: | |
importance: | Critical → High |
Changed in maas: | |
status: | Confirmed → Fix Committed |
status: | Fix Committed → Fix Released |
I've checked the code vs the api document, and the error is in the API document. Not the code. This means that whatever script is creating the documentation is not creating things correctly and replacing "_" with "-"