<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Wed, May 18, 2016 at 1:42 PM, Hayes, Graham <span dir="ltr"><<a href="mailto:graham.hayes@hpe.com" target="_blank">graham.hayes@hpe.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex">I was moving Designate to the os-api-ref extension, and I spotted<br>
something I thought we could do to improve the readability.<br></blockquote><div><br></div><div>Thank you!</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex">
<br>
Currently we have the HTTP Response Codes as a single<br>
line on the page - I thought a table might be handy as well.<br>
<br>
So, I had a go at it - and put up a POC[0]<br>
<br>
It outputs a table with the code and the project reason for the code[1]<br>
<br>
Example syntax is (used to generate [1]):<br>
<br>
     Response Codes<br>
     --------------<br>
<br>
     Normal<br>
     ^^^^^^<br>
<br>
     .. rest_response::<br>
<br>
        - 200: OK<br>
        - 100: Foo<br>
        - 201: Zone Created<br>
<br>
<br>
<br>
     Error<br>
     ^^^^^<br>
<br>
     .. rest_response::<br>
<br>
        - 405: Method *must* be POST<br>
        - 403: Policy does not allow current user to create zone<br>
        - 401: User must authenticate<br>
        - 400: Supplied data is malformed.<br>
        - 500: Something went wrong<br>
<br>
Is this something worth pursuing? Should it be laid out differently?<br></blockquote><div><br></div><div>Definitely worth pursuing.</div><div><br></div><div>How will teams get to more definitively describe the responses? For example, these descriptions for Compute errors:</div><br>The operation is not allowed because the corresponding<br>server is in a build state.</div><div class="gmail_quote"><br>or<br><br>The operation is not allowed because the corresponding<br>server is being re-sized or backed up.<br><br>If those descriptions are embedded in the Sphinx extension, I think we'll need to enable more detailed descriptions, and simply want to understand how. When I looked at the code, that was my question in the review - help me understand the mechanism better. </div><div class="gmail_quote"><br></div><div class="gmail_quote">Thanks a bunch for doing this!</div><div class="gmail_quote">Anne<br><br> <br></div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-style:solid;border-left-color:rgb(204,204,204);padding-left:1ex"> <br>
Thanks,<br>
<br>
-- Graham<br>
<br>
0 - <a href="https://review.openstack.org/#/c/318281/1" rel="noreferrer" target="_blank">https://review.openstack.org/#/c/318281/1</a><br>
1 - <a href="http://i.imgur.com/onsRFtI.png" rel="noreferrer" target="_blank">http://i.imgur.com/onsRFtI.png</a><br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr"><div><div dir="ltr"><div>Anne Gentle</div><div><a href="http://www.justwriteclick.com" style="font-size:12.8px" target="_blank">www.justwriteclick.com</a><br></div></div></div></div></div>
</div></div>