openstack team mailing list archive
-
openstack team
-
Mailing list archive
-
Message #05436
Re: Draft API specifications
I think we need a straight copy of Nova 1.1 -> Nova 2.0 that simply renames everything from 1.1 -> 2.0 and changes the endpoint url v1.1 -> v2
Also a big note saying that 2.0 is exactly the same as 1.1 but was renamed to avoid confusion with 1.0 when we pulled out the minor version from the url.
Having 2.1 in draft seems great to me. I think it is fine to have a draft docs available before RFC. It gives us a place to start working on stuff.
Vish
On Nov 8, 2011, at 2:54 PM, Anne Gentle wrote:
> Hi all -
>
> We have three projects that need to have draft API docs (for a new API version) published for feedback and consumption during the Essex timeframe. (Quantum 1.0>1.1, Glance 1.1>2.0, and Nova 1.1>2.1)
>
> I'd like to get ideas about where those should be published and some of the requirements around their draft status.
>
> Is there a need for special treatment for "RFC" vs. "Draft" designations such as RFC for a certain time period, then Draft?
> Do these need drafts need to be published to docs.openstack.org/api, or is that site for "final" APIs for end-users? I envision introducing more confusion than is already present if we publish them side-by-side.
> Do these API drafts need their own site for the RFC/Draft period, such as api.openstack.org/drafts?
> What do other projects do with their draft APIs that you like?
> Thanks for your input. At the team meeting I got *crickets* when I asked. :) I'd like to set up a site that's as lights-out and automated as possible, no need for me to be a gatekeeper on this info, but some up-front info architecture will help people find and use the info.
>
> Thanks,
> Anne
> Anne Gentle
> anne@xxxxxxxxxxxxx
> my blog | my book | LinkedIn | Delicious | Twitter
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help : https://help.launchpad.net/ListHelp
References