incubator-cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Alena Prokharchyk <Alena.Prokharc...@citrix.com>
Subject Re: CloudStack API question
Date Tue, 26 Jun 2012 23:53:33 GMT
Here is the doc explaining @ usage in API commands / API responses:

http://wiki.cloudstack.org/display/dev/Annotations+use+in+API

-Alena.


On 6/25/12 9:37 AM, "Alena Prokharchyk" <Alena.Prokharchyk@citrix.com>
wrote:

>I'll write something up, and let you know the wiki page location once I'm
>done.
>
>-Alena.
>
>
>On 6/25/12 4:23 AM, "Deepak Garg" <deepak.garg@citrix.com> wrote:
>
>>
>>
>>-----Original Message-----
>>From: Prasanna Santhanam [mailto:prasanna.santhanam@citrix.com]
>>Sent: Monday, June 25, 2012 1:45 PM
>>To: cloudstack-dev@incubator.apache.org
>>Cc: Radhika Nair
>>Subject: Re: CloudStack API question
>>
>>On Fri, Jun 22, 2012 at 05:20:45PM -0400, Jessica Tomechak wrote:
>>> Thanks to Amit for raising these API questions. I have noted the
>>>answers in
>>> in the documentation bug http://bugs.cloudstack.org/browse/CS-12742,
>>>"API
>>> docs: Better describe parameters." I filed this bug myself last
>>>January.
>>> I'm sad to say the existing CloudStack tech writing team does not have
>>> enough resources to address it.
>>> 
>>> Community contribution might be a good way to incrementally improve
>>>these
>>> descriptions. As you use the API, you will find out more about the
>>>calls
>>> you are using. This could be a good time to write those answers down
>>>for
>>> the next person.
>>> 
>>> The API reference docs are implemented as annotations in the code. I'd
>>>be
>>> interested to hear from the community on this: do you feel you can
>>> understand how to update these annotations just by looking at the code?
>>>Or
>>> would a wiki page on "how to edit the API reference annotations" be
>>>helpful?
>>> 
>>>  Jessica T.
>>> 
>>> CloudStack Tech Pubs
>>
>>>> I think a wiki page explaining the annotation and how to use it will
>>>> be quite helpful. I would be happy to send in patches with the
>>>> corrections for the API.
>>
>>-- 
>>>> Prasanna.,
>>
>>+1 
>>
>>
>>Deepak Garg
>>
>
>
>



Mime
View raw message