api.openstack.org needs permalinks to individual items

Bug #1039163 reported by Glen Campbell
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
openstack-api-site
Fix Released
Wishlist
Diane Fleming

Bug Description

Rather than duplicating the existing documentation, I would like to point developers to http://api.openstack.org, for example, to have them find what the possible parameters are for retrieving a list of objects from a container in Swift. However, the "detail" buttons do not provide a link to that section, so the only way to use it is to direct someone to that have and then to write navigation instructions to find the correct resource and HTTP method, which is very painful.

Since I'm writing language bindings, the whole intent is to hide the underlying resource structure, so it becomes doubly burdensome, which means that, at the moment, I'm forced to essentially duplicate the documentation in my SDK. This means that, should the underlying documentation/product change, my docs will then be out of date.

A better solution would be to provide links (for example, http://api.openstack.org/#GET-v1-account-container) directly to the appropriate section.

Tags: api-site
Revision history for this message
Anne Gentle (annegentle) wrote :

Like this idea - it's related to 980228, asking for anchor tags so that pointers can be more exact. I won't mark this as dupe but want to be sure people know it's related.

Changed in openstack-manuals:
status: New → Confirmed
Tom Fifield (fifieldt)
Changed in openstack-manuals:
importance: Undecided → Wishlist
tags: added: api-site
Tom Fifield (fifieldt)
affects: openstack-manuals → openstack-api-site
Changed in openstack-api-site:
assignee: nobody → Diane Fleming (diane-fleming)
status: Confirmed → In Progress
milestone: none → grizzly
Revision history for this message
Diane Fleming (diane-fleming) wrote :
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to api-site (master)

Reviewed: https://review.openstack.org/28248
Committed: http://github.com/openstack/api-site/commit/bb8ca14bafa9e220e43394cac8a68e1b868f6b01
Submitter: Jenkins
Branch: master

commit bb8ca14bafa9e220e43394cac8a68e1b868f6b01
Author: Diane Fleming <email address hidden>
Date: Sun May 5 08:37:44 2013 -0500

    Updated to 1.8.0 to add permalinks and jump menu to api-ref page

    bug: #980228
    bug: #1039163

    Change-Id: I6a6d14c06ac1873303a5b6892d0923d36ff02a4b
    author: Diane Fleming

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

Other bug subscribers

Remote bug watches

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