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: [ACS41] API Compatibility Bug?
Date Thu, 18 Apr 2013 17:18:28 GMT
I've just looked at 4.0 code for addTrafficMonitorCmd.java API command, it
had a bug. The "responseOjbect" annotation has incorrect value -
ExternalFirewallResponse. And as API doc writer relies on this info for
the doc generation, it was generated the wrong way.

4.0:

@Implementation(description="Adds Traffic Monitor Host for Direct Network
Usage", responseObject = ExternalFirewallResponse.class)


It was fixed in 4.1 - now response object refers to correct class -
"TrafficMonitorResponse":

@APICommand(name = "addTrafficMonitor", description="Adds Traffic Monitor
Host for Direct Network Usage", responseObject =
TrafficMonitorResponse.class)


The same issue for DeleteUser. Basically there are no changes in the
commands, they were just documented wrong in 4.0.


-Alena.




On 4/18/13 10:03 AM, "David Nalley" <david@gnsa.us> wrote:

>On Thu, Apr 18, 2013 at 1:01 PM, Min Chen <min.chen@citrix.com> wrote:
>
>I am not quite familiar with this. Alena, are you able to chip in to take
>a look? As far as code and functionality is concerned, I don't see API
>compatibility issue here.
>
>Thanks
>-min
>
>
>
>
>
>
>
>There are two potential problems (we're discussing the repercussions in
>IRC atm) 
>
>
>First is that if the API docs are reporting a change, then we have errant
>API docs - which is a big problem IMO.
>The second is that the tools we use to find changes have problems, which
>is less of a problem, but also means that we can't track changes
>accurately for documentation purposes.
>
>
>--David 
>
>
>
>
>



Mime
View raw message