cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Nitin Mehta <Nitin.Me...@citrix.com>
Subject Re: API naming conventions
Date Tue, 16 Apr 2013 10:40:44 GMT
+1 to this, but I guess this should be a subsection of a wiki called
"Adding a new api in Cloudstack - What all should I do ?"

Some of the subsections in it should be like (each with an example) :-

API naming conventions
Should the api be sync, async or asynccreate and what class should it
extend

API annotations and what they mean. Discuss ACL and parameters. Events to
write.
What to put in the API layer, manager layer, hypervisor layer
API Response - should I create a view (in case its a list command)
Testing expectations - Adding marvin tests

I guess this would be very useful to the devs, guys trying to understand
the flow. So lets create one consolidated wiki and add these subsections.

Thanks,
-Nitin

On 16/04/13 1:31 PM, "Prasanna Santhanam" <tsp@apache.org> wrote:

>Is there a formal document somewhere describing the naming conventions
>for our APIs? If not is it worthwhile starting one?
>
>The document should describe:
>1. valid action (verbs) to operate on an entity
>2. entity being the desired resource, physical device, cloudstack
>account etc.
>3. what semantics an update API can take and what a configure API can
>take etc.
>
>Thanks,
>
>-- 
>Prasanna.,


Mime
View raw message