That's actually a great point. One of my favorites is:
http://cloudstack.apache.org/docs/api/apidocs-4.2/root_admin/changeServiceForSystemVm.html

Is ID really UUID? or the human readable ID?

--David.

On Mon, Oct 21, 2013 at 5:32 AM, Radhika Puthiyetath
<radhika.puthiyet...@citrix.com> wrote:
> Hi David,
>
> They are simple one liners that do not convey  anything about the API.
>
> -----Original Message-----
> From: David Nalley [mailto:da...@gnsa.us]
> Sent: Monday, October 21, 2013 2:54 PM
> To: dev@cloudstack.apache.org
> Subject: Re: Incomplete API docs?
>
> On Wed, Oct 16, 2013 at 6:24 AM, Radhika Puthiyetath 
> <radhika.puthiyet...@citrix.com> wrote:
>> Hi All,
>>
>> Our API documentation requires a serious refurbishment.
>>
>
>
> Hi Radhika:
>
> What do you see as lacking in our current API docs (aside from them not 
> working ;) )
>
>
>
>> How about creating a doc sprint for enhancing API documentation ?
>>
>> I am in the process of setting up a Wiki page at 
>> https://cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+Sprint+for+Enhancing+API+Documentation
>>  to track this activity. Feel free to add/ edit/ remove the page content.
>>
>> I request all of you to volunteer so that we will have a comprehensive API 
>> doc set by next release.
>>
>> Appreciate your feedback.
>>

Reply via email to