<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Thu, Feb 19, 2015 at 6:43 PM, Christopher Yeoh <span dir="ltr"><<a href="mailto:cbkyeoh@gmail.com" target="_blank">cbkyeoh@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div><div><div><div><div><div><div>Hi,<br><br></div>With the upcoming release of v2.1 microversions for the Nova API there is a file that<br></div>lives in the Nova tree that I think would be really useful released alongside the Nova API ref documentation. It can be seen in this review:<br><br><a href="https://review.openstack.org/#/c/140313/" target="_blank">https://review.openstack.org/#/c/140313/</a><br><br></div>in rest_api_version_history.rst<br><br></div>Its in the Nova tree so we can enforce developers writing a decent summary of the API changes before the code merges.<br><br></div>So I'm wondering how we might be able to have this along side the api developer ref documentation on the website (can we automate this getting copied?) . </div></div></div></blockquote><div><br></div><div>We've wanted to automate copying tested sample requests and resources for a while now, see this blueprint: <a href="https://blueprints.launchpad.net/openstack-manuals/+spec/api-samples-to-api-site" target="_blank">https://blueprints.launchpad.net/openstack-manuals/+spec/api-samples-to-api-site</a></div><div><br></div><div>So yes, it would be great to get automated. Anyone have a resource who could do this or have an interest in cross-repo file copy automation? </div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div><div>Unfortunately we don't have api ref docs for v2.1 microversions yet - it is from an API point of view pretty identical to v2, at least until the api changes using microversions like the review referenced above. Any changes using microversions do generate new api samples.<br><br></div></div></div></blockquote><div><br></div><div>There are API ref docs for 2.1 in the api-site repo, basically identical to v2 but with the new X-OpenStack-Request-ID header and no extensions indicated.</div><div><br></div><div>Note that I've got this patch in review now to ensure the "overview" (non reference) API docs get into the nova repo. <a href="https://review.openstack.org/#/c/142495/" target="_blank">https://review.openstack.org/#/c/142495/</a></div><div><br></div><div>Seems like a similar set of docs for 2.1 would be useful, what do you think?</div><div><br></div><div>Also this thread is as good a thread as any to put out a call to action to have someone work on the backlog of API doc bugs for "compute-v3-now-v2.1"</div><div><br></div><div><a href="https://bugs.launchpad.net/openstack-api-site/+bugs/?field.tag=compute-v3">https://bugs.launchpad.net/openstack-api-site/+bugs/?field.tag=compute-v3</a><br></div><div><br></div><div>I've definitely seen an uptick in both commits and reviews in the API reference info but we're always looking for more contributors. (Love waking up to overnight API doc work, better than coffee some mornings.)</div><div><br></div><div>Thanks,</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><div><div></div>Regards,<br><br></div>Chris<br></div>
<br>_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br>
<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></blockquote></div><br><br clear="all"><div><br></div>-- <br><div>Anne Gentle<br><a href="mailto:annegentle@justwriteclick.com" target="_blank">annegentle@justwriteclick.com</a></div>
</div></div>