[doc, api] MAAS' documentation doesn't describe the objects returned by the API.

Bug #1242900 reported by Raphaël Badin
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Fix Released
High
Spencer Seidel

Bug Description

For instance, the documentation for "GET /api/1.0/tags/{name}/ op=nodes" says "Get the list of nodes" but it doesn't really say what a node is. More generally, the actions are described but not the returned objects.

Tags: doc track
Changed in maas:
importance: High → Wishlist
milestone: none → 2.1.0
Changed in maas:
milestone: 2.1.0 → 2.1.1
Changed in maas:
milestone: 2.1.1 → 2.1.2
Changed in maas:
milestone: 2.1.2 → 2.1.3
Changed in maas:
milestone: 2.1.3 → 2.2.0
Changed in maas:
milestone: 2.2.0 → 2.2.x
Changed in maas:
milestone: 2.2.x → none
milestone: none → next
summary: - MAAS' documentation doesn't describe the objects returned by the API.
+ [doc, api] MAAS' documentation doesn't describe the objects returned by
+ the API.
Christian Reis (kiko)
description: updated
Changed in maas:
importance: Wishlist → High
Changed in maas:
milestone: next → 2.5.0
Changed in maas:
assignee: nobody → Spencer Seidel (jsseidel)
tags: added: track
Changed in maas:
status: Triaged → In Progress
Changed in maas:
milestone: 2.5.0 → 2.5.x
Changed in maas:
status: In Progress → 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.