openstack team mailing list archive

[Anne Gentle <anne@xxxxxxxxxxxxx>]

Ah, great question Adrian. Ideally the PTL and I work together to
identify a resource to update the API guide prior to the release going
out. John and I spoke early on in the Folsom release timeframe about
potential API changes but then we didn't connect the dots that the
1.5.0 release needs API doc changes. Thanks for bringing it up.

The source for the API guides are housed in separate repos, in this
case it's at:

http://github.com/openstack/object-api

Anne

On Tue, Jun 5, 2012 at 2:18 PM, Adrian Smith <adrian_f_smith@xxxxxxxx> wrote:
> I've been digging about in the Swift codebase recently and I've come
> across a few few features that aren't documented in the API docs. For
> example, metadata at the account level, "prefix" parameter at the
> account level, "end_marker" parameter, object versioning (new in
> 1.5.0). These are just a few. I'm sure there are other examples.
> Should these features be included in the API docs (perhaps v2.0) or
> were they purposely left out? Obviously the code will continue to
> evolve but I'm curious what the situation is regarding the
> documentation.
>
> On a related note, where can I find the docbook source used to
> generate the Swift API documentation,
> http://docs.openstack.org/api/openstack-object-storage/1.0/content/index.html.
> I've looked around in the openstack-manuals project but can't seem to
> find anything.
>
> Thanks
>
> Adrian
>
> _______________________________________________
> Mailing list: https://launchpad.net/~openstack
> Post to     : openstack@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~openstack
> More help   : https://help.launchpad.net/ListHelp