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
+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
+, Nitin Mehta wrote:
> +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 t
esday, April 16, 2013 4:34 PM
> To: dev@cloudstack.apache.org
> Subject: Re: API naming conventions
>
> Oh that's more than I intend to chew :)
>
> I only want the APIs to have some defined pattern - naming and semantics.
> This if from a integration perspective than fr
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 asynccr
On Tue, Apr 16, 2013 at 06:02:43PM +0530, Rohit Yadav wrote:
> Use what we have been using so far:
>
> API := :
>
> lowecase action :=
> CamelCaseSubjects :=
>
> So, based on such rule; the following makes sense:
> - configLdap
>
> About subjects, think what the API is trying to do. For examp
