[OpenStack-docs] Question about api-site document detailness policy for request body

Anne Gentle annegentle at justwriteclick.com
Mon Jul 27 13:18:09 UTC 2015


On Mon, Jul 27, 2015 at 7:56 AM, Atsushi SAKAI <sakaia at jp.fujitsu.com>
wrote:

> I want to know the api-site document policy for request body.
> for POST operation
>
>   This question relates to following issue.
>      https://review.openstack.org/#/c/203987/
>
> which option is correct 1) or 2) for request body description?
>
> 1)one description(i.e. volume) for Request body(JSON parameter)
>   http://developer.openstack.org/api-ref-compute-v2-ext.html#createVolume
>
>   Same pattern
>
> http://developer.openstack.org/api-ref-compute-v2-ext.html#createSnapshot
>
> 2)each value is described for Request body (JSON parameter)
>
>   Like this (Create default security group rule)
>
> http://developer.openstack.org/api-ref-compute-v2-ext.html#createSecGroupRule
>
>
>
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.

Thanks,
Anne


> Thanks
> Atsushi SAKAI
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150727/2b8ad594/attachment.html>


More information about the OpenStack-docs mailing list