refactor(specs): extract results field in a dedicated directory (#5739)

Author: ClaraMuller

specs/composition/common/schemas/responses/SearchResponse.yml

@@ -12,98 +12,10 @@ searchResults:
       type: array
       description: Search results.
       items:
-        $ref: '#/searchResultsItem'
+        $ref: './runResponseComponents/SingleResultSet.yml#/searchResultsItem'
   required:
     - results
 
-searchResultsItem:
-  allOf:
-    - $ref: '../../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
-    - $ref: '#/SearchPagination'
-    - $ref: '#/searchHits'
-    - $ref: '#/resultsCompositionsResponse'
-
-SearchPagination:
-  type: object
-  additionalProperties: false
-  properties:
-    page:
-      $ref: '../../../../common/schemas/SearchParams.yml#/page'
-    nbHits:
-      $ref: '../../../../common/schemas/SearchResponse.yml#/nbHits'
-    nbPages:
-      $ref: '../../../../common/schemas/SearchResponse.yml#/nbPages'
-    hitsPerPage:
-      $ref: '../../../../common/schemas/IndexSettings.yml#/hitsPerPage'
-  required:
-    - page
-    - nbHits
-    - nbPages
-    - hitsPerPage
-
-searchHits:
-  type: object
-  additionalProperties: true
-  properties:
-    hits:
-      type: array
-      description: |
-        Search results (hits).
-
-        Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
-      items:
-        $ref: 'Hit.yml#/hit'
-    query:
-      $ref: '../../../../common/schemas/SearchParams.yml#/query'
-    params:
-      type: string
-      description: URL-encoded string of all search parameters.
-      example: query=a&hitsPerPage=20
-  required:
-    - hits
-    - query
-    - params
-
-resultsCompositionsResponse:
-  type: object
-  additionalProperties: true
-  properties:
-    compositions:
-      title: resultsCompositionsInfoResponse
-      type: object
-      additionalProperties:
-        title: resultsCompositionInfoResponse
-        x-additionalPropertiesName: composition-id
-        type: object
-        properties:
-          injectedItems:
-            type: array
-            items:
-              $ref: '#/resultsInjectedItemInfoResponse'
-        required:
-          - injectedItems
-  required:
-    - compositions
-
-resultsInjectedItemInfoResponse:
-  type: object
-  additionalProperties: true
-  properties:
-    key:
-      type: string
-    appliedRules:
-      type: array
-      items:
-        title: resultsInjectedItemAppliedRulesInfoResponse
-        type: object
-        properties:
-          objectID:
-            $ref: '../../../../common/parameters.yml#/objectID'
-        required:
-          - objectID
-  required:
-    - key
-
 # copy of specs/common/schemas/SearchResponse.yml/#baseSearchResponse without appliedRules
 compositionBaseSearchResponse:
   type: object

…osition/common/schemas/responses/Hit.yml …/responses/runResponseComponents/Hit.ymlspecs/composition/common/schemas/responses/Hit.yml renamed to specs/composition/common/schemas/responses/runResponseComponents/Hit.yml specs/composition/common/schemas/responses/Hit.yml renamed to specs/composition/common/schemas/responses/runResponseComponents/Hit.yml

@@ -10,15 +10,15 @@ hit:
     - objectID
   properties:
     objectID:
-      $ref: '../../../../common/parameters.yml#/objectID'
+      $ref: '../../../../../common/parameters.yml#/objectID'
     _highlightResult:
-      $ref: '../../../../common/schemas/HighlightResult.yml#/highlightResultMap'
+      $ref: '../../../../../common/schemas/HighlightResult.yml#/highlightResultMap'
     _snippetResult:
-      $ref: '../../../../common/schemas/SnippetResult.yml#/snippetResultMap'
+      $ref: '../../../../../common/schemas/SnippetResult.yml#/snippetResultMap'
     _rankingInfo:
       $ref: '#/rankingInfo'
     _distinctSeqID:
-      $ref: '../../../../common/schemas/Hit.yml#/distinctSeqID'
+      $ref: '../../../../../common/schemas/Hit.yml#/distinctSeqID'
     _extra:
       $ref: '#/hitMetadata'
 
@@ -33,7 +33,7 @@ hitMetadata:
 
 rankingInfo:
   allOf:
-    - $ref: '../../../../common/schemas/Hit.yml#/rankingInfo'
+    - $ref: '../../../../../common/schemas/Hit.yml#/rankingInfo'
     - $ref: '#/compositionRankingInfo'
 
 compositionRankingInfo:
@@ -50,8 +50,12 @@ compositionRankingInfo:
         properties:
           index:
             type: string
+            example: 'products'
           injectedItemKey:
             type: string
+            example: 'sponsored-products'
         required:
           - index
           - injectedItemKey
+      example:
+        'my-composition-to-sponsor-products': {index: 'products', injectedItemKey: 'sponsored-products'}

specs/composition/common/schemas/responses/runResponseComponents/SingleResultSet.yml

@@ -0,0 +1,97 @@
+searchResultsItem:
+  allOf:
+    - $ref: '../../../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
+    - $ref: '#/SearchPagination'
+    - $ref: '#/searchHits'
+    - $ref: '#/resultsCompositionsResponse'
+
+SearchPagination:
+  type: object
+  additionalProperties: false
+  properties:
+    page:
+      type: integer
+      description: The current page of the results.
+      example: 0
+    nbHits:
+      type: integer
+      description: Number of results (hits).
+      example: 20
+    nbPages:
+      type: integer
+      description: Number of pages of results.
+      example: 1
+    hitsPerPage:
+      type: integer
+      description: Number of hits returned per page.
+      example: 20
+  required:
+    - page
+    - nbHits
+    - nbPages
+    - hitsPerPage
+
+searchHits:
+  type: object
+  additionalProperties: true
+  properties:
+    hits:
+      type: array
+      description: |
+        Search results (hits).
+
+        Hits are records from your index that match the search criteria, augmented with additional attributes, such as, for highlighting.
+      items:
+        $ref: 'Hit.yml#/hit'
+    query:
+      type: string
+      description: The search query string.
+      example: shoes
+    params:
+      type: string
+      description: URL-encoded string of all search parameters.
+      example: query=a&hitsPerPage=20
+  required:
+    - hits
+    - query
+    - params
+
+resultsCompositionsResponse:
+  type: object
+  additionalProperties: true
+  properties:
+    compositions:
+      title: resultsCompositionsInfoResponse
+      type: object
+      additionalProperties:
+        title: resultsCompositionInfoResponse
+        x-additionalPropertiesName: composition-id
+        type: object
+        properties:
+          injectedItems:
+            type: array
+            items:
+              $ref: '#/resultsInjectedItemInfoResponse'
+        required:
+          - injectedItems
+  required:
+    - compositions
+
+resultsInjectedItemInfoResponse:
+  type: object
+  additionalProperties: true
+  properties:
+    key:
+      type: string
+    appliedRules:
+      type: array
+      items:
+        title: resultsInjectedItemAppliedRulesInfoResponse
+        type: object
+        properties:
+          objectID:
+            $ref: '../../../../../common/parameters.yml#/objectID'
+        required:
+          - objectID
+  required:
+    - key