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

Atsushi SAKAI sakaia at jp.fujitsu.com
Mon Jul 27 12:56:37 UTC 2015


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


Thanks
Atsushi SAKAI




More information about the OpenStack-docs mailing list