CLOUDSTACK-1544 updated API documentation on deleteUser command; fixed API and id parameter descriptions; fixed responseObject doc designation
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/cd70c8d0 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/cd70c8d0 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/cd70c8d0 Branch: refs/heads/ui-ntier2 Commit: cd70c8d03f7a7150a29505efb79244da999c3c54 Parents: 67f87fe Author: David Grizzanti <[email protected]> Authored: Tue Mar 12 11:31:06 2013 -0400 Committer: Chip Childers <[email protected]> Committed: Tue Mar 12 13:54:33 2013 -0400 ---------------------------------------------------------------------- .../api/command/admin/user/DeleteUserCmd.java | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/cd70c8d0/api/src/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java ---------------------------------------------------------------------- diff --git a/api/src/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java b/api/src/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java index bb37d08..5683d58 100644 --- a/api/src/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java +++ b/api/src/org/apache/cloudstack/api/command/admin/user/DeleteUserCmd.java @@ -33,7 +33,7 @@ import com.cloud.user.Account; import com.cloud.user.User; import com.cloud.user.UserContext; -@APICommand(name = "deleteUser", description="Creates a user for an account", responseObject=UserResponse.class) +@APICommand(name = "deleteUser", description="Deletes a user for an account", responseObject=SuccessResponse.class) public class DeleteUserCmd extends BaseCmd { public static final Logger s_logger = Logger.getLogger(DeleteUserCmd.class.getName()); @@ -42,7 +42,7 @@ public class DeleteUserCmd extends BaseCmd { ///////////////////////////////////////////////////// //////////////// API parameters ///////////////////// ///////////////////////////////////////////////////// - @Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserResponse.class, required=true, description="Deletes a user") + @Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType=UserResponse.class, required=true, description="id of the user to be deleted") private Long id; @Inject RegionService _regionService;
