OpenStack API documentation site

Need response codes displayed on api.openstack.org

Reported by Anne Gentle on 2012-04-06
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Medium
Diane Fleming

Bug Description

While the wadls contain response codes, they are not output to api.openstack.org.

Anne Gentle (annegentle) on 2012-04-06
Changed in openstack-manuals:
status: New → Confirmed
importance: Undecided → Medium
Tom Fifield (fifieldt) on 2012-07-29
tags: added: api-site
Tom Fifield (fifieldt) wrote :

To fix this:

Fork https://github.com/rackspace/clouddocs-maven-plugin

Edit:
src/main/resources/wadl2html.xpl

Add the appropriate lines for response codes

Send a pull request

Changed in openstack-manuals:
status: Confirmed → Triaged
Tom Fifield (fifieldt) on 2012-10-15
affects: openstack-manuals → openstack-api-site
Changed in openstack-api-site:
assignee: nobody → Diane Fleming (diane-fleming)
Changed in openstack-api-site:
assignee: Diane Fleming (diane-fleming) → nobody
assignee: nobody → David Cramer (david-thingbag)
milestone: none → havana
Changed in openstack-api-site:
assignee: David Cramer (david-thingbag) → Diane Fleming (diane-fleming)
Changed in openstack-api-site:
status: Triaged → Confirmed
Diane Fleming (diane-fleming) wrote :

wrong URL:

it would involve some
xslt hackery.

This is the xslt that generates the page:

https://github.com/rackerlabs/clouddocs-maven-plugin/blob/master/src/main/resources/cloud/apipage/apipage-main.xsl

It would be a matter of grabbing the error codes and doing something
with them. You'd have to fetch the value of wadl:response/@status such
that the value doesn't start with a 2 or a 3.

See lines 484 ff of (where I turn the wadl into DocBook; in the case of
the apiref page, the wadl goes straight to html):
https://github.com/rackerlabs/clouddocs-maven-plugin/blob/master/src/main/resources/cloud/process-embedded-wadl.xsl

Diane Fleming (diane-fleming) wrote :

Fixed with https://github.com/rackerlabs/clouddocs-maven-plugin/pull/46

clouddocs-plugin version 1.9.4 (once it goes live)

Changed in openstack-api-site:
status: Confirmed → In Progress
Diane Fleming (diane-fleming) wrote :

Fixed with https://review.openstack.org/47184, so abandoning 47188. (dup)

Changed in openstack-api-site:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  Edit
Everyone can see this information.

Other bug subscribers