ironic/api-ref/source
Sam Betts 233d7d5727 Add detail=[True, False] query string to API list endpoints
We currently support /[nodes, ports, portgroups, chassis]/detail as an
API endpoint for getting a detailed list of each object. This does not
fit the RESTful and resourceful API design principles of <resource
type>/<resource id> and makes it hard to consume the API from frameworks
that expect that structure. We can't remove the old endpoint, so that is
safeguarded by the restricted node names list. This patch adds a
?detail=[True, False] query string to the list API endpoints to allow
those consuming the API to use the expected URL form.

Change-Id: I694919b4a4eaa3419318bbee1cde79de15e19afa
Story: #1662921
Task: #10176
2018-06-18 19:40:07 +00:00
..
samples fix a typo in driver-property-response.json: s/doman/domain/ 2018-02-26 06:58:44 +00:00
baremetal-api-v1-chassis.inc Add detail=[True, False] query string to API list endpoints 2018-06-18 19:40:07 +00:00
baremetal-api-v1-driver-passthru.inc Remove remaining vendor passthru lookup/heartbeat 2017-05-17 15:03:39 -04:00
baremetal-api-v1-drivers.inc Add api-ref and ironic state documentation for rescue 2018-01-31 04:08:07 -05:00
baremetal-api-v1-misc.inc [api-ref] clarify what /v1/lookup returns 2018-01-31 15:48:47 -05:00
baremetal-api-v1-node-management.inc Update and replace http with https for doc links 2018-04-04 22:14:26 +08:00
baremetal-api-v1-node-passthru.inc Update the api-ref documentation for Root and Nodes 2016-05-20 08:35:29 -07:00
baremetal-api-v1-nodes-portgroups.inc Switch API ref to use versionadded syntax throughout 2017-09-05 17:27:24 +01:00
baremetal-api-v1-nodes-ports.inc Switch API ref to use versionadded syntax throughout 2017-09-05 17:27:24 +01:00
baremetal-api-v1-nodes-traits.inc Add documentation for node traits 2018-01-30 15:50:55 +00:00
baremetal-api-v1-nodes-vifs.inc Make the api format correctly 2017-11-08 19:00:39 +08:00
baremetal-api-v1-nodes-volume.inc Switch API ref to use versionadded syntax throughout 2017-09-05 17:27:24 +01:00
baremetal-api-v1-nodes.inc Add detail=[True, False] query string to API list endpoints 2018-06-18 19:40:07 +00:00
baremetal-api-v1-portgroups-ports.inc Switch API ref to use versionadded syntax throughout 2017-09-05 17:27:24 +01:00
baremetal-api-v1-portgroups.inc Add detail=[True, False] query string to API list endpoints 2018-06-18 19:40:07 +00:00
baremetal-api-v1-ports.inc Add detail=[True, False] query string to API list endpoints 2018-06-18 19:40:07 +00:00
baremetal-api-v1-volume.inc Switch API ref to use versionadded syntax throughout 2017-09-05 17:27:24 +01:00
baremetal-api-versions.inc Switch API ref to use versionadded syntax throughout 2017-09-05 17:27:24 +01:00
conf.py Resolve pep8 E402 errors and no longer ignore E402 2018-04-10 17:34:04 -07:00
index.rst Add node traits to API reference 2018-01-25 01:36:54 +00:00
parameters.yaml Power fault recovery follow up 2018-06-06 13:20:55 +00:00