Ironic

API docs don't list PATCH or DELETE methods

Bug #1261917 reported by aeva black
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
High
aeva black
Ironic 2014.1 "icehouse"

Bug Description

http://docs.openstack.org/developer/ironic/webapi/v1.html#nodes

The auto-generated REST API documentation (via sphinxcontrib-pecanwsme) doesn't list any of the PATCH or DELETE methods.

aeva black (tenbrae)
Changed in ironic:
status: New → Triaged
importance: Undecided → High
milestone: none → icehouse-3
Revision history for this message
aeva black (tenbrae) wrote :

Cross-posted here: https://github.com/dreamhost/sphinxcontrib-pecanwsme/issues/10

Revision history for this message
Haomeng,Wang (whaom) wrote :

Sphinx support "patch", "delete", but our Sphinx wsme extension dont support these HTTP method, I think we need to add "patch", "delete" method into the list:

https://github.com/dreamhost/sphinxcontrib-pecanwsme/blob/master/sphinxcontrib/pecanwsme/rest.py#L171

Revision history for this message
Doug Hellmann (doug-hellmann) wrote :

sphinxcontrib-pecanwsme 0.6 should include the fix for this. https://pypi.python.org/pypi/sphinxcontrib-pecanwsme/0.6

aeva black (tenbrae)
Changed in ironic:
milestone: icehouse-3 → icehouse-2
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/66078

Changed in ironic:
assignee: nobody → Devananda van der Veen (devananda)
status: Triaged → In Progress
Revision history for this message
aeva black (tenbrae) wrote :

Fixed upstream, and our autodoc builds contain the fixed documentation now.

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

Reviewed: https://review.openstack.org/66078
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=4a3dd7da2511e8452d68049cfb5ce6a923b89251
Submitter: Jenkins
Branch: master

commit 4a3dd7da2511e8452d68049cfb5ce6a923b89251
Author: Devananda van der Veen <email address hidden>
Date: Fri Jan 10 14:56:14 2014 -0800

    Bump version of sphinxcontrib-pecanwsme

    Version bump to add PATCH and DELETE support to API docs.

    Change-Id: I6a89a15012ba044f094d9043b32657c36ca01e20
    Closes-bug: #1261917

Thierry Carrez (ttx)
Changed in ironic:
milestone: icehouse-2 → 2014.1
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.