From 7d6dea06f1036d2abef93eed057dc5119d8fcab1 Mon Sep 17 00:00:00 2001 From: Ruby Loo Date: Mon, 27 Oct 2014 16:20:50 +0000 Subject: [PATCH] Put nodes-related API in same section 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 --- doc/source/webapi/v1.rst | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/doc/source/webapi/v1.rst b/doc/source/webapi/v1.rst index 2382f2efae..0a03b32258 100644 --- a/doc/source/webapi/v1.rst +++ b/doc/source/webapi/v1.rst @@ -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 - -