@@ -3365,6 +3365,128 @@ paths:
3365
3365
$ref : ' #/components/schemas/batchResponse'
3366
3366
' 400 ' :
3367
3367
$ref : ' #/components/responses/IndexNotFound'
3368
+ /saveObjects :
3369
+ post :
3370
+ x-helper : true
3371
+ tags :
3372
+ - search
3373
+ operationId : saveObjects
3374
+ summary : Saves the given array of objects in the given index
3375
+ description : >
3376
+ Helper: Saves the given array of objects in the given index. The
3377
+ `chunkedBatch` helper is used under the hood, which creates a `batch`
3378
+ requests with at most 1000 objects in it.
3379
+ parameters :
3380
+ - in : query
3381
+ name : indexName
3382
+ description : The `indexName` to delete `objectIDs` from.
3383
+ required : true
3384
+ schema :
3385
+ type : string
3386
+ - in : query
3387
+ name : objectIDs
3388
+ description : The objectIDs to delete.
3389
+ required : true
3390
+ schema :
3391
+ type : array
3392
+ items :
3393
+ type : string
3394
+ responses :
3395
+ ' 200 ' :
3396
+ description : OK
3397
+ content :
3398
+ application/json :
3399
+ schema :
3400
+ type : array
3401
+ items :
3402
+ $ref : ' #/components/schemas/batchResponse'
3403
+ ' 400 ' :
3404
+ $ref : ' #/components/responses/IndexNotFound'
3405
+ /deleteObjects :
3406
+ post :
3407
+ x-helper : true
3408
+ tags :
3409
+ - search
3410
+ operationId : deleteObjects
3411
+ summary : Deletes every records for the given objectIDs
3412
+ description : >
3413
+ Helper: Deletes every records for the given objectIDs. The
3414
+ `chunkedBatch` helper is used under the hood, which creates a `batch`
3415
+ requests with at most 1000 objectIDs in it.
3416
+ parameters :
3417
+ - in : query
3418
+ name : indexName
3419
+ description : The `indexName` to delete `objectIDs` from.
3420
+ required : true
3421
+ schema :
3422
+ type : string
3423
+ - in : query
3424
+ name : objectIDs
3425
+ description : The objectIDs to delete.
3426
+ required : true
3427
+ schema :
3428
+ type : array
3429
+ items :
3430
+ type : string
3431
+ responses :
3432
+ ' 200 ' :
3433
+ description : OK
3434
+ content :
3435
+ application/json :
3436
+ schema :
3437
+ type : array
3438
+ items :
3439
+ $ref : ' #/components/schemas/batchResponse'
3440
+ ' 400 ' :
3441
+ $ref : ' #/components/responses/IndexNotFound'
3442
+ /partialUpdateObjects :
3443
+ post :
3444
+ x-helper : true
3445
+ tags :
3446
+ - search
3447
+ operationId : partialUpdateObjects
3448
+ summary : >-
3449
+ Replaces object content of all the given objects according to their
3450
+ respective `objectID` field
3451
+ description : >
3452
+ Helper: Replaces object content of all the given objects according to
3453
+ their respective `objectID` field. The `chunkedBatch` helper is used
3454
+ under the hood, which creates a `batch` requests with at most 1000
3455
+ objects in it.
3456
+ parameters :
3457
+ - in : query
3458
+ name : indexName
3459
+ description : The `indexName` to delete `objectIDs` from.
3460
+ required : true
3461
+ schema :
3462
+ type : string
3463
+ - in : query
3464
+ name : objectIDs
3465
+ description : The objectIDs to delete.
3466
+ required : true
3467
+ schema :
3468
+ type : array
3469
+ items :
3470
+ type : string
3471
+ - in : query
3472
+ name : createIfNotExists
3473
+ description : >-
3474
+ To be provided if non-existing objects are passed, otherwise, the
3475
+ call will fail.
3476
+ required : false
3477
+ schema :
3478
+ type : boolean
3479
+ responses :
3480
+ ' 200 ' :
3481
+ description : OK
3482
+ content :
3483
+ application/json :
3484
+ schema :
3485
+ type : array
3486
+ items :
3487
+ $ref : ' #/components/schemas/batchResponse'
3488
+ ' 400 ' :
3489
+ $ref : ' #/components/responses/IndexNotFound'
3368
3490
components :
3369
3491
securitySchemes :
3370
3492
appId :
0 commit comments