suggestgrid 0.1.30 → 0.1.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a511c55944959fd302cda98f0de49a47b7e2fc0
-  data.tar.gz: c07cb656d5bbd87b4ec356c49acea5731381f8b5
+  metadata.gz: b3211855090c4d1f0fb3d12de89a3884a3dd8ec4
+  data.tar.gz: bad7b0fab8fb56452ae55a707db241d225326c63
 SHA512:
-  metadata.gz: 9c8585d8f20f804af0b04d49e36f03f88529983ae0f97f147acc9fbeda9d85064c64b65285b4648cf16b0a93e7aba2606ce84b1511164a30fdd983759fa50b15
-  data.tar.gz: ecd0386e2c43a5ae9f76a79ee0a6a7b354918baf5c34b23986578b1b0b4ff364a5f75cee958f1f09178bfd0662ec28e31a7c373415f7d0e4afaac81b6da53747
+  metadata.gz: a67609fa929ffd16e75f02820bb34af69e844ac6f1ebda4b2fc825de699d19319b8058e0a139f20446d1ce0e6f0b051e514be3663e725f6fb0c6d510549f1f77
+  data.tar.gz: d14ea8c2e786c8edc82ae83ad7eae8eeb8ea655786ed71d27762e1dd428c2b080f7f09a1c0562dd339fba0ff3335496964ac391c9ce9cdcd9d76e69c97220357

data/README.md

@@ -8,8 +8,6 @@ We will walk through how to get started with SuggestGrid Ruby Client in three st
     
 3. [Get recommendations](#3-get-recommendations)
 
-If you did not [sign up for SuggestGrid](https://dashboard.suggestgrid.com/users/sign_up), this is the right time.
-
 ## Getting Started
 
 In this guide we will demonstrate how to display personalized recommendations on an existing Ruby project.
@@ -28,23 +26,16 @@ gem 'suggestgrid'
 
 
 
-Applications make their API requests to their dedicated sub-domain of `suggestgrid.space`.
-
-Most endpoints require a username and password for authentication.
-
-An initial user name and password is given on sign up.
-
-It is very convenient to configure SuggestGrid by setting an authenticated `SUGGESTGRID_URL` environment variable in the format below:
+Once you [sign up for SuggestGrid](https://dashboard.suggestgrid.com/users/sign_up), you'll see your SUGGESTGRID_URL parameter on the dashboard in the format below:
 
 `http://{user}:{pass}@{region}.suggestgrid.space/{app-uuid}`
 
 You can authenticate your application using `SUGGESTGRID_URL` environment variable like the example below:
 
 ```ruby
-sg_uri = ENV['SUGGESTGRID_URL']
+require 'suggest_grid'
 
-# Initialize the SuggestGrid client.
-::SuggestGridClient = SuggestGrid::SuggestGridClient.new sg_uri
+SuggestGridClient = SuggestGrid::SuggestGridClient.new ENV['SUGGESTGRID_URL']
 ```
 
 
@@ -54,11 +45,11 @@ This could be done either from the dashboard or with a snippet like this:
 
 ```ruby
   begin
-    SuggestGridClient.type.get_type('views')
-    puts "SuggestGrid type named 'views' already exists, skipping creation."
+      SuggestGridClient.type.get_type('views')
+      puts "SuggestGrid type named 'views' already exists, skipping creation."
   rescue SuggestGrid::APIException => e
-    SuggestGridClient.type.create_type('views')
-    puts "SuggestGrid type named 'views' is created."
+      SuggestGridClient.type.create_type('views', {'rating': 'implicit'})
+      puts "Views SuggestGrid type is created."
   end
 ```
 
@@ -67,16 +58,16 @@ This could be done either from the dashboard or with a snippet like this:
 ### 2. Post actions
 
 Once the type exists, let's start posting actions.
-We should invoke SuggestGrid client's action.post_action when an user views an item in our application.
+We should invoke SuggestGrid client's SuggestGridClient.action.post_action when an user views an item in our application.
 
 We can do this by putting the snippet below on the relevant point:
 
 ```ruby
 # Send action to SuggestGrid.
 begin
-  SuggestGridClient.action.post_action(SuggestGrid::Action.new('views',user.id, self.id))
+    SuggestGridClient.action.post_action(SuggestGrid::Action.new('views',user.id, self.id))
 rescue Exception => e
-  puts "Exception while sending action #{e}"
+    puts "Exception while sending action #{e}"
 end
 ```
 
@@ -96,9 +87,9 @@ Once the first model generated for 'views' type, recommendations could be get us
 
 ```ruby
 begin
-  items_response = SuggestGridClient.recommendation.get_recommended_items({type: 'view', user_id: user.id, size: size})
-  items_response.items
+    items_response = SuggestGridClient.recommendation.get_recommended_items({'type': 'view', 'user_id': user.id, 'size': size})
+    items_response.items
 rescue Exception => e
-  puts "Exception while getting recommendations #{e}"
+    puts "Exception while getting recommendations #{e}"
 end
 ```

data/lib/suggest_grid/controllers/action_controller.rb

@@ -8,7 +8,7 @@ module SuggestGrid
       @@instance
     end
 
-    # Post an Action
+    # Posts an Action
     # @param [Action] action Required parameter: The action to be posted.
     # @return MessageResponse response from the API call
     def post_action(action)
@@ -46,7 +46,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Post Bulk Actions
+    # Posts Actions
     # @param [Collection] actions Required parameter: List of actions to be posted.
     # @return BulkPostResponse response from the API call
     def post_bulk_actions(actions)
@@ -90,11 +90,11 @@ module SuggestGrid
       return BulkPostResponse.from_hash(decoded)
     end
 
-    # Get Actions
-    # @param [String] type Optional parameter: The type of the actions.
-    # @param [String] user_id Optional parameter: The user id of the actions.
-    # @param [String] item_id Optional parameter: The item id of the actions.
-    # @param [String] older_than Optional parameter: Maxium timestamp of the actions. Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
+    # Gets Actions
+    # @param [String] type Optional parameter: Get actions of a type.
+    # @param [String] user_id Optional parameter: Get actions of a user id.
+    # @param [String] item_id Optional parameter: Get actions of an item id.
+    # @param [String] older_than Optional parameter: Get actions older than the given duration, or the given time number. Could be a ISO 8601 duration, or a Unix time number. Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
     # @param [Long] size Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like "1".
     # @param [Long] from Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like "1".
     # @return ActionsResponse response from the API call
@@ -140,12 +140,12 @@ module SuggestGrid
     end
 
     # Delete Actions
-    # @param [String] type Optional parameter: The type of the actions.
-    # @param [String] user_id Optional parameter: The user id of the actions.
-    # @param [String] item_id Optional parameter: The item id of the actions.
-    # @param [String] older_than Optional parameter: Delete all actions of a type older than the given timestamp or time. Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
+    # @param [String] type Required parameter: Delete actions of a type. This parameter and at least one other parameter is required.
+    # @param [String] user_id Optional parameter: Delete actions of a user id.
+    # @param [String] item_id Optional parameter: Delete actions of an item id.
+    # @param [String] older_than Optional parameter: Delete actions older than the given duration, or the given time number. Could be a ISO 8601 duration, or a Unix time number. Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
     # @return DeleteSuccessResponse response from the API call
-    def delete_actions(type = nil,
+    def delete_actions(type,
                        user_id = nil,
                        item_id = nil,
                        older_than = nil)

data/lib/suggest_grid/controllers/metadata_controller.rb

@@ -8,7 +8,7 @@ module SuggestGrid
       @@instance
     end
 
-    # Post a User
+    # Posts a User
     # @param [Metadata] user Required parameter: The metadata to be saved. Metadata format has its restrictions.
     # @return MessageResponse response from the API call
     def post_user(user)
@@ -42,7 +42,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Post Bulk Users
+    # Posts Users
     # @param [Collection] users Required parameter: List of user metadata, whose size is limited to 10 thousand.
     # @return BulkPostResponse response from the API call
     def post_bulk_users(users)
@@ -82,8 +82,8 @@ module SuggestGrid
       return BulkPostResponse.from_hash(decoded)
     end
 
-    # Get A User
-    # @param [String] user_id Required parameter: The user id to delete its metadata.
+    # Gets A User
+    # @param [String] user_id Required parameter: The user id to get its metadata.
     # @return Metadata response from the API call
     def get_user(user_id)
 
@@ -118,7 +118,7 @@ module SuggestGrid
       return Metadata.from_hash(decoded)
     end
 
-    # Get Users
+    # Gets Users
     # @param [Long] size Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like "1".
     # @param [Long] from Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like "1".
     # @return UsersResponse response from the API call
@@ -155,7 +155,7 @@ module SuggestGrid
       return UsersResponse.from_hash(decoded)
     end
 
-    # Delete a User
+    # Deletes a User
     # @param [String] user_id Required parameter: The user id to delete its metadata.
     # @return MessageResponse response from the API call
     def delete_user(user_id)
@@ -189,7 +189,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Delete All Users
+    # Deletes All Users
     # @return MessageResponse response from the API call
     def delete_all_users
 
@@ -219,7 +219,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Post an Item
+    # Posts An Item
     # @param [Metadata] item Required parameter: The metadata to be saved. Metadata format has its restrictions.
     # @return MessageResponse response from the API call
     def post_item(item)
@@ -253,7 +253,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Post Bulk Items
+    # Posts Items
     # @param [Collection] items Required parameter: List of item metadata, whose size is limited to 10 thousand.
     # @return BulkPostResponse response from the API call
     def post_bulk_items(items)
@@ -293,8 +293,8 @@ module SuggestGrid
       return BulkPostResponse.from_hash(decoded)
     end
 
-    # Get An Item
-    # @param [String] item_id Required parameter: The item id to delete its metadata.
+    # Gets An Item
+    # @param [String] item_id Required parameter: The item id to get its metadata.
     # @return Metadata response from the API call
     def get_item(item_id)
 
@@ -329,7 +329,7 @@ module SuggestGrid
       return Metadata.from_hash(decoded)
     end
 
-    # Get Items
+    # Gets Items
     # @param [Long] size Optional parameter: The number of the users response. Defaults to 10. Must be between 1 and 10,000 inclusive. This parameter must be string represetation of an integer like "1".
     # @param [Long] from Optional parameter: The number of users to be skipped from the response. Defaults to 0. Must be bigger than or equal to 0. This parameter must be string represetation of an integer like "1".
     # @return ItemsResponse response from the API call
@@ -400,7 +400,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Delete All Items
+    # Deletes All Items
     # @return MessageResponse response from the API call
     def delete_all_items
 

data/lib/suggest_grid/controllers/recommendation_controller.rb

@@ -8,7 +8,7 @@ module SuggestGrid
       @@instance
     end
 
-    # Get Recommended Users
+    # Gets Recommended Users
     # @param [GetRecommendedUsersBody] query Required parameter: Query for recommended users.
     # @return UsersResponse response from the API call
     def get_recommended_users(query)
@@ -32,6 +32,8 @@ module SuggestGrid
       # validate response against endpoint and global error codes
       if _context.response.status_code == 400
         raise ErrorResponseException.new 'Request body is invalid.', _context
+      elsif _context.response.status_code == 404
+        raise ErrorResponseException.new 'At least one type in the request does not exist.', _context
       elsif _context.response.status_code == 422
         raise ErrorResponseException.new 'Required parameters are missing.', _context
       elsif !_context.response.status_code.between?(200, 208)
@@ -44,7 +46,7 @@ module SuggestGrid
       return UsersResponse.from_hash(decoded)
     end
 
-    # Get Recommended Items
+    # Gets Recommended Items
     # @param [GetRecommendedItemsBody] query Required parameter: Query for recommended items.
     # @return ItemsResponse response from the API call
     def get_recommended_items(query)
@@ -68,6 +70,8 @@ module SuggestGrid
       # validate response against endpoint and global error codes
       if _context.response.status_code == 400
         raise ErrorResponseException.new 'Request body is invalid.', _context
+      elsif _context.response.status_code == 404
+        raise ErrorResponseException.new 'At least one type in the request does not exist.', _context
       elsif _context.response.status_code == 422
         raise ErrorResponseException.new 'Required parameters are missing.', _context
       elsif !_context.response.status_code.between?(200, 208)

data/lib/suggest_grid/controllers/similarity_controller.rb

@@ -8,7 +8,7 @@ module SuggestGrid
       @@instance
     end
 
-    # Get Similar Users
+    # Gets Similar Users
     # @param [GetSimilarUsersBody] query Required parameter: Query for similar users.
     # @return UsersResponse response from the API call
     def get_similar_users(query)
@@ -32,6 +32,8 @@ module SuggestGrid
       # validate response against endpoint and global error codes
       if _context.response.status_code == 400
         raise ErrorResponseException.new 'Request body is invalid.', _context
+      elsif _context.response.status_code == 404
+        raise ErrorResponseException.new 'At least one type in the request does not exist.', _context
       elsif _context.response.status_code == 422
         raise ErrorResponseException.new 'Required parameters are missing.', _context
       elsif !_context.response.status_code.between?(200, 208)
@@ -44,7 +46,7 @@ module SuggestGrid
       return UsersResponse.from_hash(decoded)
     end
 
-    # Get Similar Items
+    # Gets Similar Items
     # @param [GetSimilarItemsBody] query Required parameter: Query for similar items.
     # @return ItemsResponse response from the API call
     def get_similar_items(query)
@@ -68,6 +70,8 @@ module SuggestGrid
       # validate response against endpoint and global error codes
       if _context.response.status_code == 400
         raise ErrorResponseException.new 'Request body is invalid.', _context
+      elsif _context.response.status_code == 404
+        raise ErrorResponseException.new 'At least one type in the request does not exist.', _context
       elsif _context.response.status_code == 422
         raise ErrorResponseException.new 'Required parameters are missing.', _context
       elsif !_context.response.status_code.between?(200, 208)

data/lib/suggest_grid/controllers/type_controller.rb

@@ -8,7 +8,7 @@ module SuggestGrid
       @@instance
     end
 
-    # Create a New Type
+    # Creates a Type
     # @param [String] type Required parameter: The name of the type.
     # @param [TypeRequestBody] settings Optional parameter: Optional settings for the rating parameter.
     # @return MessageResponse response from the API call
@@ -51,7 +51,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Get Properties of a Type
+    # Gets Properties of a Type
     # @param [String] type Required parameter: The name of the type to get properties.
     # @return GetTypeResponse response from the API call
     def get_type(type)
@@ -87,7 +87,7 @@ module SuggestGrid
       return GetTypeResponse.from_hash(decoded)
     end
 
-    # Delete a Type
+    # Deletes a Type
     # @param [String] type Required parameter: The name of the type to be deleted.
     # @return MessageResponse response from the API call
     def delete_type(type)
@@ -123,7 +123,7 @@ module SuggestGrid
       return MessageResponse.from_hash(decoded)
     end
 
-    # Get All Types
+    # Gets All Types
     # @return GetTypesResponse response from the API call
     def get_all_types
 
@@ -153,7 +153,7 @@ module SuggestGrid
       return GetTypesResponse.from_hash(decoded)
     end
 
-    # Delete All Types
+    # Deletes All Types
     # @return MessageResponse response from the API call
     def delete_all_types
 

data/lib/suggest_grid/exceptions/detailed_error_response_exception.rb

@@ -14,7 +14,7 @@ module SuggestGrid
     # @return [String]
     attr_accessor :error_uri
 
-    # Specific details of the response.
+    # Details of the response.
     # @return [String]
     attr_accessor :error_details
 

data/spec/swagger.yaml

@@ -1,8 +1,8 @@
 swagger: '2.0'
-
+# 
 info:
   title: SuggestGrid
-  version: 0.1.30
+  version: 0.1.31
   description: Personalization made Simple
   x-codegen-settings:
     appendContentHeaders: true
@@ -43,8 +43,8 @@ tags:
   - name: type
     description: Type Methods
     x-docs-text: |
-      Type methods are used for creating, inspecting, and deleting SuggestGrid types.
-      [Types documentation](http://www.suggestgrid.com/docs/types) is available for an overview.
+      Type methods are used for creating, getting, and deleting types.
+      Refer to [types](http://www.suggestgrid.com/docs/types) for an overview.
     x-methods:
       - create_type
       - get_type
@@ -54,8 +54,8 @@ tags:
   - name: action
     description: Action Methods
     x-docs-text: |
-      Action methods are for creating, inspecting, and deleting actions.
-      [Actions documentation](http://www.suggestgrid.com/docs/actions) is available for an overview.
+      Action methods are for creating, getting, and deleting actions.
+      Refer to [actions](http://www.suggestgrid.com/docs/actions) for an overview.
     x-methods:
       - post_action
       - post_bulk_actions
@@ -64,8 +64,8 @@ tags:
   - name: metadata
     description: Metadata Methods
     x-docs-text: |
-      Metadata methods are for creating, inspecting, and deleting metadata.
-      [Metadata documentation ](http://www.suggestgrid.com/docs/metadata) is available for an overview.
+      Metadata methods are for creating, getting, and deleting user, and item metadata.
+      Refer to [metadata](http://www.suggestgrid.com/docs/metadata) for an overview.
     x-methods:
       - post_user
       - post_bulk_users
@@ -82,16 +82,16 @@ tags:
   - name: recommendation
     description: Recommnedation Methods
     x-docs-text: |
-      Recommnedation methods are for getting recommended items, or recommended users from SuggestGrid.
-      [Recommendations documentation](http://www.suggestgrid.com/docs/recommendations) is available for an overview.
+      Recommnedation methods are for getting recommended items for users, or recommended users for items.
+      Refer to [recommendations](http://www.suggestgrid.com/docs/recommendations) for an overview.
     x-methods:
       - get_recommended_users
       - get_recommended_items
   - name: similarity
     description: Similarity Methods
     x-docs-text: |
-      Similarity methods are for getting similar items, or similar users from SuggestGrid.
-      [Similarities documentation](http://www.suggestgrid.com/docs/similarities) is available for an overview.
+      Similarity methods are for getting similar items, or similar users.
+      Refer to [similarities](http://www.suggestgrid.com/docs/similarities) for an overview.
     x-methods:
       - get_similar_users
       - get_similar_items
@@ -329,7 +329,7 @@ definitions:
   # Responses
   MessageResponse:
     type: object
-    description: A basic response.
+    description: Basic response with a message for success responses.
     properties:
       message:
         type: string
@@ -378,7 +378,7 @@ definitions:
         description: The URI of the error for more details.
       error_details:
         type: string
-        description: Specific details of the response.
+        description: Details of the response.
   LimitExceededErrorResponse:
     type: object
     description: Error response.
@@ -526,7 +526,7 @@ paths:
       tags:
         - type
       operationId: get_all_types
-      summary: Get All Types
+      summary: Gets All Types
       description: Returns all type names in an array named types.
       responses:
         200:
@@ -541,7 +541,7 @@ paths:
       tags:
         - type
       operationId: delete_all_types
-      summary: Delete All Types
+      summary: Deletes All Types
       description: Deletes ALL the types and ALL the actions.
       responses:
         200:
@@ -557,7 +557,7 @@ paths:
       tags:
         - type
       operationId: get_type
-      summary: Get Properties of a Type
+      summary: Gets Properties of a Type
       description: Returns the options of a type. The response rating parameter.
       parameters:
         - name: type
@@ -583,7 +583,7 @@ paths:
       tags:
         - type
       operationId: create_type
-      summary: Create a New Type
+      summary: Creates a Type
       description: Creates a new type.
       parameters:
         - name: type
@@ -623,7 +623,7 @@ paths:
       tags:
         - type
       operationId: delete_type
-      summary: Delete a Type
+      summary: Deletes a Type
       description: |
         Warning: Deletes the type with all of its actions and its recommendation model.
       parameters:
@@ -652,7 +652,7 @@ paths:
       tags:
         - action
       operationId: post_action
-      summary: Post an Action
+      summary: Posts an Action
       description: |
         Posts an action to the given type in the body.
         The body must have user id, item id and type.
@@ -689,7 +689,7 @@ paths:
       tags:
         - action
       operationId: get_actions
-      summary: Get Actions
+      summary: Gets Actions
       description: |
         Get actions. Defaut responses will be paged by 10 actios each.
         Type, user id, item id, or older than parameters could be provided.
@@ -697,27 +697,28 @@ paths:
       parameters:
         - name: type
           in: query
-          description: The type of the actions.
+          description: Get actions of a type.
           required: false
           type: string
           format: id
         - name: user_id
           in: query
-          description: The user id of the actions.
+          description: Get actions of a user id.
           required: false
           type: string
           format: id
         - name: item_id
           in: query
-          description: The item id of the actions.
+          description: Get actions of an item id.
           required: false
           type: string
           format: id
         - name: older_than
           in: query
           description: |
-            Maxium timestamp of the actions.
-            Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
+            Get actions older than the given duration, or the given time number.
+            Could be a ISO 8601 duration, or a Unix time number.
+            Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
           required: false
           type: string
         - name: size
@@ -764,27 +765,28 @@ paths:
       parameters:
         - name: type
           in: query
-          description: The type of the actions.
-          required: false
+          description: Delete actions of a type. This parameter and at least one other parameter is required.
+          required: true
           type: string
           format: id
         - name: user_id
           in: query
-          description: The user id of the actions.
+          description: Delete actions of a user id.
           required: false
           type: string
           format: id
         - name: item_id
           in: query
-          description: The item id of the actions.
+          description: Delete actions of an item id.
           required: false
           type: string
           format: id
         - name: older_than
           in: query
           description: |
-            Delete all actions of a type older than the given timestamp or time.
-            Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
+            Delete actions older than the given duration, or the given time number.
+            Could be a ISO 8601 duration, or a Unix time number.
+            Specifications are available at https://en.wikipedia.org/wiki/ISO_8601#Durations, or https://en.wikipedia.org/wiki/Unix_time.
           required: false
           type: string
       responses:
@@ -817,7 +819,7 @@ paths:
       tags:
         - action
       operationId: post_bulk_actions
-      summary: Post Bulk Actions
+      summary: Posts Actions
       description: |
         Posts bulk actions to SuggestGrid.
         The recommended method for posting multiple actions at once.
@@ -860,19 +862,19 @@ paths:
             $ref: '#/definitions/ErrorResponse'
   # Metadata Paths
   /v1/users/{user_id}:
-    parameters:
-      - name: user_id
-        in: path
-        description: The user id to delete its metadata.
-        required: true
-        type: string
-        format: id
     get:
       tags:
         - metadata
       operationId: get_user
-      summary: Get A User
+      summary: Gets A User
       description: Returns a user metadata if it exists.
+      parameters:
+        - name: user_id
+          in: path
+          description: The user id to get its metadata.
+          required: true
+          type: string
+          format: id
       responses:
         200:
           description: Returns a user metadata.
@@ -890,8 +892,15 @@ paths:
       tags:
         - metadata
       operationId: delete_user
-      summary: Delete a User
+      summary: Deletes a User
       description: Deletes a user metadata with the given user id.
+      parameters:
+        - name: user_id
+          in: path
+          description: The user id to delete its metadata.
+          required: true
+          type: string
+          format: id
       responses:
         200:
           description: Deleted a user metadata.
@@ -906,8 +915,10 @@ paths:
         tags:
           - metadata
         operationId: post_user
-        summary: Post a User
-        description: Posts a user metadata.
+        summary: Posts a User
+        description: |
+          Posts a user metadata.
+          Note that this operation completely overrides previous metadata for the id, if it exists.
         parameters:
           - name: user
             in: body
@@ -932,7 +943,7 @@ paths:
       tags:
         - metadata
       operationId: get_users
-      summary: Get Users
+      summary: Gets Users
       description: |
         Get items and total count of items.
         Page and per-page parameters could be set.
@@ -968,7 +979,7 @@ paths:
       tags:
         - metadata
       operationId: delete_all_users
-      summary: Delete All Users
+      summary: Deletes All Users
       description: |
         Warning: Deletes all user metadata from SuggestGrid.
       responses:
@@ -981,19 +992,19 @@ paths:
           schema:
             $ref: '#/definitions/ErrorResponse'
   /v1/items/{item_id}:
-    parameters:
-      - name: item_id
-        in: path
-        description: The item id to delete its metadata.
-        required: true
-        type: string
-        format: id
     get:
       tags:
         - metadata
       operationId: get_item
-      summary: Get An Item
+      summary: Gets An Item
       description: Returns an item metadata if it exists.
+      parameters:
+        - name: item_id
+          in: path
+          description: The item id to get its metadata.
+          required: true
+          type: string
+          format: id
       responses:
         200:
           description: Returns an item metadata.
@@ -1013,6 +1024,13 @@ paths:
       operationId: delete_item
       summary: Delete An Item
       description: Deletes an item metadata with the given item id.
+      parameters:
+        - name: item_id
+          in: path
+          description: The item id to delete its metadata.
+          required: true
+          type: string
+          format: id
       responses:
         200:
           description: Deleted an item metadata.
@@ -1027,10 +1045,10 @@ paths:
       tags:
         - metadata
       operationId: post_item
-      summary: Post an Item
+      summary: Posts An Item
       description: |
         Posts an item metadata.
-        This metadata can be used to filter or to be included in recommendations and similars methods.
+        Note that this operation completely overrides previous metadata for the id, if it exists.
       parameters:
         - name: item
           in: body
@@ -1055,9 +1073,9 @@ paths:
       tags:
         - metadata
       operationId: get_items
-      summary: Get Items
+      summary: Gets Items
       description: |
-        Get items and total count of items.
+        Gets items and total count of items.
         Page and per-page parameters could be set.
       parameters:
         - name: size
@@ -1091,7 +1109,7 @@ paths:
       tags:
         - metadata
       operationId: delete_all_items
-      summary: Delete All Items
+      summary: Deletes All Items
       description: |
         Warning: Deletes all item metadata from SuggestGrid.
       responses:
@@ -1108,10 +1126,10 @@ paths:
       tags:
         - metadata
       operationId: post_bulk_users
-      summary: Post Bulk Users
+      summary: Posts Users
       description: |
-        Post user metadata in bulk.
-        This metadata can be used to filter or to be included in recommendations and similars methods.
+        Posts user metadata in bulk.
+        Note that this operation completely overrides metadata with the same ids, if they exist.
       consumes:
        - text/plain; charset=utf-8
       parameters:
@@ -1147,10 +1165,10 @@ paths:
       tags:
         - metadata
       operationId: post_bulk_items
-      summary: Post Bulk Items
+      summary: Posts Items
       description: |
-        Post item metadata in bulk.
-        This method is recommended for sharing stored data with SuggestGrid.
+        Posts item metadata in bulk.
+        Note that this operation completely overrides metadata with the same ids, if they exist.
       consumes:
        - text/plain; charset=utf-8
       parameters:
@@ -1187,7 +1205,7 @@ paths:
       tags:
         - recommendation
       operationId: get_recommended_users
-      summary: Get Recommended Users
+      summary: Gets Recommended Users
       description: Returns recommended users for the query.
       parameters:
         - name: query
@@ -1205,6 +1223,10 @@ paths:
           description: Request body is invalid.
           schema:
             $ref: '#/definitions/ErrorResponse'
+        404:
+          description: At least one type in the request does not exist.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
         422:
           description: Required parameters are missing.
           schema:
@@ -1218,7 +1240,7 @@ paths:
       tags:
         - recommendation
       operationId: get_recommended_items
-      summary: Get Recommended Items
+      summary: Gets Recommended Items
       description: Returns recommended items for the query.
       parameters:
         - name: query
@@ -1236,6 +1258,10 @@ paths:
           description: Request body is invalid.
           schema:
             $ref: '#/definitions/ErrorResponse'
+        404:
+          description: At least one type in the request does not exist.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
         422:
           description: Required parameters are missing.
           schema:
@@ -1250,7 +1276,7 @@ paths:
       tags:
         - similarity
       operationId: get_similar_users
-      summary: Get Similar Users
+      summary: Gets Similar Users
       description: Returns similar users for the query.
       parameters:
         - name: query
@@ -1268,6 +1294,10 @@ paths:
           description: Request body is invalid.
           schema:
             $ref: '#/definitions/ErrorResponse'
+        404:
+          description: At least one type in the request does not exist.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
         422:
           description: Required parameters are missing.
           schema:
@@ -1281,7 +1311,7 @@ paths:
       tags:
         - similarity
       operationId: get_similar_items
-      summary: Get Similar Items
+      summary: Gets Similar Items
       description: Returns similar items for the query.
       parameters:
         - name: query
@@ -1299,6 +1329,10 @@ paths:
           description: Request body is invalid.
           schema:
             $ref: '#/definitions/ErrorResponse'
+        404:
+          description: At least one type in the request does not exist.
+          schema:
+            $ref: '#/definitions/ErrorResponse'
         422:
           description: Required parameters are missing.
           schema:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: suggestgrid
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.1.31
 platform: ruby
 authors:
 - SuggestGrid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging