From a8da46845dc72bd3a616dc968eb2a45e089f5881 Mon Sep 17 00:00:00 2001
From: abhishek <abhishek@cloud.com>
Date: Tue, 11 Jan 2011 10:45:40 -0800
Subject: [PATCH] adding some more descriptions, to be consumed by the xsl
 transformer

---
 .../RevokeSecurityGroupIngressCmd.java        | 30 +++++++------------
 .../api/response/IngressRuleResponse.java     |  6 ++--
 2 files changed, 12 insertions(+), 24 deletions(-)

diff --git a/api/src/com/cloud/api/commands/RevokeSecurityGroupIngressCmd.java b/api/src/com/cloud/api/commands/RevokeSecurityGroupIngressCmd.java
index 88e4b69b6a4..916a72153f1 100644
--- a/api/src/com/cloud/api/commands/RevokeSecurityGroupIngressCmd.java
+++ b/api/src/com/cloud/api/commands/RevokeSecurityGroupIngressCmd.java
@@ -29,44 +29,34 @@ public class RevokeSecurityGroupIngressCmd extends BaseAsyncCmd {
     //////////////// API parameters /////////////////////
     /////////////////////////////////////////////////////
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.ACCOUNT, type=CommandType.STRING)
+    @Parameter(name=ApiConstants.ACCOUNT, type=CommandType.STRING, description="an optional account for the security group. Must be used with domainId.")
     private String accountName;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.CIDR_LIST, type=CommandType.STRING)
+    @Parameter(name=ApiConstants.CIDR_LIST, type=CommandType.STRING, description="the cidr list associated")
     private String cidrList;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.DOMAIN_ID, type=CommandType.LONG)
+    @Parameter(name=ApiConstants.DOMAIN_ID, type=CommandType.LONG, description="an optional domainId for the security group. If the account parameter is used, domainId must also be used.")
     private Long domainId;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.END_PORT, type=CommandType.INTEGER)
+    @Parameter(name=ApiConstants.END_PORT, type=CommandType.INTEGER, description="end port for this ingress rule")
     private Integer endPort;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.ICMP_CODE, type=CommandType.INTEGER)
+    @Parameter(name=ApiConstants.ICMP_CODE, type=CommandType.INTEGER, description="error code for this icmp message")
     private Integer icmpCode;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.ICMP_TYPE, type=CommandType.INTEGER)
+    @Parameter(name=ApiConstants.ICMP_TYPE, type=CommandType.INTEGER, description="type for this icmp message")
     private Integer icmpType;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.SECURITY_GROUP_NAME, type=CommandType.STRING, required=true)
+    @Parameter(name=ApiConstants.SECURITY_GROUP_NAME, type=CommandType.STRING, required=true, description="name of the security group")
     private String securityGroupName;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.PROTOCOL, type=CommandType.STRING)
+    @Parameter(name=ApiConstants.PROTOCOL, type=CommandType.STRING, description="protocol used")
     private String protocol;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.START_PORT, type=CommandType.INTEGER)
+    @Parameter(name=ApiConstants.START_PORT, type=CommandType.INTEGER,description="start port for this ingress rule")
     private Integer startPort;
 
-    //FIXME - add description
-    @Parameter(name=ApiConstants.USER_SECURITY_GROUP_LIST, type=CommandType.MAP)
+    @Parameter(name=ApiConstants.USER_SECURITY_GROUP_LIST, type=CommandType.MAP, description="user to security group mapping")
     private Map userSecurityGroupList;
 
     /////////////////////////////////////////////////////
diff --git a/api/src/com/cloud/api/response/IngressRuleResponse.java b/api/src/com/cloud/api/response/IngressRuleResponse.java
index ed4bbc248d6..9fa12f3ee09 100644
--- a/api/src/com/cloud/api/response/IngressRuleResponse.java
+++ b/api/src/com/cloud/api/response/IngressRuleResponse.java
@@ -28,12 +28,10 @@ public class IngressRuleResponse extends BaseResponse {
     @SerializedName("protocol") @Param(description="the protocol of the ingress rule")
     private String protocol;
 
-    //FIXME - add description
-    @SerializedName(ApiConstants.ICMP_TYPE)
+    @SerializedName(ApiConstants.ICMP_TYPE) @Param(description="the type of the ICMP message response")
     private Integer icmpType;
 
-    //FIXME - add description
-    @SerializedName(ApiConstants.ICMP_CODE)
+    @SerializedName(ApiConstants.ICMP_CODE) @Param(description="the code for the ICMP message response")
     private Integer icmpCode;
 
     @SerializedName(ApiConstants.START_PORT) @Param(description="the starting IP of the ingress rule")