[
https://issues.apache.org/jira/browse/CLOUDSTACK-2091?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13635366#comment-13635366
]
Min Chen commented on CLOUDSTACK-2091:
--------------------------------------
4.0 API documentation is wrong due to wrong annotation used in 4.0 branch code.
In 4.0 branch, we have the following annotation for the above 3 cmds:
@Implementation(description="Creates a user for an account",
responseObject=UserResponse.class)
public class DeleteUserCmd extends BaseCmd
@Implementation(description="Adds Traffic Monitor Host for Direct Network
Usage", responseObject = ExternalFirewallResponse.class)
public class AddTrafficMonitorCmd extends BaseCmd {
@Implementation(description="List traffic monitor Hosts.", responseObject =
ExternalFirewallResponse.class)
public class ListTrafficMonitorsCmd extends BaseListCmd {
As you can see, the annotation "responseObject" for the above 3 APIs are all
wrong, they should be SuccessResponse, TrafficMonitorResponse,
TrafficMonitorResponse, respectively. Since API doc is purely dependent on
these annotations, api doc html becomes mistaken as well. In API refactoring
effort, we cleaned up these mistakes and made our API doc more accurate. So
this is not a bug for 4.1.
> API Removed Response Parameters for deleteUser, addTrafficMonitor,
> listTrafficMonitors
> --------------------------------------------------------------------------------------
>
> Key: CLOUDSTACK-2091
> URL: https://issues.apache.org/jira/browse/CLOUDSTACK-2091
> Project: CloudStack
> Issue Type: Bug
> Security Level: Public(Anyone can view this level - this is the
> default.)
> Components: API
> Affects Versions: 4.1.0
> Reporter: Joe Brockmeier
> Assignee: Min Chen
> Priority: Blocker
> Fix For: 4.1.0
>
>
> It looks like the response parameters have changed for three API commands in
> 4.1.0. The following response parameters are not being documented as part of
> the response objects for these calls:
> - deleteUser: id, account, accountid, accounttype, apikey, created, domain,
> domainid, email, firstname, lastname, secretkey, state, timezone, username
> - addTrafficMonitor: privateinterface, privatezone, publicinterface,
> publiczone, usageinterface, username
> - listTrafficMonitor: privateinterface, privatezone, publicinterface,
> publiczone, usageinterface, username
> Is this acceptable? My understanding was that the API shouldn't change in
> terms of removing expected parameters between 4.x releases.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira
