ec78868ee0
http://docs.openstack.org/developer/ironic/webapi/v1.html is updated as follows: - changes the path descriptor of NodeStates to use '(node_uuid)' instead of '<uuid>' to be consistent with other paths - adds [GET/PUT] /v1/nodes/(node_uuid)/states/console to show how to access the node's console - fixes the "Links" section so that Link information is shown Change-Id: I9d4a32550b81bb5ccf2fa23d8b591d8a945c04cc
83 lines
1.7 KiB
ReStructuredText
83 lines
1.7 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: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:NodeStatesController
|
|
:webprefix: /v1/nodes/(node_uuid)/states
|
|
|
|
.. rest-controller:: ironic.api.controllers.v1.node:NodeConsoleController
|
|
:webprefix: /v1/nodes/(node_uuid)/states/console
|
|
|
|
.. 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:
|
|
|
|
|