feat(specs): deleteByParams (#1016)

Co-authored-by: Clément Vannicatte <[email protected]>

Author: clemfromspace

specs/common/schemas/SearchParams.yml

@@ -31,11 +31,7 @@ baseSearchParamsWithoutQuery:
       x-categories:
         - Search
     filters:
-      type: string
-      description: Filter the query with numeric, facet and/or tag filters.
-      default: ''
-      x-categories:
-        - Filtering
+      $ref: '#/filters'
     facetFilters:
       $ref: '#/facetFilters'
     optionalFilters:
@@ -91,17 +87,9 @@ baseSearchParamsWithoutQuery:
       x-categories:
         - Pagination
     aroundLatLng:
-      type: string
-      description: Search for entries around a central geolocation, enabling a geo search within a circular area.
-      default: ''
-      x-categories:
-        - Geo-Search
+      $ref: '#/aroundLatLng'
     aroundLatLngViaIP:
-      type: boolean
-      description: Search for entries around a given location automatically computed from the requester's IP address.
-      default: false
-      x-categories:
-        - Geo-Search
+      $ref: '#/aroundLatLngViaIP'
     aroundRadius:
       $ref: '#/aroundRadius'
     aroundPrecision:
@@ -117,21 +105,9 @@ baseSearchParamsWithoutQuery:
       x-categories:
         - Geo-Search
     insideBoundingBox:
-      type: array
-      items:
-        type: number
-        format: double
-      description: Search inside a rectangular area (in geo coordinates).
-      x-categories:
-        - Geo-Search
+      $ref: '#/insideBoundingBox'
     insidePolygon:
-      type: array
-      items:
-        type: number
-        format: double
-      description: Search inside a polygon (in geo coordinates).
-      x-categories:
-        - Geo-Search
+      $ref: '#/insidePolygon'
     naturalLanguages:
       type: array
       items:
@@ -245,6 +221,38 @@ aroundRadiusAll:
   type: string
   enum: [all]
 
+aroundLatLng:
+  type: string
+  description: Search for entries around a central geolocation, enabling a geo search within a circular area.
+  default: ''
+  x-categories:
+    - Geo-Search
+
+aroundLatLngViaIP:
+  type: boolean
+  description: Search for entries around a given location automatically computed from the requester's IP address.
+  default: false
+  x-categories:
+    - Geo-Search
+
+insideBoundingBox:
+  type: array
+  items:
+    type: number
+    format: double
+  description: Search inside a rectangular area (in geo coordinates).
+  x-categories:
+    - Geo-Search
+
+insidePolygon:
+  type: array
+  items:
+    type: number
+    format: double
+  description: Search inside a polygon (in geo coordinates).
+  x-categories:
+    - Geo-Search
+
 # There is duplicated logic here because we want to keep a correct description
 # and using `$ref` override everything.
 searchFiltersArrayString:
@@ -262,6 +270,13 @@ listOfSearchFilters:
   items:
     $ref: '#/mixedSearchFilters'
 
+filters:
+  type: string
+  description: Filter the query with numeric, facet and/or tag filters.
+  default: ''
+  x-categories:
+    - Filtering
+
 facetFilters:
   description: Filter hits by facet value.
   oneOf:

specs/search/common/schemas/DeleteByParams.yml

@@ -0,0 +1,20 @@
+deleteByParams:
+  type: object
+  additionalProperties: false
+  properties:
+    facetFilters:
+      $ref: '../../../common/schemas/SearchParams.yml#/facetFilters'
+    filters:
+      $ref: '../../../common/schemas/SearchParams.yml#/filters'
+    numericFilters:
+      $ref: '../../../common/schemas/SearchParams.yml#/numericFilters'
+    tagFilters:
+      $ref: '../../../common/schemas/SearchParams.yml#/tagFilters'
+    aroundLatLng:
+      $ref: '../../../common/schemas/SearchParams.yml#/aroundLatLng'
+    aroundRadius:
+      $ref: '../../../common/schemas/SearchParams.yml#/aroundRadius'
+    insideBoundingBox:
+      $ref: '../../../common/schemas/SearchParams.yml#/insideBoundingBox'
+    insidePolygon:
+      $ref: '../../../common/schemas/SearchParams.yml#/insidePolygon'

specs/search/paths/objects/deleteBy.yml

@@ -16,7 +16,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: '../../../common/schemas/SearchParams.yml#/searchParams'
+          $ref: '../../common/schemas/DeleteByParams.yml#/deleteByParams'
   responses:
     '200':
       $ref: '../../../common/responses/DeletedAt.yml'

tests/CTS/methods/requests/search/deleteBy.json

@@ -2,15 +2,15 @@
   {
     "parameters": {
       "indexName": "theIndexName",
-      "searchParams": {
-        "query": "testQuery"
+      "deleteByParams": {
+        "filters": "brand:brandName"
       }
     },
     "request": {
       "path": "/1/indexes/theIndexName/deleteByQuery",
       "method": "POST",
       "body": {
-        "query": "testQuery"
+        "filters": "brand:brandName"
       }
     }
   }