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

Bug #1851712 reported by Greg Elkinbard on 2019-11-07

This bug report will be marked for expiration in 55 days if no further activity occurs. (find out why)

8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
MAAS
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

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
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
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers