doc: https://docs.ubuntu.com/maas/2.1/en/api states "bond-mode" instead of bond_mode

Bug #1692554 reported by JuanJo Ciarlante
12
This bug affects 2 people
Affects Status Importance Assigned to Milestone
MAAS
Fix Released
High
Graham Morrison

Bug Description

$ curl -s https://docs.ubuntu.com/maas/2.1/en/api |egrep bond.mode
<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-0ubuntu1~16.04.1

NOTE also that maas maas-root interfaces create-bond
silently ignores being passed eg bond-mode=active-backup
(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).

JuanJo Ciarlante (jjo)
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
Revision history for this message
Andres Rodriguez (andreserl) wrote :

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 "-"

Changed in maas:
assignee: nobody → Peter Matulis (petermatulis)
importance: Undecided → High
status: New → Confirmed
importance: High → Critical
Revision history for this message
Paul Gear (paulgear) wrote :

Arguably, both should be supported by analogy with /etc/network/interfaces.

Changed in maas:
assignee: Peter Matulis (petermatulis) → Graham Morrison (morrisong)
tags: added: doc internal
Changed in maas:
importance: Critical → High
Revision history for this message
Graham Morrison (morrisong) wrote :

This has been fixed with recent updates to the API docs build process. See https://github.com/CanonicalLtd/maas-docs/issues/439.

Changed in maas:
status: Confirmed → Fix Committed
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.