Re: [DISCUSS] Improving API reference pages

2015-08-10 Thread Rajsekhar K
sh > > > -Original Message- > From: Dave Dunaway [mailto:dave.duna...@gmail.com] > Sent: Monday, August 03, 2015 9:24 AM > To: us...@cloudstack.apache.org > Cc: dev@cloudstack.apache.org > Subject: Re: Improving API reference pages > > I would definitely say this is nee

Improving API reference pages

2015-08-03 Thread Somesh Naidu
Dunaway [mailto:dave.duna...@gmail.com] Sent: Monday, August 03, 2015 9:24 AM To: us...@cloudstack.apache.org Cc: dev@cloudstack.apache.org Subject: Re: Improving API reference pages I would definitely say this is needed. A few calls need to specify "types" of which there is not description o

Re: Improving API reference pages

2015-08-03 Thread Dave Dunaway
I would definitely say this is needed. A few calls need to specify "types" of which there is not description or they are poorly worded. If the API doc page could have comments... that would be good too. Let the community add examples or suggestions. However the real deal is to document the attrib

Improving API reference pages

2015-08-03 Thread Rajsekhar K
Hi, All, This is part of our effort to improve user experience of Cloudstack/CloudPlatform API reference pages. Majority of the CloudStack/CloudPlatform API reference pages do not adequately describe the usage of the parameters associated with them. Many of these parameters contain only a single