openstack team mailing list archive

[Anne Gentle <anne@xxxxxxxxxxxxx>]

Thanks Chmouel for reviewing. I am reviewing (and patching as needed) also.

Adrian, the API will not version upwards until the API itself is
redesigned, so the doc will remain an API 1.0 document.

Generally speaking, the documents stored in object-api, compute-api,
identity-api, netconn-api and image-api repos will document the code
that's in a core project. Changes in them need to be approved by core
members of the corresponding project, and doc-core can also approve
small changes to get them published.

Thanks,

Anne



On Thu, Jun 14, 2012 at 6:16 AM, Chmouel Boudjnah <chmouel@xxxxxxxxxxx> wrote:
> On Tue, Jun 12, 2012 at 9:16 AM,  <Adrian_F_Smith@xxxxxxxx> wrote:
>> For anyone interested in documentation I've posted two changes in relation to the Swift API docs,
>> Describe the end_marker parameter (https://review.openstack.org/#/c/8375/)
>> Added section on metadata at account level (https://review.openstack.org/#/c/8374/)
>
> Nice, thanks you, I have done some review. How does it work for docs
> does it need to have two core doing a +2 or one is enough?
>
>> Since the API documents are versioned (currently 1.0) is it right to retrospectively update them now? Is the documentation a spec and Swift an implementation of that spec or are the two running in parallel?
>
> I'd say the two running in parallel.
>
>> There are a few other gaps in the API docs but I wanted to get clarification before proceeding.
>
> Thanks,
> Chmouel.