Hi, Yiping,
Thanks for your suggestions. I have updated the template based on your
suggestions. Please find attached the updated template for your reference.
I agree with your suggestion on proof-reading the descriptions. This is an
important part of ensuring effective API references. I think the
Thanks.
Format is to domonstrate the usage of the API. I think that the format
along with an example would help users understand how they can use the API.
For example, the migrateto parameter in the API has the following format:
migrateto[volume-index].volume=&migrateto[volume-index].pool=Where,
As a user who uses API a lot, I would like to see following improvements in
api reference pages:
1) In brief description for Title section, please specify if the referenced API
is async or not. Currently, this info is available only on the API listing
pages with “(A)” after the api name, but
I assume by "Format" you mean data type.
But I think this looks good. It's simple, yet it manages to nail all the
points you need when developing on a software's API.
On Tue, Nov 10, 2015 at 8:33 AM Rajsekhar K
wrote:
> Hi, All,
>
> This is the proposal for a new template for CloudStack API ref
