update ruby doc

Author: wing328

modules/swagger-codegen/src/main/resources/ruby/api.mustache

@@ -9,12 +9,17 @@ class {{classname}}
     URI.encode(string.to_s)
   end
 
-  {{#operation}}
+{{#operation}}
+{{newline}}
+  # {{summary}}
+  # {{notes}}{{newLine}}
+{{#allParams}}{{^optional}}{{newLine}}  # @param {{paramName}} {{description}}
+{{/optional}}{{/allParams}}{{#allParams}}{{#optional}}{{newLine}}  # @option opts [{{dataType}}] :{{baseName}} {{description}}
+{{/optional}}{{/allParams}}  # @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}{{newLine}}
   def self.{{nickname}} ({{#allParams}}{{paramName}}{{#defaultValue}} = {{{defaultValue}}}{{/defaultValue}},{{/allParams}} opts={})
     query_param_keys = [{{#queryParams}}:{{paramName}}{{#hasMore}},{{/hasMore}}{{/queryParams}}]
 
     {{#requiredParamCount}}
-    
     # verify existence of params
     {{#requiredParams}}
     raise "{{{paramName}}} is required" if {{{paramName}}}.nil?
@@ -40,7 +45,6 @@ class {{classname}}
     headers = {}
     {{#headerParams}}{{#optional}}headers[:'{{{baseName}}}'] = options[:'{{{paramName}}}'] if options[:'{{{paramName}}}']{{/optional}}{{/headerParams}}
     {{#headerParams}}{{^optional}}headers[:'{{{baseName}}}'] = {{{paramName}}}{{/optional}}{{/headerParams}}
-
     # http body (model)
     post_body = nil
     {{#bodyParam}}
@@ -55,7 +59,6 @@ class {{classname}}
           end
         end
         post_body = array
-
       else 
         if body.respond_to?("to_body".to_sym)
 	        post_body = body.to_body
@@ -65,12 +68,10 @@ class {{classname}}
       end
     end
     {{/bodyParam}}
-
     # form parameters
     form_parameter_hash = {}
     {{#formParams}}{{#optional}}form_parameter_hash["{{baseName}}"] = options[:'{{paramName}}'] if options[:'{{paramName}}']{{/optional}}
     {{^optional}}form_parameter_hash["{{baseName}}"] = {{paramName}}{{/optional}}{{/formParams}}
-
     {{#returnType}}
     response = Swagger::Request.new(:{{httpMethod}}, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make.body
     {{#returnContainer}}
@@ -81,7 +82,6 @@ class {{classname}}
     {{/returnType}}
   {{newline}}
   end
-
 {{/operation}}
 end
 {{/operations}}

samples/client/petstore/ruby/lib/pet_api.rb

@@ -8,7 +8,11 @@ def self.escapeString(string)
     URI.encode(string.to_s)
   end
 
-  
+
+  # Update an existing pet
+  # 
+  # @param body Pet object that needs to be added to the store
+  # @return void
   def self.updatePet (body, opts={})
     query_param_keys = []
 
@@ -32,7 +36,6 @@ def self.updatePet (body, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
@@ -47,7 +50,6 @@ def self.updatePet (body, opts={})
           end
         end
         post_body = array
-
       else 
         if body.respond_to?("to_body".to_sym)
 	        post_body = body.to_body
@@ -57,19 +59,20 @@ def self.updatePet (body, opts={})
       end
     end
 
-
     # form parameters
     form_parameter_hash = {}
 
-
 
 
     Swagger::Request.new(:PUT, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
 
 
   end
 
-
+  # Add a new pet to the store
+  # 
+  # @param body Pet object that needs to be added to the store
+  # @return void
   def self.addPet (body, opts={})
     query_param_keys = []
 
@@ -93,7 +96,6 @@ def self.addPet (body, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
@@ -108,7 +110,6 @@ def self.addPet (body, opts={})
           end
         end
         post_body = array
-
       else 
         if body.respond_to?("to_body".to_sym)
 	        post_body = body.to_body
@@ -118,19 +119,20 @@ def self.addPet (body, opts={})
       end
     end
 
-
     # form parameters
     form_parameter_hash = {}
 
-
 
 
     Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
 
 
   end
 
-
+  # Finds Pets by status
+  # Multiple status values can be provided with comma seperated strings
+  # @param status Status values that need to be considered for filter
+  # @return array[Pet]
   def self.findPetsByStatus (status, opts={})
     query_param_keys = [:status]
 
@@ -154,15 +156,12 @@ def self.findPetsByStatus (status, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
-
     # form parameters
     form_parameter_hash = {}
 
-
 
     response = Swagger::Request.new(:GET, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make.body
 
@@ -172,7 +171,10 @@ def self.findPetsByStatus (status, opts={})
 
   end
 
-
+  # Finds Pets by tags
+  # Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
+  # @param tags Tags to filter by
+  # @return array[Pet]
   def self.findPetsByTags (tags, opts={})
     query_param_keys = [:tags]
 
@@ -196,15 +198,12 @@ def self.findPetsByTags (tags, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
-
     # form parameters
     form_parameter_hash = {}
 
-
 
     response = Swagger::Request.new(:GET, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make.body
 
@@ -214,7 +213,10 @@ def self.findPetsByTags (tags, opts={})
 
   end
 
-
+  # Find pet by ID
+  # Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
+  # @param pet_id ID of pet that needs to be fetched
+  # @return Pet
   def self.getPetById (pet_id, opts={})
     query_param_keys = []
 
@@ -239,15 +241,12 @@ def self.getPetById (pet_id, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
-
     # form parameters
     form_parameter_hash = {}
 
-
 
     response = Swagger::Request.new(:GET, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make.body
      Pet.new(response)
@@ -256,7 +255,12 @@ def self.getPetById (pet_id, opts={})
 
   end
 
-
+  # Updates a pet in the store with form data
+  # 
+  # @param pet_id ID of pet that needs to be updated
+  # @param name Updated name of the pet
+  # @param status Updated status of the pet
+  # @return void
   def self.updatePetWithForm (pet_id,name,status, opts={})
     query_param_keys = []
 
@@ -283,25 +287,26 @@ def self.updatePetWithForm (pet_id,name,status, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
-
     # form parameters
     form_parameter_hash = {}
 
     form_parameter_hash["name"] = name
     form_parameter_hash["status"] = status
-
 
 
     Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
 
 
   end
 
-
+  # Deletes a pet
+  # 
+  # @param api_key 
+  # @param pet_id Pet id to delete
+  # @return void
   def self.deletePet (api_key,pet_id, opts={})
     query_param_keys = []
 
@@ -327,23 +332,25 @@ def self.deletePet (api_key,pet_id, opts={})
     headers = {}
 
     headers[:'api_key'] = api_key
-
     # http body (model)
     post_body = nil
 
-
     # form parameters
     form_parameter_hash = {}
 
-
 
 
     Swagger::Request.new(:DELETE, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
 
 
   end
 
-
+  # uploads an image
+  # 
+  # @param pet_id ID of pet to update
+  # @param additional_metadata Additional data to pass to server
+  # @param file file to upload
+  # @return void
   def self.uploadFile (pet_id,additional_metadata,file, opts={})
     query_param_keys = []
 
@@ -370,22 +377,18 @@ def self.uploadFile (pet_id,additional_metadata,file, opts={})
     headers = {}
 
 
-
     # http body (model)
     post_body = nil
 
-
     # form parameters
     form_parameter_hash = {}
 
     form_parameter_hash["additionalMetadata"] = additional_metadata
     form_parameter_hash["file"] = file
-
 
 
     Swagger::Request.new(:POST, path, {:params=>queryopts,:headers=>headers, :body=>post_body, :form_params => form_parameter_hash }).make
 
 
   end
-
 end