suggestgrid 0.1.27 → 0.1.30

Sign up to get free protection for your applications and to get access to all the features.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/suggest_grid/api_helper.rb +6 -0
  4. data/lib/suggest_grid/configuration.rb +1 -0
  5. data/lib/suggest_grid/controllers/action_controller.rb +94 -142
  6. data/lib/suggest_grid/controllers/base_controller.rb +3 -2
  7. data/lib/suggest_grid/controllers/metadata_controller.rb +182 -330
  8. data/lib/suggest_grid/controllers/recommendation_controller.rb +18 -42
  9. data/lib/suggest_grid/controllers/similarity_controller.rb +18 -42
  10. data/lib/suggest_grid/controllers/type_controller.rb +76 -140
  11. data/lib/suggest_grid/exceptions/delete_error_response_exception.rb +7 -7
  12. data/lib/suggest_grid/exceptions/detailed_error_response_exception.rb +1 -1
  13. data/lib/suggest_grid/exceptions/error_response_exception.rb +1 -1
  14. data/lib/suggest_grid/exceptions/limit_exceeded_error_response_exception.rb +3 -3
  15. data/lib/suggest_grid/http/faraday_client.rb +3 -1
  16. data/lib/suggest_grid/http/http_client.rb +4 -2
  17. data/lib/suggest_grid/models/action.rb +19 -2
  18. data/lib/suggest_grid/models/actions_response.rb +10 -2
  19. data/lib/suggest_grid/models/base_model.rb +17 -0
  20. data/lib/suggest_grid/models/bulk_post_error.rb +10 -2
  21. data/lib/suggest_grid/models/bulk_post_response.rb +10 -2
  22. data/lib/suggest_grid/models/delete_success_response.rb +16 -8
  23. data/lib/suggest_grid/models/get_recommended_items_body.rb +16 -8
  24. data/lib/suggest_grid/models/get_recommended_users_body.rb +16 -8
  25. data/lib/suggest_grid/models/get_similar_items_body.rb +15 -7
  26. data/lib/suggest_grid/models/get_similar_users_body.rb +15 -7
  27. data/lib/suggest_grid/models/get_type_response.rb +10 -2
  28. data/lib/suggest_grid/models/get_types_response.rb +8 -9
  29. data/lib/suggest_grid/models/items_response.rb +10 -2
  30. data/lib/suggest_grid/models/message_response.rb +10 -2
  31. data/lib/suggest_grid/models/metadata.rb +19 -10
  32. data/lib/suggest_grid/models/type_request_body.rb +11 -5
  33. data/lib/suggest_grid/models/users_response.rb +10 -2
  34. data/lib/suggest_grid.rb +2 -0
  35. data/spec/swagger.yaml +122 -194
  36. metadata +21 -7
data/spec/swagger.yaml CHANGED
@@ -2,8 +2,8 @@ swagger: '2.0'
2
2
 
3
3
  info:
4
4
  title: SuggestGrid
5
- version: 0.1.27
6
- description: SuggestGrid is a recommendation and personalization service.
5
+ version: 0.1.30
6
+ description: Personalization made Simple
7
7
  x-codegen-settings:
8
8
  appendContentHeaders: true
9
9
  generateAsyncCode: true
@@ -43,8 +43,8 @@ tags:
43
43
  - name: type
44
44
  description: Type Methods
45
45
  x-docs-text: |
46
- Type methods are used for managing SuggestGrid types.
47
- For more information on types, refer to [Types concept documentation](http://www.suggestgrid.com/docs/types).
46
+ Type methods are used for creating, inspecting, and deleting SuggestGrid types.
47
+ [Types documentation](http://www.suggestgrid.com/docs/types) is available for an overview.
48
48
  x-methods:
49
49
  - create_type
50
50
  - get_type
@@ -54,8 +54,8 @@ tags:
54
54
  - name: action
55
55
  description: Action Methods
56
56
  x-docs-text: |
57
- Action methods are for posting and deleting actions.
58
- For more information on actions, refer to [Actions concept documentation](http://www.suggestgrid.com/docs/actions).
57
+ Action methods are for creating, inspecting, and deleting actions.
58
+ [Actions documentation](http://www.suggestgrid.com/docs/actions) is available for an overview.
59
59
  x-methods:
60
60
  - post_action
61
61
  - post_bulk_actions
@@ -64,8 +64,8 @@ tags:
64
64
  - name: metadata
65
65
  description: Metadata Methods
66
66
  x-docs-text: |
67
- Metadata methods are for posting and deleting metadata.
68
- For more information on metadata, refer to [Metadata concept documentation ](http://www.suggestgrid.com/docs/metadata).
67
+ Metadata methods are for creating, inspecting, and deleting metadata.
68
+ [Metadata documentation ](http://www.suggestgrid.com/docs/metadata) is available for an overview.
69
69
  x-methods:
70
70
  - post_user
71
71
  - post_bulk_users
@@ -82,16 +82,16 @@ tags:
82
82
  - name: recommendation
83
83
  description: Recommnedation Methods
84
84
  x-docs-text: |
85
- Recommnedation methods are for getting recommended items or users responses from SuggestGrid.
86
- For more information on recommendations, refer to [Recommendations concept documentation](http://www.suggestgrid.com/docs/recommendations).
85
+ Recommnedation methods are for getting recommended items, or recommended users from SuggestGrid.
86
+ [Recommendations documentation](http://www.suggestgrid.com/docs/recommendations) is available for an overview.
87
87
  x-methods:
88
88
  - get_recommended_users
89
89
  - get_recommended_items
90
90
  - name: similarity
91
91
  description: Similarity Methods
92
92
  x-docs-text: |
93
- Similarity methods are for getting similar items or users responses from SuggestGrid.
94
- For more information on similars, refer to [Similarities concept documentation](http://www.suggestgrid.com/docs/similarities).
93
+ Similarity methods are for getting similar items, or similar users from SuggestGrid.
94
+ [Similarities documentation](http://www.suggestgrid.com/docs/similarities) is available for an overview.
95
95
  x-methods:
96
96
  - get_similar_users
97
97
  - get_similar_items
@@ -100,8 +100,7 @@ definitions:
100
100
  Action:
101
101
  type: object
102
102
  description: |
103
- An action object represents a user's action on an item.
104
- All actions belong to a type that gives meaning to actions.
103
+ An action object represents a user's action of a type on an item.
105
104
  properties:
106
105
  type:
107
106
  type: string
@@ -115,6 +114,10 @@ definitions:
115
114
  rating:
116
115
  type: number
117
116
  description: The optional rating given by the user, if the type is explicit.
117
+ timestamp:
118
+ type: integer
119
+ format: int64
120
+ description: The optional UNIX epoch timestamp of the action. Defaults to the current timestamp.
118
121
  required:
119
122
  - type
120
123
  - user_id
@@ -132,13 +135,15 @@ definitions:
132
135
  - boolean
133
136
  Metadata:
134
137
  type: object
135
- description: A metadata for a user or an item.
138
+ description: |
139
+ Metadata of a user or an item.
140
+ Id parameter is required for all metadata.
141
+ Metadata may have other parameters with string, number, or boolean values.
136
142
  properties:
137
143
  id:
138
144
  type: string
139
145
  description: |
140
- The id of the user or the item that the metadata is associated with.
141
- Id parameter is necessary for all metadata.
146
+ The id of the metadata of a user or an item.
142
147
  additionalProperties:
143
148
  type:
144
149
  - string
@@ -154,17 +159,14 @@ definitions:
154
159
  properties:
155
160
  rating:
156
161
  type: string
157
- description: |
158
- The rating type of the type to be created.
159
- Could be "explicit" or "implicit"
160
- The default is "implicit".
162
+ description: The rating type of the type. Could be "explicit" or "implicit", where "implicit" is the default.
161
163
  GetRecommendedUsersBody:
162
164
  type: object
163
165
  description: Query for recommended users.
164
166
  properties:
165
167
  type:
166
168
  type: string
167
- description: The type of the query.
169
+ description: The type of the query. Recommendations will be calculated based on actions of this type.
168
170
  types:
169
171
  type: string
170
172
  description: The types of the query. Exactly one of type or types parameters must be provided.
@@ -178,23 +180,25 @@ definitions:
178
180
  type: string
179
181
  from:
180
182
  type: integer
181
- description: The number of most recommended items to be skipped.
183
+ description: The number of most recommended items to be skipped from the response. Defaults to 0.
182
184
  size:
183
185
  type: integer
184
- description: The number of users asked to return in the response.
186
+ description: The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
185
187
  similar_user_id:
186
188
  type: string
187
189
  description: Similar user that the response should be similar to.
188
190
  similar_user_ids:
189
- type: string
191
+ type: array
190
192
  description: |
191
193
  Similar users that the response should be similar to.
192
194
  At most one of similar user and similar users parameters can be provided.
195
+ items:
196
+ type: string
193
197
  fields:
194
198
  type: array
195
199
  items:
196
200
  type: string
197
- description: The metadata fields that are to be included in returned users.
201
+ description: The metadata fields to be included in returned user objects.
198
202
  filter:
199
203
  $ref: '#/definitions/Filter'
200
204
  except:
@@ -208,7 +212,7 @@ definitions:
208
212
  properties:
209
213
  type:
210
214
  type: string
211
- description: The type of the query.
215
+ description: The type of the query. Recommendations will be calculated based on actions of this type.
212
216
  types:
213
217
  type: string
214
218
  description: The types of the query. Exactly one of type or types parameters must be provided.
@@ -222,23 +226,25 @@ definitions:
222
226
  type: string
223
227
  from:
224
228
  type: integer
225
- description: The number of most recommended items to be skipped.
229
+ description: The number of most recommended items to be skipped from the response. Defaults to 0.
226
230
  size:
227
231
  type: integer
228
- description: The number of items asked to return in the response.
232
+ description: The number of items requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
229
233
  similar_item_id:
230
234
  type: string
231
235
  description: Similar item that the response should be similar to.
232
236
  similar_item_ids:
233
- type: string
237
+ type: array
234
238
  description: |
235
239
  Similar items that the response should be similar to.
236
240
  At most one of similar item and similar items parameters can be provided.
241
+ items:
242
+ type: string
237
243
  fields:
238
244
  type: array
239
245
  items:
240
246
  type: string
241
- description: The metadata fields that are to be included in returned items.
247
+ description: The metadata fields to be included in returned item objects.
242
248
  filter:
243
249
  $ref: '#/definitions/Filter'
244
250
  except:
@@ -248,11 +254,11 @@ definitions:
248
254
  description: These item ids that will not be included in the response.
249
255
  GetSimilarUsersBody:
250
256
  type: object
251
- description: The query for similar users.
257
+ description: Query for similar users.
252
258
  properties:
253
259
  type:
254
260
  type: string
255
- description: The type of the query.
261
+ description: The type of the query. Similarities will be calculated based on actions of this type.
256
262
  types:
257
263
  type: string
258
264
  description: The types of the query. Exactly one of type or types parameters must be provided.
@@ -266,15 +272,15 @@ definitions:
266
272
  type: string
267
273
  from:
268
274
  type: integer
269
- description: The number of most similar users to be skipped.
275
+ description: The number of most similar users to be skipped from the response. Defaults to 0.
270
276
  size:
271
277
  type: integer
272
- description: The number of users asked to return in the response.
278
+ description: The number of users requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
273
279
  fields:
274
280
  type: array
275
281
  items:
276
282
  type: string
277
- description: The metadata fields that are to be included in returned users.
283
+ description: The metadata fields to be included in returned user objects.
278
284
  filter:
279
285
  $ref: '#/definitions/Filter'
280
286
  except:
@@ -284,11 +290,11 @@ definitions:
284
290
  description: These user ids that will not be included in the response.
285
291
  GetSimilarItemsBody:
286
292
  type: object
287
- description: The query for similar items.
293
+ description: Query for similar items.
288
294
  properties:
289
295
  type:
290
296
  type: string
291
- description: The type of the query.
297
+ description: The type of the query. Similarities will be calculated based on actions of this type.
292
298
  types:
293
299
  type: string
294
300
  description: The types of the query. Exactly one of type or types parameters must be provided.
@@ -304,15 +310,15 @@ definitions:
304
310
  type: string
305
311
  from:
306
312
  type: integer
307
- description: The number of most similar items to be skipped.
313
+ description: The number of most similar items to be skipped from the response. Defaults to 0.
308
314
  size:
309
315
  type: integer
310
- description: The number of items asked to return in the response.
316
+ description: The number of items requested. Defaults to 10. Must be between 1 and 10,000 inclusive.
311
317
  fields:
312
318
  type: array
313
319
  items:
314
320
  type: string
315
- description: The metadata fields that are to be included in returned items.
321
+ description: The metadata fields to be included in returned item objects.
316
322
  filter:
317
323
  $ref: '#/definitions/Filter'
318
324
  except:
@@ -356,7 +362,7 @@ definitions:
356
362
  description: Description of the response.
357
363
  error_uri:
358
364
  type: string
359
- description: URI of the response for more details.
365
+ description: The URI of the error for more details.
360
366
  DetailedErrorResponse:
361
367
  type: object
362
368
  description: Error response.
@@ -369,7 +375,7 @@ definitions:
369
375
  description: Description of the response.
370
376
  error_uri:
371
377
  type: string
372
- description: URI of the response for more details.
378
+ description: The URI of the error for more details.
373
379
  error_details:
374
380
  type: string
375
381
  description: Specific details of the response.
@@ -385,14 +391,14 @@ definitions:
385
391
  description: Description of the response.
386
392
  error_uri:
387
393
  type: string
388
- description: URI of the response for more details.
394
+ description: The URI of the error for more details.
389
395
  used:
390
396
  type: integer
391
- format: int32
397
+ format: int64
392
398
  description: The quantity used by the account.
393
399
  limit:
394
400
  type: integer
395
- format: int32
401
+ format: int64
396
402
  description: The limit quantity of the account.
397
403
  DeleteErrorResponse:
398
404
  type: object
@@ -406,19 +412,19 @@ definitions:
406
412
  description: Description of the response.
407
413
  error_uri:
408
414
  type: string
409
- description: URI of the response for more details.
415
+ description: The URI of the error for more details.
410
416
  found:
411
417
  type: integer
412
- format: int32
413
- description: The number of records found for the delete query.
418
+ format: int64
419
+ description: The number of records found.
414
420
  deleted:
415
421
  type: integer
416
- format: int32
417
- description: The number of records deleted for the delete query.
422
+ format: int64
423
+ description: The number of records deleted.
418
424
  failed:
419
425
  type: integer
420
- format: int32
421
- description: The number of records found but not deleted for the delete query.
426
+ format: int64
427
+ description: The number of records failed to be deleted.
422
428
  DeleteSuccessResponse:
423
429
  type: object
424
430
  description: Successful delete response with found, deleted, and failed parameters.
@@ -428,16 +434,16 @@ definitions:
428
434
  description: Message of the response.
429
435
  found:
430
436
  type: integer
431
- format: int32
432
- description: The number of records found for the delete query.
437
+ format: int64
438
+ description: The number of records found.
433
439
  deleted:
434
440
  type: integer
435
- format: int32
436
- description: The number of records deleted for the delete query.
441
+ format: int64
442
+ description: The number of records deleted.
437
443
  failed:
438
444
  type: integer
439
- format: int32
440
- description: The number of records found but not deleted for the delete query.
445
+ format: int64
446
+ description: The number of records failed to be deleted.
441
447
  GetTypesResponse:
442
448
  type: object
443
449
  description: Type names response.
@@ -447,10 +453,6 @@ definitions:
447
453
  description: The list of type names
448
454
  items:
449
455
  type: string
450
- status:
451
- type: integer
452
- format: int32
453
- description: Status code of the response. It is not 2XX.
454
456
  GetTypeResponse:
455
457
  type: object
456
458
  description: Get type details response.
@@ -531,10 +533,6 @@ paths:
531
533
  description: Get types response.
532
534
  schema:
533
535
  $ref: '#/definitions/GetTypesResponse'
534
- 429:
535
- description: Too many requests.
536
- schema:
537
- $ref: '#/definitions/ErrorResponse'
538
536
  default:
539
537
  description: Unexpected internal error.
540
538
  schema:
@@ -549,11 +547,7 @@ paths:
549
547
  200:
550
548
  description: Get types response.
551
549
  schema:
552
- $ref: '#/definitions/GetTypesResponse'
553
- 429:
554
- description: Too many requests.
555
- schema:
556
- $ref: '#/definitions/ErrorResponse'
550
+ $ref: '#/definitions/MessageResponse'
557
551
  default:
558
552
  description: Unexpected internal error.
559
553
  schema:
@@ -577,8 +571,8 @@ paths:
577
571
  description: Get type response.
578
572
  schema:
579
573
  $ref: '#/definitions/GetTypeResponse'
580
- 429:
581
- description: Too many requests.
574
+ 404:
575
+ description: Type does not exists.
582
576
  schema:
583
577
  $ref: '#/definitions/ErrorResponse'
584
578
  default:
@@ -594,7 +588,7 @@ paths:
594
588
  parameters:
595
589
  - name: type
596
590
  in: path
597
- description: The name of the type to be created.
591
+ description: The name of the type.
598
592
  required: true
599
593
  type: string
600
594
  format: id
@@ -621,10 +615,6 @@ paths:
621
615
  description: Rating type is not `implicit` or `explicit`.
622
616
  schema:
623
617
  $ref: '#/definitions/ErrorResponse'
624
- 429:
625
- description: Too many requests.
626
- schema:
627
- $ref: '#/definitions/ErrorResponse'
628
618
  default:
629
619
  description: Unexpected internal error.
630
620
  schema:
@@ -635,8 +625,7 @@ paths:
635
625
  operationId: delete_type
636
626
  summary: Delete a Type
637
627
  description: |
638
- Deletes a type with ALL of its actions and recommendation model.
639
- Do not use this if you will need the type.
628
+ Warning: Deletes the type with all of its actions and its recommendation model.
640
629
  parameters:
641
630
  - name: type
642
631
  in: path
@@ -650,11 +639,7 @@ paths:
650
639
  schema:
651
640
  $ref: '#/definitions/MessageResponse'
652
641
  404:
653
- description: Type does not exists.
654
- schema:
655
- $ref: '#/definitions/ErrorResponse'
656
- 429:
657
- description: Too many requests.
642
+ description: Action type does not exists.
658
643
  schema:
659
644
  $ref: '#/definitions/ErrorResponse'
660
645
  default:
@@ -685,7 +670,7 @@ paths:
685
670
  schema:
686
671
  $ref: '#/definitions/MessageResponse'
687
672
  400:
688
- description: Required `user_id` or `item_id` parameters are missing from the request body.
673
+ description: Required user id or item id parameters are missing from the request.
689
674
  schema:
690
675
  $ref: '#/definitions/ErrorResponse'
691
676
  402:
@@ -693,11 +678,7 @@ paths:
693
678
  schema:
694
679
  $ref: '#/definitions/ErrorResponse'
695
680
  404:
696
- description: Type does not exists.
697
- schema:
698
- $ref: '#/definitions/ErrorResponse'
699
- 429:
700
- description: Too many requests.
681
+ description: Action type does not exists.
701
682
  schema:
702
683
  $ref: '#/definitions/ErrorResponse'
703
684
  default:
@@ -712,6 +693,7 @@ paths:
712
693
  description: |
713
694
  Get actions. Defaut responses will be paged by 10 actios each.
714
695
  Type, user id, item id, or older than parameters could be provided.
696
+ The intersection of the provided parameters will be returned.
715
697
  parameters:
716
698
  - name: type
717
699
  in: query
@@ -735,37 +717,32 @@ paths:
735
717
  in: query
736
718
  description: |
737
719
  Maxium timestamp of the actions.
738
- Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
720
+ Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
739
721
  required: false
740
722
  type: string
741
- format: id
742
723
  - name: size
743
724
  in: query
744
725
  description: |
745
726
  The number of the users response.
746
- Defaults to 10. Must be between 1 and 10.000 inclusive.
727
+ Defaults to 10. Must be between 1 and 10,000 inclusive.
747
728
  This parameter must be string represetation of an integer like "1".
748
729
  required: false
749
730
  type: integer
750
- format: int32
731
+ format: int64
751
732
  - name: from
752
733
  in: query
753
734
  description: |
754
- The number of users to be skipped for response.
735
+ The number of users to be skipped from the response.
755
736
  Defaults to 0. Must be bigger than or equal to 0.
756
737
  This parameter must be string represetation of an integer like "1".
757
738
  required: false
758
739
  type: integer
759
- format: int32
740
+ format: int64
760
741
  responses:
761
742
  200:
762
743
  description: Paged actions response.
763
744
  schema:
764
745
  $ref: '#/definitions/ActionsResponse'
765
- 429:
766
- description: Too many requests.
767
- schema:
768
- $ref: '#/definitions/ErrorResponse'
769
746
  default:
770
747
  description: Unexpected internal error.
771
748
  schema:
@@ -776,14 +753,14 @@ paths:
776
753
  operationId: delete_actions
777
754
  summary: Delete Actions
778
755
  description: |
779
- Type must be provided. Additionally,
780
-
781
- * If both user id and item id are supplied the user's actions on the item will be deleted.
782
- * If only user id is provided, all actions of the user will be deleted.
783
- * If only item id is provided, all actions on the item will be deleted.
784
- * If only older than is provided, all actions older than the timestamp or the duration will be deleted.
785
- * If a few of these parameters are provided, delete action will be executed within intersection of these parameters.
786
- * One of these parameters must be provided. In order to delete all actions, delete the type.
756
+ Warning: Please use get actions with the exact parameters first to inspect the actions to be deleted.
757
+
758
+ * Type must be provided.
759
+ * If user id is provided, all actions of the user will be deleted.
760
+ * If item id is provided, all actions on the item will be deleted.
761
+ * If older than is provided, all actions older than the timestamp or the duration will be deleted.
762
+ * If a number of these parameters are provided, the intersection of these parameters will be deleted.
763
+ * In addition to a type, at least one of these parameters must be provided. In order to delete all the actions of a type, delete the type.
787
764
  parameters:
788
765
  - name: type
789
766
  in: query
@@ -807,17 +784,16 @@ paths:
807
784
  in: query
808
785
  description: |
809
786
  Delete all actions of a type older than the given timestamp or time.
810
- Valid times are 1s, 1m, 1h, 1d, 1M, 1y, or unix timestamp (like 1443798195).
787
+ Valid times are in form of 1s, 1m, 1h, 1d, 1M, 1y, where 1 can be any integer, or a UNIX timestamp like 1443798195.
811
788
  required: false
812
789
  type: string
813
- format: id
814
790
  responses:
815
791
  200:
816
792
  description: Successfully deleted actions.
817
793
  schema:
818
794
  $ref: '#/definitions/DeleteSuccessResponse'
819
795
  400:
820
- description: Required `user_id` or `item_id` parameters are missing from the request body.
796
+ description: Required user id or item id parameters are missing.
821
797
  schema:
822
798
  $ref: '#/definitions/ErrorResponse'
823
799
  404:
@@ -825,11 +801,7 @@ paths:
825
801
  schema:
826
802
  $ref: '#/definitions/DeleteErrorResponse'
827
803
  422:
828
- description: No query parameter (`user_id`, `item_id`, or `older_than`) is given. In order to delete all actionsdelete the type.
829
- schema:
830
- $ref: '#/definitions/ErrorResponse'
831
- 429:
832
- description: Too many requests.
804
+ description: No query parameter (user id, item id, or older than) is given. qIn order to delete all actionsdelete the type.
833
805
  schema:
834
806
  $ref: '#/definitions/ErrorResponse'
835
807
  505:
@@ -874,8 +846,12 @@ paths:
874
846
  description: Action limit exceeded.
875
847
  schema:
876
848
  $ref: '#/definitions/ErrorResponse'
877
- 429:
878
- description: Too many requests.
849
+ 404:
850
+ description: Action type does not exists.
851
+ schema:
852
+ $ref: '#/definitions/ErrorResponse'
853
+ 413:
854
+ description: Bulk request maximum line count exceeded.
879
855
  schema:
880
856
  $ref: '#/definitions/ErrorResponse'
881
857
  default:
@@ -895,15 +871,15 @@ paths:
895
871
  tags:
896
872
  - metadata
897
873
  operationId: get_user
898
- summary: Get An User
899
- description: Returns an user metadata if it exists.
874
+ summary: Get A User
875
+ description: Returns a user metadata if it exists.
900
876
  responses:
901
877
  200:
902
- description: Returns an user metadata.
878
+ description: Returns a user metadata.
903
879
  schema:
904
880
  $ref: '#/definitions/Metadata'
905
881
  404:
906
- description: User not found.
882
+ description: User does not exists.
907
883
  schema:
908
884
  $ref: '#/definitions/ErrorResponse'
909
885
  default:
@@ -921,10 +897,6 @@ paths:
921
897
  description: Deleted a user metadata.
922
898
  schema:
923
899
  $ref: '#/definitions/MessageResponse'
924
- 429:
925
- description: Too many requests.
926
- schema:
927
- $ref: '#/definitions/ErrorResponse'
928
900
  default:
929
901
  description: Unexpected internal error.
930
902
  schema:
@@ -952,10 +924,6 @@ paths:
952
924
  description: Metadata is invalid.
953
925
  schema:
954
926
  $ref: '#/definitions/DetailedErrorResponse'
955
- 429:
956
- description: Too many requests.
957
- schema:
958
- $ref: '#/definitions/ErrorResponse'
959
927
  default:
960
928
  description: Unexpected internal error.
961
929
  schema:
@@ -973,29 +941,25 @@ paths:
973
941
  in: query
974
942
  description: |
975
943
  The number of the users response.
976
- Defaults to 10. Must be between 1 and 10.000 inclusive.
944
+ Defaults to 10. Must be between 1 and 10,000 inclusive.
977
945
  This parameter must be string represetation of an integer like "1".
978
946
  required: false
979
947
  type: integer
980
- format: int32
948
+ format: int64
981
949
  - name: from
982
950
  in: query
983
951
  description: |
984
- The number of users to be skipped for response.
952
+ The number of users to be skipped from the response.
985
953
  Defaults to 0. Must be bigger than or equal to 0.
986
954
  This parameter must be string represetation of an integer like "1".
987
955
  required: false
988
956
  type: integer
989
- format: int32
957
+ format: int64
990
958
  responses:
991
959
  200:
992
960
  description: Get users response.
993
961
  schema:
994
962
  $ref: '#/definitions/UsersResponse'
995
- 429:
996
- description: Too many requests.
997
- schema:
998
- $ref: '#/definitions/ErrorResponse'
999
963
  default:
1000
964
  description: Unexpected internal error.
1001
965
  schema:
@@ -1005,16 +969,13 @@ paths:
1005
969
  - metadata
1006
970
  operationId: delete_all_users
1007
971
  summary: Delete All Users
1008
- description: Deletes all user metadata from SuggestGrid.
972
+ description: |
973
+ Warning: Deletes all user metadata from SuggestGrid.
1009
974
  responses:
1010
975
  200:
1011
976
  description: Deleted all user metadata.
1012
977
  schema:
1013
978
  $ref: '#/definitions/MessageResponse'
1014
- 429:
1015
- description: Too many requests.
1016
- schema:
1017
- $ref: '#/definitions/ErrorResponse'
1018
979
  default:
1019
980
  description: Unexpected internal error.
1020
981
  schema:
@@ -1039,7 +1000,7 @@ paths:
1039
1000
  schema:
1040
1001
  $ref: '#/definitions/Metadata'
1041
1002
  404:
1042
- description: Item not found.
1003
+ description: Item does not exists.
1043
1004
  schema:
1044
1005
  $ref: '#/definitions/ErrorResponse'
1045
1006
  default:
@@ -1057,10 +1018,6 @@ paths:
1057
1018
  description: Deleted an item metadata.
1058
1019
  schema:
1059
1020
  $ref: '#/definitions/MessageResponse'
1060
- 429:
1061
- description: Too many requests.
1062
- schema:
1063
- $ref: '#/definitions/ErrorResponse'
1064
1021
  default:
1065
1022
  description: Unexpected internal error.
1066
1023
  schema:
@@ -1090,10 +1047,6 @@ paths:
1090
1047
  description: Metadata is invalid.
1091
1048
  schema:
1092
1049
  $ref: '#/definitions/DetailedErrorResponse'
1093
- 429:
1094
- description: Too many requests.
1095
- schema:
1096
- $ref: '#/definitions/ErrorResponse'
1097
1050
  default:
1098
1051
  description: Unexpected internal error.
1099
1052
  schema:
@@ -1111,29 +1064,25 @@ paths:
1111
1064
  in: query
1112
1065
  description: |
1113
1066
  The number of the users response.
1114
- Defaults to 10. Must be between 1 and 10.000 inclusive.
1067
+ Defaults to 10. Must be between 1 and 10,000 inclusive.
1115
1068
  This parameter must be string represetation of an integer like "1".
1116
1069
  required: false
1117
1070
  type: integer
1118
- format: int32
1071
+ format: int64
1119
1072
  - name: from
1120
1073
  in: query
1121
1074
  description: |
1122
- The number of users to be skipped for response.
1075
+ The number of users to be skipped from the response.
1123
1076
  Defaults to 0. Must be bigger than or equal to 0.
1124
1077
  This parameter must be string represetation of an integer like "1".
1125
1078
  required: false
1126
1079
  type: integer
1127
- format: int32
1080
+ format: int64
1128
1081
  responses:
1129
1082
  200:
1130
1083
  description: Get items response.
1131
1084
  schema:
1132
1085
  $ref: '#/definitions/ItemsResponse'
1133
- 429:
1134
- description: Too many requests.
1135
- schema:
1136
- $ref: '#/definitions/ErrorResponse'
1137
1086
  default:
1138
1087
  description: Unexpected internal error.
1139
1088
  schema:
@@ -1144,17 +1093,12 @@ paths:
1144
1093
  operationId: delete_all_items
1145
1094
  summary: Delete All Items
1146
1095
  description: |
1147
- Delete all items metadata.
1148
- This method would flush all items metadata on SuggestGrid.
1096
+ Warning: Deletes all item metadata from SuggestGrid.
1149
1097
  responses:
1150
1098
  200:
1151
1099
  description: Deleted all item metadata.
1152
1100
  schema:
1153
1101
  $ref: '#/definitions/MessageResponse'
1154
- 429:
1155
- description: Too many requests.
1156
- schema:
1157
- $ref: '#/definitions/ErrorResponse'
1158
1102
  default:
1159
1103
  description: Unexpected internal error.
1160
1104
  schema:
@@ -1190,8 +1134,8 @@ paths:
1190
1134
  description: Body is missing.
1191
1135
  schema:
1192
1136
  $ref: '#/definitions/ErrorResponse'
1193
- 429:
1194
- description: Too many requests.
1137
+ 413:
1138
+ description: Bulk request maximum line count exceeded.
1195
1139
  schema:
1196
1140
  $ref: '#/definitions/ErrorResponse'
1197
1141
  default:
@@ -1229,8 +1173,8 @@ paths:
1229
1173
  description: Body is missing.
1230
1174
  schema:
1231
1175
  $ref: '#/definitions/ErrorResponse'
1232
- 429:
1233
- description: Too many requests.
1176
+ 413:
1177
+ description: Bulk request maximum line count exceeded.
1234
1178
  schema:
1235
1179
  $ref: '#/definitions/ErrorResponse'
1236
1180
  default:
@@ -1244,11 +1188,11 @@ paths:
1244
1188
  - recommendation
1245
1189
  operationId: get_recommended_users
1246
1190
  summary: Get Recommended Users
1247
- description: Returns recommended users for the given query.
1191
+ description: Returns recommended users for the query.
1248
1192
  parameters:
1249
1193
  - name: query
1250
1194
  in: body
1251
- description: The query for recommended users.
1195
+ description: Query for recommended users.
1252
1196
  required: true
1253
1197
  schema:
1254
1198
  $ref: '#/definitions/GetRecommendedUsersBody'
@@ -1265,10 +1209,6 @@ paths:
1265
1209
  description: Required parameters are missing.
1266
1210
  schema:
1267
1211
  $ref: '#/definitions/ErrorResponse'
1268
- 429:
1269
- description: Too many requests.
1270
- schema:
1271
- $ref: '#/definitions/ErrorResponse'
1272
1212
  default:
1273
1213
  description: Unexpected internal error.
1274
1214
  schema:
@@ -1279,11 +1219,11 @@ paths:
1279
1219
  - recommendation
1280
1220
  operationId: get_recommended_items
1281
1221
  summary: Get Recommended Items
1282
- description: Returns recommended items for the given query.
1222
+ description: Returns recommended items for the query.
1283
1223
  parameters:
1284
1224
  - name: query
1285
1225
  in: body
1286
- description: The query for recommended items.
1226
+ description: Query for recommended items.
1287
1227
  required: true
1288
1228
  schema:
1289
1229
  $ref: '#/definitions/GetRecommendedItemsBody'
@@ -1300,10 +1240,6 @@ paths:
1300
1240
  description: Required parameters are missing.
1301
1241
  schema:
1302
1242
  $ref: '#/definitions/ErrorResponse'
1303
- 429:
1304
- description: Too many requests.
1305
- schema:
1306
- $ref: '#/definitions/ErrorResponse'
1307
1243
  default:
1308
1244
  description: Unexpected internal error.
1309
1245
  schema:
@@ -1319,7 +1255,7 @@ paths:
1319
1255
  parameters:
1320
1256
  - name: query
1321
1257
  in: body
1322
- description: The query for similar users.
1258
+ description: Query for similar users.
1323
1259
  required: true
1324
1260
  schema:
1325
1261
  $ref: '#/definitions/GetSimilarUsersBody'
@@ -1336,10 +1272,6 @@ paths:
1336
1272
  description: Required parameters are missing.
1337
1273
  schema:
1338
1274
  $ref: '#/definitions/ErrorResponse'
1339
- 429:
1340
- description: Too many requests.
1341
- schema:
1342
- $ref: '#/definitions/ErrorResponse'
1343
1275
  default:
1344
1276
  description: Unexpected internal error.
1345
1277
  schema:
@@ -1354,7 +1286,7 @@ paths:
1354
1286
  parameters:
1355
1287
  - name: query
1356
1288
  in: body
1357
- description: The query for similar items.
1289
+ description: Query for similar items.
1358
1290
  required: true
1359
1291
  schema:
1360
1292
  $ref: '#/definitions/GetSimilarItemsBody'
@@ -1371,10 +1303,6 @@ paths:
1371
1303
  description: Required parameters are missing.
1372
1304
  schema:
1373
1305
  $ref: '#/definitions/ErrorResponse'
1374
- 429:
1375
- description: Too many requests.
1376
- schema:
1377
- $ref: '#/definitions/ErrorResponse'
1378
1306
  default:
1379
1307
  description: Unexpected internal error.
1380
1308
  schema: