[Openstack-docs] wadl for object-api

Anne Gentle annegentle at justwriteclick.com
Wed Sep 18 19:57:12 UTC 2013


On Wed, Sep 18, 2013 at 2:54 PM, David Cramer <david.cramer at rackspace.com>wrote:

> Ah, excellent! So why is there a separate developer guide that kind-of
> has an api reference, but not really? It seems strange to split the
> content over the two places.
>
>
Yes - the original idea was that the api-site repo would document reality
for end users, and the <project>-api repos would contain specs.





> Regards,
> David
>
> On 09/18/2013 02:41 PM, Anne Gentle wrote:
> > Yep, there is an object-api WADL in the api-site repo.
> >
> >
> http://git.openstack.org/cgit/openstack/api-site/tree/api-ref/src/wadls/object-api/src/os-object-api-1.0.wadl
> >
> > It would be great to get all the headers in it, not sure if it's
> > complete. See:
> >
> > https://bugs.launchpad.net/openstack-api-site/+bug/1193417
> > https://bugs.launchpad.net/openstack-api-site/+bug/1214136
> > https://bugs.launchpad.net/openstack-api-site/+bug/1214139
> >
> > I've asked Catherine Richardson, the Cloud Files writer at Rackspace, to
> > work on https://bugs.launchpad.net/openstack-api-site/+bug/1224562.
> >
> >
> >
> > Anne
> >
> >
> > On Wed, Sep 18, 2013 at 2:21 PM, David Cramer
> > <david.cramer at rackspace.com <mailto:david.cramer at rackspace.com>> wrote:
> >
> >     Hi all,
> >     A colleague and are considering using object-api [1] to demonstrate
> some
> >     ideas we have about what complete documentation should look like. To
> do
> >     this, we're planning on creating a wadl for the object-api. I thought
> >     I'd check to see if an initial wadl already exists somewhere or is in
> >     progress. If not, I plan on creating one (and incorporating material
> >     from your existing reference doc). We can then generate the dev guide
> >     reference section from it and also use it for the api.openstack.org
> >     <http://api.openstack.org> site.
> >
> >     Regards,
> >     David
> >
> >     [1] https://github.com/openstack/object-api
> >
> >     _______________________________________________
> >     Openstack-docs mailing list
> >     Openstack-docs at lists.openstack.org
> >     <mailto:Openstack-docs at lists.openstack.org>
> >     http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
> >
> >
> >
> >
> > --
> > Anne Gentle
> > annegentle at justwriteclick.com <mailto:annegentle at justwriteclick.com>
>
>


-- 
Anne Gentle
annegentle at justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20130918/0d7290a6/attachment.html>


More information about the Openstack-docs mailing list