feat(specs): add sortBy query param and sortingStrategy (#5686)

Co-authored-by: Thomas Raffray <Fluf22@users.noreply.github.com>

Author: ben-kalmus

specs/composition/common/params/Composition.yml

@@ -110,3 +110,21 @@ enableABTest:
   default: true
   x-categories:
     - Advanced
+
+# #######################
+# ### Category SortBy ###
+# #######################
+
+sortBy:
+  type: string
+  description: |
+    Indicates which sorting strategy to apply for the request.
+    The value must match one of the labels defined in the "sortingStrategy" mapping. For example, "Price (asc)", see Upsert Composition.
+    At runtime, this label is used to look up the corresponding index or replica configured in "sortingStrategy", and the query is executed using that index instead of main's.
+
+    In addition to "sortingStrategy", this parameter is also used to apply a matching Composition Rule that contains a condition defined to trigger on "sortBy", see Composition Rules.
+
+    If no value is provided or an invalid value, no sorting strategy is applied.
+  default: ''
+  example:
+    'Price (asc)'

specs/composition/common/schemas/components/Composition.yml

@@ -14,7 +14,26 @@ composition:
       example: 'my lovely crafted composition that is used for X purpose'
     behavior:
       $ref: './CompositionBehavior.yml#/compositionBehavior'
+    sortingStrategy:
+      $ref: '#/sortingStrategy'
+
   required:
     - objectID
     - behavior
-    - name
+    - name
+
+sortingStrategy:
+  type: object
+  description: |
+    A mapping of sorting labels to the indices (or replicas) that implement those sorting rules. The sorting indices MUST be related to the associated main targeted index in the composition.
+    Each key is the label your frontend sends at runtime (for example, "Price (asc)"), and each value is the name of the index that should be queried when that label is selected.
+
+    When a request includes a "sortBy" parameter, the platform looks up the corresponding index in this mapping and uses it to execute the query. The main targeted index is replaced
+    with the sorting strategy index it is mapped to.
+
+    Up to 20 sorting strategies can be defined.
+  additionalProperties:
+    type: string
+  example:
+    'Price (asc)': 'products-low-to-high'
+    'Price (desc)': 'products-high-to-low'

specs/composition/common/schemas/requestBodies/RunParams.yml

@@ -53,11 +53,13 @@ params:
       $ref: '../../params/Search.yml#/page'
     query:
       $ref: '../../params/Search.yml#/query'
-    relevancyStrictness:
-      $ref: '../../params/Search.yml#/relevancyStrictness'
     queryLanguages:
       $ref: '../../params/Search.yml#/queryLanguages'
+    relevancyStrictness:
+      $ref: '../../params/Search.yml#/relevancyStrictness'
     ruleContexts:
       $ref: '../../params/Composition.yml#/ruleContexts'
+    sortBy:
+      $ref: '../../params/Composition.yml#/sortBy'
     userToken:
       $ref: '../../params/Search.yml#/userToken'

specs/composition/paths/compositions/updateSortingStrategy.yml

@@ -0,0 +1,46 @@
+post:
+  tags:
+    - Compositions
+  operationId: updateSortingStrategyComposition
+  x-acl:
+    - editSettings
+  summary: Set or update the "sortingStrategy" configuration for an existing composition
+  description: |
+    Updates the "sortingStrategy" field of an existing composition.
+    This endpoint allows you to create a new sorting strategy mapping or replace the currently configured one.
+    The provided sorting indices MUST be associated indices or replicas of the main targeted index.
+
+    WARNING: This endpoint cannot validate if the sort index is related to the composition's main index.
+      Validation will fail at runtime if the index you updated is not related!
+
+    The update is applied to the specified composition within the current Algolia application and returns a taskID that can be used to track the operation’s completion.
+  parameters:
+    - $ref: '../urlParams.yml#/compositionID'
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          $ref: '../../common/schemas/components/Composition.yml#/sortingStrategy'
+  responses:
+    '200':
+      description: OK
+      content:
+        application/json:
+          schema:
+            title: taskIDResponse
+            type: object
+            additionalProperties: false
+            properties:
+              taskID:
+                $ref: '../../../common/responses/common.yml#/taskID'
+            required:
+              - taskID
+    '400':
+      $ref: '../../../common/responses/BadRequest.yml'
+    '402':
+      $ref: '../../../common/responses/FeatureNotEnabled.yml'
+    '403':
+      $ref: '../../../common/responses/MethodNotAllowed.yml'
+    '404':
+      $ref: '../../../common/responses/CompositionNotFound.yml'

specs/composition/spec.yml

@@ -136,6 +136,8 @@ paths:
     $ref: 'paths/compositions/composition.yml'
   /1/compositions/*/batch:
     $ref: 'paths/compositions/batch.yml'
+  /1/compositions/{compositionID}/sortingStrategy:
+    $ref: 'paths/compositions/updateSortingStrategy.yml'
 
   # ##########################################
   # ### Manage Composition Rules Endpoints ###

tests/CTS/requests/composition/putComposition.json

@@ -361,5 +361,53 @@
         }
       }
     }
+  },
+
+  {
+    "parameters": {
+      "compositionID": "my-compo",
+      "composition": {
+        "objectID": "my-compo",
+        "name": "my composition",
+        "sortingStrategy": {
+          "Price-asc": "products-low-to-high",
+          "Price-desc": "products-high-to-low"
+        },
+        "behavior": {
+          "injection": {
+            "main": {
+              "source": {
+                "search": {
+                  "index": "products"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "request": {
+      "path": "/1/compositions/my-compo",
+      "method": "PUT",
+      "body": {
+        "objectID": "my-compo",
+        "name": "my composition",
+        "sortingStrategy": {
+          "Price-asc": "products-low-to-high",
+          "Price-desc": "products-high-to-low"
+        },
+        "behavior": {
+          "injection": {
+            "main": {
+              "source": {
+                "search": {
+                  "index": "products"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
   }
 ]

tests/CTS/requests/composition/search.json

@@ -79,5 +79,27 @@
         }
       }
     }
+  },
+
+  {
+    "parameters": {
+      "compositionID": "foo",
+      "requestBody": {
+        "params": {
+          "query": "batman",
+          "sortBy": "Price (asc)"
+        }
+      }
+    },
+    "request": {
+      "path": "/1/compositions/foo/run",
+      "method": "POST",
+      "body": {
+        "params": {
+          "query": "batman",
+          "sortBy": "Price (asc)"
+        }
+      }
+    }
   }
 ]

tests/CTS/requests/composition/updateSortingStrategyComposition.json

@@ -0,0 +1,19 @@
+[
+  {
+    "parameters": {
+      "compositionID": "my-compo",
+      "requestBody": {
+        "Price-asc": "products-low-to-high",
+        "Price-desc": "products-high-to-low"
+      }
+    },
+    "request": {
+      "path": "/1/compositions/my-compo/sortingStrategy",
+      "method": "POST",
+      "body": {
+        "Price-asc": "products-low-to-high",
+        "Price-desc": "products-high-to-low"
+      }
+    }
+  }
+]