openstack/ironic
Code Issues Proposed changes

Put nodes-related API in same section

Browse Source 
The documentation for our web API (v1) has the nodes-related API
in three different sections: Nodes, NodeStates, and BootDevice.
This makes it difficult to find all the available nodes-related
API.

This puts all the nodes-related API in the same Nodes section,
removing the NodeStates and BootDevice sections.

The ConsoleInfo class/type is included in the documentation as well.

Change-Id: I3bdcb2df13861d3a098b1880062b8115855c28b6
Closes-Bug: #1386291
This commit is contained in:
Ruby Loo 2014-10-27 16:20:50 +00:00
parent 9cee24e257
commit 7d6dea06f1
1 changed files with 14 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
doc/source/webapi/v1.rst
View File

@ -47,18 +47,8 @@ Nodes
.. rest-controller:: ironic.api.controllers.v1.node:NodeMaintenanceController
:webprefix: /v1/nodes/(node_uuid)/maintenance
.. rest-controller:: ironic.api.controllers.v1.node:NodeVendorPassthruController
:webprefix: /v1/nodes/(node_uuid)/vendor_passthru
.. autotype:: ironic.api.controllers.v1.node.NodeCollection
:members:
.. autotype:: ironic.api.controllers.v1.node.Node
:members:
NodeStates
==========
.. rest-controller:: ironic.api.controllers.v1.node:BootDeviceController
:webprefix: /v1/nodes/(node_uuid)/management/boot_device
.. rest-controller:: ironic.api.controllers.v1.node:NodeStatesController
:webprefix: /v1/nodes/(node_uuid)/states
@ -66,6 +56,18 @@ NodeStates
.. rest-controller:: ironic.api.controllers.v1.node:NodeConsoleController
:webprefix: /v1/nodes/(node_uuid)/states/console
.. rest-controller:: ironic.api.controllers.v1.node:NodeVendorPassthruController
:webprefix: /v1/nodes/(node_uuid)/vendor_passthru
.. autotype:: ironic.api.controllers.v1.node.ConsoleInfo
:members:
.. autotype:: ironic.api.controllers.v1.node.Node
:members:
.. autotype:: ironic.api.controllers.v1.node.NodeCollection
:members:
.. autotype:: ironic.api.controllers.v1.node.NodeStates
:members:
@ -81,12 +83,3 @@ Ports
.. autotype:: ironic.api.controllers.v1.port.Port
:members:
BootDevice
==========
.. rest-controller:: ironic.api.controllers.v1.node:BootDeviceController
:webprefix: /v1/nodes/(node_uuid)/management/boot_device