API documentation does not conform to Namespace URL paths
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
openstack-api-site |
Won't Fix
|
Wishlist
|
Unassigned |
Bug Description
API methods have unique identifiers defined as a namespace in them.
Below is an example class definition for the flavormanage API, in it you can see the namespace definition pointing to a docs path.
It would be worthwhile to make sure that documentation on method calls is accessible at that namespace URL.
Otherwise there's 300 some odd namespace pathes in the source that will 404. Also at a later date this namespace identifier could be used to ensure that any newly registered namespace has corresponding documentation provided and updated ( on deltas ) as a test case.
Example class in API:
class Flavormanage(
"""
Flavor create/delete API support
"""
name = "FlavorManage"
alias = "os-flavor-manage"
namespace = ("http://
updated = "2012-01-
def get_controller_
controller = FlavorManageCon
extension = extensions.
return [extension]
~
summary: |
- API documentation does not conform to Namespace URL pathes + API documentation does not conform to Namespace URL paths |
affects: | openstack-manuals → openstack-api-site |
Hi,
So what should be at that URL?
Would a link to an anchor within the api.openstack.org site be sufficient ?
eg http:// docs.openstack. org/compute/ ext/flavor_ manage/ api/v1. 1 points to http:// api.openstack. org#flavour- manage