Update webapi doc with link and console
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
This commit is contained in:
parent
3cf57238b7
commit
ec78868ee0
@ -34,7 +34,7 @@ Drivers
|
||||
Links
|
||||
=====
|
||||
|
||||
.. autotype:: ironic.api.controllers.v1.link:Link
|
||||
.. autotype:: ironic.api.controllers.link.Link
|
||||
:members:
|
||||
|
||||
|
||||
@ -58,7 +58,10 @@ NodeStates
|
||||
==========
|
||||
|
||||
.. rest-controller:: ironic.api.controllers.v1.node:NodeStatesController
|
||||
:webprefix: /v1/nodes/<uuid>/states
|
||||
: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:
|
||||
|
@ -49,3 +49,10 @@ class Link(base.APIBase):
|
||||
href = build_url(resource, resource_args,
|
||||
bookmark=bookmark, base_url=url)
|
||||
return Link(href=href, rel=rel_name, type=type)
|
||||
|
||||
@classmethod
|
||||
def sample(cls):
|
||||
sample = cls(href="http://localhost:6385/chassis/"
|
||||
"eaaca217-e7d8-47b4-bb41-3f99f20eed89",
|
||||
rel="bookmark")
|
||||
return sample
|
||||
|
Loading…
x
Reference in New Issue
Block a user