update python method documentation

samples/client/petstore/python/SwaggerPetstore-python/SwaggerPetstore/pet_api.py

@@ -35,13 +35,12 @@ class PetApi(object):
     
     def update_pet(self, **kwargs):
         """Update an existing pet
+        
 
         Args:
-            
             body, Pet: Pet object that needs to be added to the store (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -94,13 +93,12 @@ class PetApi(object):
     
     def add_pet(self, **kwargs):
         """Add a new pet to the store
+        
 
         Args:
-            
             body, Pet: Pet object that needs to be added to the store (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -153,13 +151,12 @@ class PetApi(object):
     
     def find_pets_by_status(self, **kwargs):
         """Finds Pets by status
+        Multiple status values can be provided with comma seperated strings
 
         Args:
-            
             status, list[str]: Status values that need to be considered for filter (required)
             
-            
-        
+
         Returns: list[Pet]
         """
 
@@ -218,13 +215,12 @@ class PetApi(object):
     
     def find_pets_by_tags(self, **kwargs):
         """Finds Pets by tags
+        Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
 
         Args:
-            
             tags, list[str]: Tags to filter by (required)
             
-            
-        
+
         Returns: list[Pet]
         """
 
@@ -283,13 +279,12 @@ class PetApi(object):
     
     def get_pet_by_id(self, **kwargs):
         """Find pet by ID
+        Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error conditions
 
         Args:
-            
             pet_id, long: ID of pet that needs to be fetched (required)
             
-            
-        
+
         Returns: Pet
         """
 
@@ -351,19 +346,14 @@ class PetApi(object):
     
     def update_pet_with_form(self, **kwargs):
         """Updates a pet in the store with form data
+        
 
         Args:
-            
             pet_id, str: ID of pet that needs to be updated (required)
-            
-            
             name, str: Updated name of the pet (required)
-            
-            
             status, str: Updated status of the pet (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -425,16 +415,13 @@ class PetApi(object):
     
     def delete_pet(self, **kwargs):
         """Deletes a pet
+        
 
         Args:
-            
             api_key, str:  (required)
-            
-            
             pet_id, long: Pet id to delete (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -493,19 +480,14 @@ class PetApi(object):
     
     def upload_file(self, **kwargs):
         """uploads an image
+        
 
         Args:
-            
             pet_id, long: ID of pet to update (required)
-            
-            
             additional_metadata, str: Additional data to pass to server (required)
-            
-            
             file, file: file to upload (required)
             
-            
-        
+
         Returns: 
         """
 

samples/client/petstore/python/SwaggerPetstore-python/SwaggerPetstore/store_api.py

@@ -35,10 +35,11 @@ class StoreApi(object):
     
     def get_inventory(self, **kwargs):
         """Returns pet inventories by status
+        Returns a map of status codes to quantities
 
         Args:
             
-        
+
         Returns: map(String, int)
         """
 
@@ -94,13 +95,12 @@ class StoreApi(object):
     
     def place_order(self, **kwargs):
         """Place an order for a pet
+        
 
         Args:
-            
             body, Order: order placed for purchasing the pet (required)
             
-            
-        
+
         Returns: Order
         """
 
@@ -159,13 +159,12 @@ class StoreApi(object):
     
     def get_order_by_id(self, **kwargs):
         """Find purchase order by ID
+        For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
 
         Args:
-            
             order_id, str: ID of pet that needs to be fetched (required)
             
-            
-        
+
         Returns: Order
         """
 
@@ -227,13 +226,12 @@ class StoreApi(object):
     
     def delete_order(self, **kwargs):
         """Delete purchase order by ID
+        For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
 
         Args:
-            
             order_id, str: ID of the order that needs to be deleted (required)
             
-            
-        
+
         Returns: 
         """
 

samples/client/petstore/python/SwaggerPetstore-python/SwaggerPetstore/user_api.py

@@ -35,13 +35,12 @@ class UserApi(object):
     
     def create_user(self, **kwargs):
         """Create user
+        This can only be done by the logged in user.
 
         Args:
-            
             body, User: Created user object (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -94,13 +93,12 @@ class UserApi(object):
     
     def create_users_with_array_input(self, **kwargs):
         """Creates list of users with given input array
+        
 
         Args:
-            
             body, list[User]: List of user object (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -153,13 +151,12 @@ class UserApi(object):
     
     def create_users_with_list_input(self, **kwargs):
         """Creates list of users with given input array
+        
 
         Args:
-            
             body, list[User]: List of user object (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -212,16 +209,13 @@ class UserApi(object):
     
     def login_user(self, **kwargs):
         """Logs user into the system
+        
 
         Args:
-            
             username, str: The user name for login (required)
-            
-            
             password, str: The password for login in clear text (required)
             
-            
-        
+
         Returns: str
         """
 
@@ -283,10 +277,11 @@ class UserApi(object):
     
     def logout_user(self, **kwargs):
         """Logs out current logged in user session
+        
 
         Args:
             
-        
+
         Returns: 
         """
 
@@ -336,13 +331,12 @@ class UserApi(object):
     
     def get_user_by_name(self, **kwargs):
         """Get user by user name
+        
 
         Args:
-            
             username, str: The name that needs to be fetched. Use user1 for testing.  (required)
             
-            
-        
+
         Returns: User
         """
 
@@ -404,16 +398,13 @@ class UserApi(object):
     
     def update_user(self, **kwargs):
         """Updated user
+        This can only be done by the logged in user.
 
         Args:
-            
             username, str: name that need to be deleted (required)
-            
-            
             body, User: Updated user object (required)
             
-            
-        
+
         Returns: 
         """
 
@@ -472,13 +463,12 @@ class UserApi(object):
     
     def delete_user(self, **kwargs):
         """Delete user
+        This can only be done by the logged in user.
 
         Args:
-            
             username, str: The name that needs to be deleted (required)
             
-            
-        
+
         Returns: 
         """