feat(specs): add neuralSearch options (#1474)

Author: shortcuts

.github/.cache_version

@@ -1 +1 @@
-0.0.21
+0.0.22

specs/abtesting/paths/abtests.yml

@@ -59,6 +59,16 @@ get:
   parameters:
     - $ref: '../../common/parameters.yml#/Offset'
     - $ref: '../../common/parameters.yml#/Limit'
+    - name: indexPrefix
+      in: query
+      description: Filters the returned ab tests by any indices starting with the provided prefix that are assigned to either variant of an ab test.
+      schema:
+        type: string
+    - name: indexSuffix
+      in: query
+      description: Filters the returned ab tests by any indices ending with the provided suffix that are assigned to either variant of an ab test.
+      schema:
+        type: string
   responses:
     '200':
       description: OK

specs/common/schemas/IndexSettings.yml

@@ -280,6 +280,21 @@ indexSettingsAsSearchParams:
       $ref: '#/queryType'
     removeWordsIfNoResults:
       $ref: '#/removeWordsIfNoResults'
+    mode:
+      $ref: '#/mode'
+    semanticSearch:
+      type: object
+      description: >
+        The settings relevant for configuration of the semantic search engine.
+        These settings are only used when the mode is set to 'neuralSearch'.
+      properties:
+        eventSources:
+          description: When null, the current index / replica group will be used as the event source.
+          nullable: true
+          type: array
+          items:
+            type: string
+
     advancedSyntax:
       type: boolean
       description: Enables the advanced query syntax.
@@ -320,6 +335,14 @@ indexSettingsAsSearchParams:
       default: [exactPhrase, excludeWords]
       x-categories:
         - Query strategy
+    explain:
+      type: array
+      items:
+        type: string
+      description: Enriches the API’s response with meta-information as to how the query was processed.
+      default: []
+      x-categories:
+        - Query strategy
     distinct:
       $ref: '#/distinct'
     attributeForDistinct:
@@ -394,6 +417,14 @@ queryType:
   x-categories:
     - Query strategy
 
+mode:
+  type: string
+  enum: ['neuralSearch', 'keywordSearch']
+  description: The search mode that the index will use to query for results.
+  default: keywordSearch
+  x-categories:
+    - Query strategy
+
 removeWordsIfNoResults:
   type: string
   enum: [none, lastWords, firstWords, allOptional]

specs/search/common/schemas/SearchResponse.yml

@@ -108,6 +108,14 @@ baseSearchResponse:
       type: string
       description: A url-encoded string of all search parameters.
       example: query=a&hitsPerPage=20
+    redirect:
+      type: object
+      description: This parameter is for internal use only.
+      properties:
+        index:
+          type: array
+          items:
+            $ref: '#/RedirectRuleIndexMetadata'
     parsedQuery:
       type: string
       description: The query string that will be searched, after normalization.
@@ -137,3 +145,33 @@ nbPages:
   type: integer
   description: Number of pages available for the current query.
   example: 1
+
+RedirectRuleIndexMetadata:
+  type: object
+  properties:
+    source:
+      type: string
+      description: Source index for the redirect rule.
+    dest:
+      type: string
+      description: Destination index for the redirect rule.
+    reason:
+      type: string
+      description: Reason for the redirect rule.
+    succeed:
+      type: boolean
+      description: Status for the redirect rule.
+    data:
+      type: object
+      description: Data for the redirect rule.
+      required:
+        - ruleObjectID
+      properties:
+        ruleObjectID:
+          type: string
+  required:
+    - data
+    - succeed
+    - reason
+    - dest
+    - source

tests/CTS/methods/requests/abtesting/listABTests.json

@@ -11,14 +11,18 @@
     "testName": "listABTests with parameters",
     "parameters": {
       "offset": 42,
-      "limit": 21
+      "limit": 21,
+      "indexPrefix": "foo",
+      "indexSuffix": "bar"
     },
     "request": {
       "path": "/2/abtests",
       "method": "GET",
       "queryParameters": {
         "offset": "42",
-        "limit": "21"
+        "limit": "21",
+        "indexPrefix": "foo",
+        "indexSuffix": "bar"
       }
     }
   }