[Openstack] API Spec

Vishvananda Ishaya vishvananda at gmail.com
Mon Aug 22 22:43:06 UTC 2011


Hey Everyone,

We discussed at the Diablo design summit having API spec changes be proposed along with code changes and reviewed according to the merge process that we use for code.  This has been impossible up until now because the canonical spec has been in the openstack-manuals project.

My suggestion is that we move the openstack-compute spec into the nova source tree.  During a six-month release we can propose changes to the spec by proposing along with the code that changes it.  In the final freeze for the release, we can increment the spec version number and copy the current version of the spec into openstack-manuals and that will be the locked down spec for that release.

This means that openstack 1.1 will be the official spec for diablo, at which point we will start working on a new api (we can call it 1.2 but it might be best to use a temporary name like 'latest') during the essex release cycle, then at essex release we lock the spec down and it becomes the new version of the openstack api.

Ultimately I would like the spec to be generated from the code, but as a first pass, we should at least be able to edit the future version of the spec as we make changes.  I've proposed the current version of the spec here:

https://code.launchpad.net/~vishvananda/nova/add-api-docs/+merge/72506

Are there any issues with this approach?

Vish
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack/attachments/20110822/ce32d871/attachment.html>


More information about the Openstack mailing list