Updating API parameter documentation (refs #1901)

[arvados.git] / sdk / cli / bin / arv

diff --git a/sdk/cli/bin/arv b/sdk/cli/bin/arv
index 3fd3c57f07a679dfc024905cf3d2bb154c7324fa..b133a7783d4beb35afa310a1a2c169b323c6834f 100755 (executable)
--- a/sdk/cli/bin/arv
+++ b/sdk/cli/bin/arv
@@ -152,7 +152,10 @@ def help_methods(discovery_document, resource, method=nil)
   discovery_document["resources"][resource.pluralize]["methods"].
     each do |k,v|
     description = ''
-    description = '  ' + v["description"] if v.include?("description")
+    if v.include? "description"
+      # add only the first line of the discovery doc description
+      description = '  ' + v["description"].split("\n").first.chomp
+    end
     banner += "   #{sprintf("%20s",k)}#{description}\n"
   end
   banner += "\n"
@@ -171,9 +174,10 @@ def help_resources(discovery_document, resource)
   banner += "\n\n"
   discovery_document["resources"].each do |k,v|
     description = ''
-    if discovery_document["schemas"].include?(k.singularize.capitalize) and 
-        discovery_document["schemas"][k.singularize.capitalize].include?('description') then
-      description = '  ' + discovery_document["schemas"][k.singularize.capitalize]["description"]
+    resource_info = discovery_document["schemas"][k.singularize.capitalize]
+    if resource_info and resource_info.include?('description')
+      # add only the first line of the discovery doc description
+      description = '  ' + resource_info["description"].split("\n").first.chomp
     end
     banner += "   #{sprintf("%30s",k.singularize)}#{description}\n"
   end