Outputs for parameters are missing for WADL embedded in DocBook for a "API Spec"

Bug #1342379 reported by Anne Gentle
14
This bug affects 2 people
Affects Status Importance Assigned to Milestone
openstack-manuals
Fix Released
Medium
Unassigned

Bug Description

Compare the amount of info given in this output for a POST to create a LB pool:
http://docs.openstack.org/api/openstack-network/2.0/content/POST_createPool__v2.0_lb_pools_lbaas_ext_ops_pool.html

with this output:
http://developer.openstack.org/api-ref-networking-v2.html#lbaas

both sourced from WADL, but the first output gives less info.

Tags: doc-builds
Revision history for this message
Anne Gentle (annegentle) wrote :

I find that the Developer Reference output is less helpful for app developers. The document may be slightly useful for contributor developers but they are instead just collaborating in easier ways, such as using a Google Doc.

tags: added: doc-builds
Revision history for this message
min wang (swiftwangster) wrote :

Great, thanks Anne!

Anne Gentle (annegentle)
Changed in openstack-manuals:
importance: Undecided → Medium
Liusheng (liusheng)
Changed in openstack-manuals:
assignee: nobody → Liusheng (liusheng)
Revision history for this message
Liusheng (liusheng) wrote :

When I check this bug, I have found that, the req json and the response json are wrong

Revision history for this message
min wang (swiftwangster) wrote :

hey Liusheng, can you give a particular example for the wrong req and response json so we can double check.

Revision history for this message
Liusheng (liusheng) wrote :

Hi, min wang, I have uploaded a patch to fix this bug:https://review.openstack.org/#/c/107603/

the patch review page clearly show the correct req and response json and the previous wrong json. (I change the json with latest neutron and neutronclient code)

thanks :)

Liusheng (liusheng)
Changed in openstack-manuals:
status: Confirmed → In Progress
Revision history for this message
min wang (swiftwangster) wrote :

@Liusheng , i checked your change, and i am wondering what is your base of the code change, which document did you use as reference. I used this one : https://docs.google.com/document/d/160hjgBYN8IzZPe6aPyNl7Y2C4ZeQIQ4GNTOCTHcvbkA/edit#heading=h.4fydv48sbcpo

Tom Fifield (fifieldt)
Changed in openstack-manuals:
status: In Progress → Confirmed
Liusheng (liusheng)
Changed in openstack-manuals:
assignee: Liusheng (liusheng) → nobody
Revision history for this message
Anne Gentle (annegentle) wrote :

The first output will no longer be updated so I'm marking this as Won't Fix. Please open a new bug if you find that the LBaaS doc at http://developer.openstack.org/api-ref-networking-v2-ext.html#lbaas-v1.0 or http://developer.openstack.org/api-ref-networking-v2-ext.html#lbaas-v2.0 are incorrect.

Changed in openstack-manuals:
status: Confirmed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

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