add new endpoint for updating sortingStrategy

Author: ben-kalmus

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

@@ -15,23 +15,26 @@ composition:
     behavior:
       $ref: './CompositionBehavior.yml#/compositionBehavior'
     sortingStrategy:
-      type: object
-      description: |
-        A mapping of sorting labels to the indices (or replicas) that implement those sorting rules.
+      $ref: '#/sortingStrategy'
 
-        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 injection targeted index is replaced
-        with the sorting strategy index it is mapped to.
-
-        Up to 20 sorting strategies can be defined.
-      maxItems: 20
-      additionalProperties:
-        type: string
-      example:
-        'Price (asc)': 'products-low-to-high'
-        'Price (desc)': 'products-high-to-low'
-        
   required:
     - objectID
     - behavior
     - name
+
+sortingStrategy:
+  type: object
+  description: |
+    A mapping of sorting labels to the indices (or replicas) that implement those sorting rules.
+
+    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 injection targeted index is replaced
+    with the sorting strategy index it is mapped to.
+
+    Up to 20 sorting strategies can be defined.
+  maxItems: 20
+  additionalProperties:
+    type: string
+  example:
+    'Price (asc)': 'products-low-to-high'
+    'Price (desc)': 'products-high-to-low'

specs/composition/paths/compositions/updateSortingStrategy.yml

@@ -0,0 +1,39 @@
+post:
+  tags:
+    - Compositions
+  operationId: updateCompositionSortingStrategy
+  x-acl:
+    - editSettings
+  summary: Update sortingStrategy for an existing composition
+  description: |
+    Update Update sortingStrategy for an existing composition in the current Algolia application.
+  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

@@ -139,6 +139,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 ###