Open Stack

We need to rethink all that.

I think we need:


  *   API Reference pages, one per project, that documents the APIs
  *   One OpenStack API Guide that introduces API concepts, general information, glossary, etc., but does not detail each project's API.

But that's my opinion!

Diane
----------------------------------------------
Diane Fleming
Software Developer II - US
diane.fleming at rackspace.com
Cell  512.323.6799
Office 512.874.1260
Skype drfleming0227
Google-plus diane.fleming at gmail.com

From: Anne Gentle <annegentle at justwriteclick.com<mailto:annegentle at justwriteclick.com>>
Date: Wednesday, September 18, 2013 2:57 PM
To: David Cramer <david.cramer at RACKSPACE.COM<mailto:david.cramer at RACKSPACE.COM>>
Cc: "openstack-docs at lists.openstack.org<mailto:openstack-docs at lists.openstack.org>" <openstack-docs at lists.openstack.org<mailto:openstack-docs at lists.openstack.org>>
Subject: Re: [Openstack-docs] wadl for object-api




On Wed, Sep 18, 2013 at 2:54 PM, David Cramer <david.cramer at rackspace.com<mailto: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> <mailto: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>
>     <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>
>     <mailto: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> <mailto:annegentle at justwriteclick.com<mailto:annegentle at justwriteclick.com>>




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