7d6dea06f1
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
86 lines
2.0 KiB
ReStructuredText
86 lines
2.0 KiB
ReStructuredText
=====================
|
|
RESTful Web API (v1)
|
|
=====================
|
|
|
|
Chassis
|
|
=======
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.chassis:ChassisController
|
|
:webprefix: /v1/chassis
|
|
|
|
.. autotype:: ironic.api.controllers.v1.chassis.ChassisCollection
|
|
:members:
|
|
|
|
.. autotype:: ironic.api.controllers.v1.chassis.Chassis
|
|
:members:
|
|
|
|
|
|
Drivers
|
|
=======
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.driver:DriversController
|
|
:webprefix: /v1/drivers
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.driver:DriverPassthruController
|
|
:webprefix: /v1/drivers/(driver_name)/vendor_passthru
|
|
|
|
.. autotype:: ironic.api.controllers.v1.driver.DriverList
|
|
:members:
|
|
|
|
.. autotype:: ironic.api.controllers.v1.driver.Driver
|
|
:members:
|
|
|
|
|
|
Links
|
|
=====
|
|
|
|
.. autotype:: ironic.api.controllers.link.Link
|
|
:members:
|
|
|
|
|
|
Nodes
|
|
=====
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.node:NodesController
|
|
:webprefix: /v1/nodes
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.node:NodeMaintenanceController
|
|
:webprefix: /v1/nodes/(node_uuid)/maintenance
|
|
|
|
.. 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
|
|
|
|
.. 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:
|
|
|
|
|
|
Ports
|
|
=====
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.port:PortsController
|
|
:webprefix: /v1/ports
|
|
|
|
.. autotype:: ironic.api.controllers.v1.port.PortCollection
|
|
:members:
|
|
|
|
.. autotype:: ironic.api.controllers.v1.port.Port
|
|
:members:
|