MaaS API Documentation Response and Example should be added to every call

Bug #1851712 reported by Greg Elkinbard
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
Expired
Undecided
Unassigned

Bug Description

Currently MaaS API includes a good description of the request, however response is not documented and example response would be very useful for somebody developing against the API.

Please refer to following for a good example https://docs.openstack.org/api-ref/compute/?expanded=list-servers-detail

Revision history for this message
Greg Elkinbard (gelkinbard1) wrote :

Documentation feedback from the customer evaluating MaaS for purchase. Purchasing decision will be made based on customer ability to use the APIs

Changed in maas:
status: New → Confirmed
Revision history for this message
Blake Rouse (blake-rouse) wrote :

I checked the current MAAS API documentation and the whole first section has parameters, response codes, and response bodies.

Please say the exact API calls that do not have the required documentation. Because looking at the documentation at the moment shows all the documentation examples.

https://git.launchpad.net/maas/tree/src/maasserver/api/examples

Changed in maas:
status: Confirmed → Incomplete
Revision history for this message
Launchpad Janitor (janitor) wrote :

[Expired for MAAS because there has been no activity for 60 days.]

Changed in maas:
status: Incomplete → Expired
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.