fix: duplicate & modify baseSearchResponse

e-krebs · e-krebs · commit 4bd1674d2c26 · 2024-12-16T18:37:19.000+01:00
diff --git a/specs/common/schemas/SearchResponse.yml b/specs/common/schemas/SearchResponse.yml
@@ -1,21 +1,4 @@
 baseSearchResponse:
-  additionalProperties: true
-  allOf:
-    - $ref: '#/rootSearchResponse'
-    - $ref: '#/appliedRulesResponse'
-
-appliedRulesResponse:
-  type: object
-  additionalProperties: true
-  properties:
-    appliedRules:
-      description: Rules applied to the query.
-      title: appliedRules
-      type: array
-      items:
-        type: object
-
-rootSearchResponse:
   type: object
   additionalProperties: true
   required:
@@ -61,6 +44,12 @@ rootSearchResponse:
           type: boolean
           title: typo
           description: Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+    appliedRules:
+      description: Rules applied to the query.
+      title: appliedRules
+      type: array
+      items:
+        type: object
     exhaustiveFacetsCount:
       type: boolean
       description: See the `facetsCount` field of the `exhaustive` object in the response.
diff --git a/specs/composition/common/schemas/SearchResponse.yml b/specs/composition/common/schemas/SearchResponse.yml
@@ -1,8 +1,7 @@
 searchResponse:
   additionalProperties: true
   allOf:
-    - $ref: '#/compositionRootSearchResponse'
-    - $ref: '../../../common/schemas/SearchResponse.yml#/rootSearchResponse'
+    - $ref: '#/compositionBaseSearchResponse'
     - $ref: '#/searchResults'
 
 searchResults:
@@ -75,14 +74,162 @@ resultsInjectedItemInfoResponse:
   required:
     - key
 
-compositionRootSearchResponse:
+# copy of specs/common/schemas/SearchResponse.yml/#baseSearchResponse without appliedRules
+compositionBaseSearchResponse:
   type: object
   additionalProperties: true
+  required:
+    - processingTimeMS
   properties:
     compositions:
-      $ref: '#/compositionBaseSearchResponse'
+      $ref: '#/compositionsSearchResponse'
+    abTestID:
+      type: integer
+      description: A/B test ID. This is only included in the response for indices that are part of an A/B test.
+    abTestVariantID:
+      type: integer
+      minimum: 1
+      description: Variant ID. This is only included in the response for indices that are part of an A/B test.
+    aroundLatLng:
+      type: string
+      description: Computed geographical location.
+      example: '40.71,-74.01'
+      pattern: ^(-?\d+(\.\d+)?),\s*(-?\d+(\.\d+)?)$
+    automaticRadius:
+      type: string
+      description: Distance from a central coordinate provided by `aroundLatLng`.
+    exhaustive:
+      title: exhaustive
+      type: object
+      description: Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
+      properties:
+        facetsCount:
+          type: boolean
+          title: facetsCount
+          description: Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
+        facetValues:
+          type: boolean
+          title: facetValues
+          description: The value is `false` if not all facet values are retrieved.
+        nbHits:
+          type: boolean
+          title: nbHits
+          description: Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
+        rulesMatch:
+          type: boolean
+          title: rulesMatch
+          description: Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
+        typo:
+          type: boolean
+          title: typo
+          description: Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+    exhaustiveFacetsCount:
+      type: boolean
+      description: See the `facetsCount` field of the `exhaustive` object in the response.
+      deprecated: true
+    exhaustiveNbHits:
+      type: boolean
+      description: See the `nbHits` field of the `exhaustive` object in the response.
+      deprecated: true
+    exhaustiveTypo:
+      type: boolean
+      description: See the `typo` field of the `exhaustive` object in the response.
+      deprecated: true
+    facets:
+      title: facets
+      type: object
+      additionalProperties:
+        x-additionalPropertiesName: facet
+        type: object
+        additionalProperties:
+          x-additionalPropertiesName: facet count
+          type: integer
+      description: Facet counts.
+      example:
+        category:
+          food: 1
+          tech: 42
+    facets_stats:
+      type: object
+      description: Statistics for numerical facets.
+      additionalProperties:
+        title: facetStats
+        type: object
+        properties:
+          min:
+            type: number
+            format: double
+            description: Minimum value in the results.
+          max:
+            type: number
+            format: double
+            description: Maximum value in the results.
+          avg:
+            type: number
+            format: double
+            description: Average facet value in the results.
+          sum:
+            type: number
+            format: double
+            description: Sum of all values in the results.
+    index:
+      type: string
+      example: indexName
+      description: Index name used for the query.
+    indexUsed:
+      type: string
+      description: Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
+      example: indexNameAlt
+    message:
+      type: string
+      description: Warnings about the query.
+    nbSortedHits:
+      type: integer
+      description: Number of hits selected and sorted by the relevant sort algorithm.
+      example: 20
+    parsedQuery:
+      type: string
+      description: Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
+      example: 'george clo'
+    processingTimeMS:
+      $ref: '../../../common/schemas/SearchResponse.yml#/processingTimeMS'
+    processingTimingsMS:
+      type: object
+      description: Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
+    queryAfterRemoval:
+      type: string
+      description: Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
+    redirect:
+      title: redirect
+      type: object
+      description: |
+        [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
+      properties:
+        index:
+          type: array
+          items:
+            $ref: '../../../common/schemas/SearchResponse.yml#/RedirectRuleIndexMetadata'
+    renderingContent:
+      $ref: '../../../common/schemas//IndexSettings.yml#/renderingContent'
+    serverTimeMS:
+      type: integer
+      description: Time the server took to process the request, in milliseconds.
+      example: 20
+    serverUsed:
+      type: string
+      description: Host name of the server that processed the request.
+      example: 'c2-uk-3.algolia.net'
+    userData:
+      $ref: '../../../common/schemas//IndexSettings.yml#/userData'
+    queryID:
+      type: string
+      description: Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
+      example: 'a00dbc80a8d13c4565a442e7e2dca80a'
+    _automaticInsights:
+      type: boolean
+      description: Whether automatic events collection is enabled for the application.
 
-compositionBaseSearchResponse:
+compositionsSearchResponse:
   type: object
   additionalProperties: true
   properties:
@@ -111,4 +258,3 @@ compositionRunSearchResponse:
           - objectID
   required:
     - objectID
-    - appliedRules
