<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Jul 27, 2015 at 7:56 AM, Atsushi SAKAI <span dir="ltr"><<a href="mailto:sakaia@jp.fujitsu.com" target="_blank">sakaia@jp.fujitsu.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">I want to know the api-site document policy for request body.<br>
for POST operation<br>
<br>
  This question relates to following issue.<br>
     <a href="https://review.openstack.org/#/c/203987/" rel="noreferrer" target="_blank">https://review.openstack.org/#/c/203987/</a><br>
<br>
which option is correct 1) or 2) for request body description?<br>
<br>
1)one description(i.e. volume) for Request body(JSON parameter)<br>
  <a href="http://developer.openstack.org/api-ref-compute-v2-ext.html#createVolume" rel="noreferrer" target="_blank">http://developer.openstack.org/api-ref-compute-v2-ext.html#createVolume</a><br>
<br>
  Same pattern<br>
   <a href="http://developer.openstack.org/api-ref-compute-v2-ext.html#createSnapshot" rel="noreferrer" target="_blank">http://developer.openstack.org/api-ref-compute-v2-ext.html#createSnapshot</a><br>
<br>
2)each value is described for Request body (JSON parameter)<br>
<br>
  Like this (Create default security group rule)<br>
<a href="http://developer.openstack.org/api-ref-compute-v2-ext.html#createSecGroupRule" rel="noreferrer" target="_blank">http://developer.openstack.org/api-ref-compute-v2-ext.html#createSecGroupRule</a><br>
<br>
<br></blockquote><div><br></div><div>I really would prefer the additional detail for each value in the entire JSON response. It won't be consistent since we're way behind in having those everywhere, but it helps the user so please do put it in when you can. Commenting on the review also.</div><div><br></div><div>Thanks,</div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
Thanks<br>
Atsushi SAKAI<br>
<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>Anne Gentle</div><div>Rackspace</div><div>Principal Engineer</div><div><a href="http://www.justwriteclick.com" target="_blank">www.justwriteclick.com</a></div></div></div>
</div></div>