incubator-cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From chipchild...@apache.org
Subject git commit: refs/heads/master - CLOUDSTACK-94: API command, listIsos documentation clarity
Date Mon, 11 Mar 2013 16:25:01 GMT
Updated Branches:
  refs/heads/master e173aa16f -> 85e9d63be


CLOUDSTACK-94: API command, listIsos documentation clarity

Updated API documentation for listIsos command.

Descriptions for id and isofilter descriptions clarified:
- Updated isofilter description with all options and verbiage taken from VirtualMachineTemplate
class
- Updated id description

Signed-off-by: Chip Childers <chip.childers@gmail.com>


Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/85e9d63b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/85e9d63b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/85e9d63b

Branch: refs/heads/master
Commit: 85e9d63be4d7c275dedd773c63a6aca0cde03356
Parents: e173aa1
Author: David Grizzanti <david.grizzanti@sungard.com>
Authored: Mon Mar 11 12:24:32 2013 -0400
Committer: Chip Childers <chip.childers@gmail.com>
Committed: Mon Mar 11 12:24:32 2013 -0400

----------------------------------------------------------------------
 .../api/command/user/iso/ListIsosCmd.java          |   15 +++++++++------
 1 files changed, 9 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/85e9d63b/api/src/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
----------------------------------------------------------------------
diff --git a/api/src/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java b/api/src/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
index 1824612..3219601 100644
--- a/api/src/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
+++ b/api/src/org/apache/cloudstack/api/command/user/iso/ListIsosCmd.java
@@ -52,7 +52,7 @@ public class ListIsosCmd extends BaseListTaggedResourcesCmd {
     private String hypervisor;
 
     @Parameter(name=ApiConstants.ID, type=CommandType.UUID, entityType = TemplateResponse.class,
-            description="list all isos by id")
+            description="list ISO by id")
     private Long id;
 
     @Parameter(name=ApiConstants.IS_PUBLIC, type=CommandType.BOOLEAN, description="true if
the ISO is publicly available to all users, false otherwise.")
@@ -61,11 +61,14 @@ public class ListIsosCmd extends BaseListTaggedResourcesCmd {
     @Parameter(name=ApiConstants.IS_READY, type=CommandType.BOOLEAN, description="true if
this ISO is ready to be deployed")
     private Boolean ready;
 
-    @Parameter(name=ApiConstants.ISO_FILTER, type=CommandType.STRING, description="possible
values are \"featured\", \"self\", \"self-executable\",\"executable\", and \"community\".
" +
-                                                            "* featured-ISOs that are featured
and are publicself-ISOs that have been registered/created by the owner. " +
-                                                            "* selfexecutable-ISOs that have
been registered/created by the owner that can be used to deploy a new VM. " +
-                                                            "* executable-all ISOs that can
be used to deploy a new VM " +
-                                                            "* community-ISOs that are public.")
+    @Parameter(name=ApiConstants.ISO_FILTER, type=CommandType.STRING, description="possible
values are \"featured\", \"self\", \"selfexecutable\",\"sharedexecutable\",\"executable\",
and \"community\". " +
+                                                             "* featured : templates that
have been marked as featured and public. " +
+                                                             "* self : templates that have
been registered or created by the calling user. " +
+                                                             "* selfexecutable : same as
self, but only returns templates that can be used to deploy a new VM. " +
+                                                             "* sharedexecutable : templates
ready to be deployed that have been granted to the calling user by another user. " +
+                                                             "* executable : templates that
are owned by the calling user, or public templates, that can be used to deploy a VM. " +
+                                                             "* community : templates that
have been marked as public but not featured. " +
+                                                             "* all : all templates (only
usable by admins).")
     private String isoFilter = TemplateFilter.selfexecutable.toString();
 
     @Parameter(name=ApiConstants.NAME, type=CommandType.STRING, description="list all isos
by name")


Mime
View raw message