<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
</head>
<body style="word-wrap: break-word; -webkit-nbsp-mode: space; -webkit-line-break: after-white-space; color: rgb(0, 0, 0); font-size: 14px; font-family: Calibri, sans-serif; ">
<div>
<div>
<div>We need to rethink all that. </div>
<div><br>
</div>
<div>I think we need:</div>
<div><br>
</div>
<ul>
<li>API Reference pages, one per project, that documents the APIs</li><li>One OpenStack API Guide that introduces API concepts, general information, glossary, etc., but does not detail each project's API.</li></ul>
<div>But that's my opinion!</div>
<div><br>
</div>
<div>
<div>
<div style="color: rgb(0, 0, 0); "><font class="Apple-style-span" color="rgb(0, 0, 0)" face="Apple Chancery"><i>Diane</i></font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; color: rgb(0, 0, 0); ">
<font class="Apple-style-span" color="rgb(0, 0, 0)"><i>----------------------------------------------</i></font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; color: rgb(0, 0, 0); ">
<font class="Apple-style-span" color="rgb(0, 0, 0)">Diane Fleming</font></div>
<div style="font-family: Calibri, sans-serif; font-size: 14px; ">
<div style="color: rgb(0, 0, 0); ">Software Developer II - US</div>
</div>
diane.fleming@rackspace.com</div>
<div>Cell 512.323.6799</div>
<div>Office 512.874.1260<br>
<span class="Apple-style-span" style="font-family: Calibri, sans-serif; ">
<div style="font-family: Calibri, sans-serif; font-size: 14px; ">
<div style="color: rgb(0, 0, 0); ">Skype drfleming0227</div>
<div style="color: rgb(0, 0, 0); ">Google-plus diane.fleming@gmail.com</div>
</div>
</span></div>
</div>
</div>
</div>
<div><br>
</div>
<span id="OLK_SRC_BODY_SECTION">
<div style="font-family:Calibri; font-size:11pt; text-align:left; color:black; BORDER-BOTTOM: medium none; BORDER-LEFT: medium none; PADDING-BOTTOM: 0in; PADDING-LEFT: 0in; PADDING-RIGHT: 0in; BORDER-TOP: #b5c4df 1pt solid; BORDER-RIGHT: medium none; PADDING-TOP: 3pt">
<span style="font-weight:bold">From: </span>Anne Gentle <<a href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a>><br>
<span style="font-weight:bold">Date: </span>Wednesday, September 18, 2013 2:57 PM<br>
<span style="font-weight:bold">To: </span>David Cramer <<a href="mailto:david.cramer@RACKSPACE.COM">david.cramer@RACKSPACE.COM</a>><br>
<span style="font-weight:bold">Cc: </span>"<a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>" <<a href="mailto:openstack-docs@lists.openstack.org">openstack-docs@lists.openstack.org</a>><br>
<span style="font-weight:bold">Subject: </span>Re: [Openstack-docs] wadl for object-api<br>
</div>
<div><br>
</div>
<div>
<div>
<div dir="ltr"><br>
<div class="gmail_extra"><br>
<br>
<div class="gmail_quote">On Wed, Sep 18, 2013 at 2:54 PM, David Cramer <span dir="ltr">
<<a href="mailto:david.cramer@rackspace.com" target="_blank">david.cramer@rackspace.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Ah, excellent! So why is there a separate developer guide that kind-of<br>
has an api reference, but not really? It seems strange to split the<br>
content over the two places.<br>
<br>
</blockquote>
<div><br>
</div>
<div>Yes - the original idea was that the api-site repo would document reality for end users, and the <project>-api repos would contain specs. </div>
<div><br>
</div>
<div><br>
</div>
<div><br>
</div>
<div> </div>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Regards,<br>
David<br>
<div class="im"><br>
On 09/18/2013 02:41 PM, Anne Gentle wrote:<br>
> Yep, there is an object-api WADL in the api-site repo.<br>
><br>
> <a href="http://git.openstack.org/cgit/openstack/api-site/tree/api-ref/src/wadls/object-api/src/os-object-api-1.0.wadl" target="_blank">
http://git.openstack.org/cgit/openstack/api-site/tree/api-ref/src/wadls/object-api/src/os-object-api-1.0.wadl</a><br>
><br>
> It would be great to get all the headers in it, not sure if it's<br>
> complete. See:<br>
><br>
> <a href="https://bugs.launchpad.net/openstack-api-site/+bug/1193417" target="_blank">
https://bugs.launchpad.net/openstack-api-site/+bug/1193417</a><br>
> <a href="https://bugs.launchpad.net/openstack-api-site/+bug/1214136" target="_blank">
https://bugs.launchpad.net/openstack-api-site/+bug/1214136</a><br>
> <a href="https://bugs.launchpad.net/openstack-api-site/+bug/1214139" target="_blank">
https://bugs.launchpad.net/openstack-api-site/+bug/1214139</a><br>
><br>
> I've asked Catherine Richardson, the Cloud Files writer at Rackspace, to<br>
> work on <a href="https://bugs.launchpad.net/openstack-api-site/+bug/1224562" target="_blank">
https://bugs.launchpad.net/openstack-api-site/+bug/1224562</a>.<br>
><br>
><br>
><br>
> Anne<br>
><br>
><br>
> On Wed, Sep 18, 2013 at 2:21 PM, David Cramer<br>
</div>
<div class="im">> <<a href="mailto:david.cramer@rackspace.com">david.cramer@rackspace.com</a> <mailto:<a href="mailto:david.cramer@rackspace.com">david.cramer@rackspace.com</a>>> wrote:<br>
><br>
> Hi all,<br>
> A colleague and are considering using object-api [1] to demonstrate some<br>
> ideas we have about what complete documentation should look like. To do<br>
> this, we're planning on creating a wadl for the object-api. I thought<br>
> I'd check to see if an initial wadl already exists somewhere or is in<br>
> progress. If not, I plan on creating one (and incorporating material<br>
> from your existing reference doc). We can then generate the dev guide<br>
> reference section from it and also use it for the <a href="http://api.openstack.org" target="_blank">
api.openstack.org</a><br>
</div>
> <<a href="http://api.openstack.org" target="_blank">http://api.openstack.org</a>> site.<br>
<div class="im">><br>
> Regards,<br>
> David<br>
><br>
> [1] <a href="https://github.com/openstack/object-api" target="_blank">https://github.com/openstack/object-api</a><br>
><br>
> _______________________________________________<br>
> Openstack-docs mailing list<br>
> <a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a><br>
</div>
> <mailto:<a href="mailto:Openstack-docs@lists.openstack.org">Openstack-docs@lists.openstack.org</a>><br>
<div class="im">> <a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" target="_blank">
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
><br>
><br>
><br>
><br>
> --<br>
> Anne Gentle<br>
</div>
> <a href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a> <mailto:<a href="mailto:annegentle@justwriteclick.com">annegentle@justwriteclick.com</a>><br>
<br>
</blockquote>
</div>
<br>
<br clear="all">
<div><br>
</div>
-- <br>
Anne Gentle<br>
<a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div>
</div>
</div>
</div>
</span>
</body>
</html>