api-site WADL source files need to move to API repos

[Anne Gentle]

The WADLs as source files in the openstack-api-site directory need to be moved to the API repos and the pointers to the WADLs in the index.xml file should point to the repository location rather than the local "openstack-manuals" location.

[Anne Gentle (annegentle)]

Unassigning so others can pick it up.

[Tom Fifield (fifieldt)]

Hi Diane,

Any progress on this one?

[Tom Fifield (fifieldt)]

to do this,

clone the openstack-manuals repository and find the WADLS under:
doc/src/docbkx/openstack-api-site/src/wadls

Then grab the api-site repos from:
https://github.com/openstack/object-api.git
https://github.com/openstack/compute-api.git
https://github.com/openstack/identity-api
https://github.com/openstack/image-api
https://github.com/openstack/netconn-api.git

add the files, and update the index.xml in each.

[Anne Gentle (annegentle)]

Updating with a comment. Now that the WADLs in the doc/src/docbkx/openstack-api-site/src/wadls are not "to spec" I'm rethinking this... not to get into analysis paralysis, but I don't know how to share WADLs with specs if there are some server params documented in the WADL in doc/src/docbkx/openstack-api-site/src/wadls/compute-api that are not "to spec" - this is wrapped up in the effort to clean up at http://wiki.openstack.org/DisableServerExtensions. Even with the cleanup, will the compute-api WADL be to spec? I'm not sure.

I'm rethinking the approach here to try to separate specifications from developer documents. I believe that WADL remains as the extremely lightweight (amount of content) reference information. But I'm not sure about sharing content with specs. Only Identity completely contains the spec doc with WADL inside now. And on api.openstack.org, the WADLs strive for "truth" rather than spec as a quick reference guide.

As a result, let's leave this as-is (Triaged, Med) but leave it unassigned while continuing to seek the right overall solution.

[Tom Fifield (fifieldt)]

HI Anne,

I know you've been doing some more thinking about this recently - is there an update to this bug?

[Anne Gentle (annegentle)]

Sent a note to the openstack-docs mailing list with this move described, will wait a few days for potential feedback then propose the move.

[Anne Gentle (annegentle)]

Marking as won't fix. The WADLs are not specifications and document what is really happening with the APIs. So sending them to the *-api repos, which are for specifications, is not a good idea at this time.