Ironic

API doc for /v1/nodes/xxx/state is wrong

Bug #1311285 reported by aeva black
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Low
Srinivasa Acharya
Ironic 2014.2 "juno"

Bug Description

http://docs.openstack.org/developer/ironic/webapi/v1.html#get--v1-nodes--uuid--state

Documentation says the URI is "/v1/nodes/UUID/state/" but this is incorrect. It is actually "/v1/nodes/UUID/states/"

$ curl -X GET ${IRONIC_URL}/v1/nodes/$n/state/
{"error_message": "<html>\n <head>\n <title>404 Not Found</title>\n </head>\n <body>\n <h1>404 Not Found</h1>\n The resource could not be found.<br /><br />\n\n\n\n </body>\n</html>"}

$curl -X GET ${IRONIC_URL}/v1/nodes/$n/states/
{"target_power_state": null, "target_provision_state": null, "last_error": null, "console_enabled": false, "provision_updated_at": null, "power_state": null, "provision_state": null}

aeva black (tenbrae)
Changed in ironic:
status: New → Triaged
importance: Undecided → Low
tags: added: documentation
Srinivasa Acharya (rsacharya)
Changed in ironic:
assignee: nobody → Srinivasa Acharya (rsacharya)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to ironic (master)

Fix proposed to branch: master
Review: https://review.openstack.org/93193

Changed in ironic:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to ironic (master)

Reviewed: https://review.openstack.org/93193
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=79f3780431e338567ee85b4fad4a98dba6ad3a4f
Submitter: Jenkins
Branch: master

commit 79f3780431e338567ee85b4fad4a98dba6ad3a4f
Author: Srinivasa Acharya <email address hidden>
Date: Sat May 10 15:07:23 2014 -0400

    Corrects a typo in RESTful Web API (v1) document

    The typo /v1/nodes/<uuid>/state is changed to /v1/nodes/<uuid>/states
    Closes-Bug: 1311285

    Change-Id: I66bc695298c04b423c9c9be45b23fce5b60727f0

Changed in ironic:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in ironic:
milestone: none → juno-1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in ironic:
milestone: juno-1 → 2014.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.