feat(specs): update composition specs according to upcoming API chang…

…es (#4234) Co-authored-by: shortcuts <vannicattec@gmail.com>
algolia · Dec 18, 2024 · 448aad7 · 448aad7
1 parent 9002538
commit 448aad7
Show file tree

Hide file tree

Showing 8 changed files with 143 additions and 53 deletions.
diff --git a/playground/javascript/node/composition.ts b/playground/javascript/node/composition.ts
@@ -9,36 +9,35 @@ const client = compositionClient(appId, apiKey);
 
 async function testComposition() {
   try {
+    console.log(appId, apiKey)
     // create a new composition
-    /*
-    const res = await client.multipleBatch({
-      requests: [
-        {
-          action: 'upsert',
-          body: {
-            objectID: 'id1',
-            description: 'the first ever composition from the client',
-            behavior: {
-              injection: {
-                main: {
-                  source: {
-                    search: {
-                      index: 'cts_e2e_small',
-                    },
-                  },
-                },
-              },
-            },
-          },
-        },
-      ],
-    });
-    console.log(`[OK]`, res);
-    */
+    // const res = await client.multipleBatch({
+    //   requests: [
+    //     {
+    //       action: 'upsert',
+    //       body: {
+    //         objectID: 'id1',
+    //         name: 'my first composition',
+    //         description: 'the first ever composition from the client',
+    //         behavior: {
+    //           injection: {
+    //             main: {
+    //               source: {
+    //                 search: {
+    //                   index: 'cts_e2e_small',
+    //                 },
+    //               },
+    //             },
+    //           },
+    //         },
+    //       },
+    //     },
+    //   ],
+    // });
+    // console.log(`[OK]`, res);
 
-    const compos = await client.listCompositions();
+    console.log(await client.listCompositions())
 
-    console.log(`[OK]`, compos);
   } catch (e) {
     if (e instanceof ApiError) {
       return console.log(`[${e.status}] ${e.message}`, e.stackTrace, e);

diff --git a/specs/composition/common/schemas/Hit.yml b/specs/composition/common/schemas/Hit.yml
@@ -32,12 +32,14 @@ compositionRankingInfo:
     composed:
       title: composedRankingInfo
       type: object
-      additionalProperties: false
-      properties:
-        index:
-          type: string
-        inset:
-          type: string
-      required:
-        - index
-        - inset
+      additionalProperties:
+        title: compositionIdRankingInfo
+        type: object
+        properties:
+          index:
+            type: string
+          injectedItemKey:
+            type: string
+        required:
+          - index
+          - injectedItemKey
diff --git a/specs/composition/common/schemas/SearchParams.yml b/specs/composition/common/schemas/SearchParams.yml
@@ -657,8 +657,8 @@ mainInjectionQueryParameters:
       x-categories:
         - Filtering
 
-InsetsQueryParameters:
-  title: Composition Insets Query parameters as object
+injectedItemsQueryParameters:
+  title: Composition injectedItems Query parameters as object
   type: object
   additionalProperties: false
   properties:

diff --git a/specs/composition/common/schemas/SearchResponse.yml b/specs/composition/common/schemas/SearchResponse.yml
@@ -1,7 +1,7 @@
 searchResponse:
   additionalProperties: true
   allOf:
-    - $ref: '../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
+    - $ref: '#/compositionBaseSearchResponse'
     - $ref: '#/searchResults'
 
 searchResults:
@@ -16,8 +16,10 @@ searchResults:
 
 searchResultsItem:
   allOf:
-    - $ref: '#/searchHits'
+    - $ref: '../../../common/schemas/SearchResponse.yml#/baseSearchResponse'
     - $ref: '../../../common/schemas/SearchResponse.yml#/SearchPagination'
+    - $ref: '#/searchHits'
+    - $ref: '#/resultsCompositionsResponse'
 
 searchHits:
   type: object
@@ -33,3 +35,82 @@ searchHits:
         $ref: 'Hit.yml#/hit'
   required:
     - hits
+
+resultsCompositionsResponse:
+  type: object
+  additionalProperties: true
+  properties:
+    compositions:
+      title: resultsCompositionsInfoResponse
+      type: object
+      additionalProperties:
+        title: resultsCompositionInfoResponse
+        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
+  additionalProperties: true
+  required:
+    - processingTimeMS
+  properties:
+    compositions:
+      $ref: '#/compositionsSearchResponse'
+
+compositionsSearchResponse:
+  type: object
+  additionalProperties: true
+  properties:
+    run:
+      type: array
+      items:
+        $ref: '#/compositionRunSearchResponse'
+  required:
+    - run
+
+compositionRunSearchResponse:
+  type: object
+  additionalProperties: true
+  properties:
+    objectID:
+      $ref: '../../../common/parameters.yml#/objectID'
+    appliedRules:
+      type: array
+      items:
+        title: compositionRunAppliedRules
+        type: object
+        properties:
+          objectID:
+            $ref: '../../../common/parameters.yml#/objectID'
+        required:
+          - objectID
+  required:
+    - objectID
diff --git a/specs/composition/common/schemas/compositionBehavior.yml b/specs/composition/common/schemas/compositionBehavior.yml
@@ -34,32 +34,32 @@ compositionBehavior:
                 - search
           required:
             - source
-        insets:
+        injectedItems:
           type: array
-          description: list of insets of the current Composition.
+          description: list of injected items of the current Composition.
           minItems: 0
           maxItems: 2
           items:
-            $ref: '#/compositionInset'
+            $ref: '#/injectedItem'
       required:
         - main
   required:
     - injection
 
-compositionInset:
+injectedItem:
   type: object
   additionalProperties: false
   properties:
-    name:
+    key:
       type: string
-      description: Inset name.
+      description: injected Item unique identifier.
     source:
-      title: compositionInsetSource
+      title: injectedItemSource
       type: object
       additionalProperties: false
       properties:
         search:
-          title: compositionInsetSourceSearch
+          title: injectedItemSourceSearch
           type: object
           additionalProperties: false
           properties:
@@ -68,7 +68,7 @@ compositionInset:
               description: Composition Main Index name.
               example: Products
             params:
-              $ref: './SearchParams.yml#/InsetsQueryParameters'
+              $ref: './SearchParams.yml#/injectedItemsQueryParameters'
           required:
             - index
       required:
@@ -82,7 +82,7 @@ compositionInset:
       minimum: 0
       maximum: 20
   required:
-    - name
+    - key
     - source
     - position
     - length
diff --git a/specs/composition/common/schemas/listCompositionsResponse.yml b/specs/composition/common/schemas/listCompositionsResponse.yml
@@ -21,12 +21,17 @@ composition:
   properties:
     objectID:
       $ref: '../../../common/parameters.yml#/objectID'
-    description:
+    name:
       type: string
       description: Composition name.
       example: 'my lovely crafted composition'
+    description:
+      type: string
+      description: Composition description.
+      example: 'my lovely crafted composition that is used for X purpose'
     behavior:
       $ref: './compositionBehavior.yml#/compositionBehavior'
   required:
     - objectID
     - behavior
+    - name
diff --git a/tests/CTS/requests/composition/listCompositions.json b/tests/CTS/requests/composition/listCompositions.json
@@ -18,6 +18,7 @@
         "items": [
           {
             "objectID": "id1",
+            "name": "my first composition",
             "description": "the first ever composition from the client",
             "behavior": {
               "injection": {

diff --git a/tests/CTS/requests/composition/multipleBatch.json b/tests/CTS/requests/composition/multipleBatch.json
@@ -6,6 +6,7 @@
           "action": "upsert",
           "body": {
             "objectID": "foo",
+            "name": "my first composition",
             "behavior": {
               "injection": {
                 "main": {
@@ -15,7 +16,7 @@
                     }
                   }
                 },
-                "insets": []
+                "injectedItems": []
               }
             }
           }
@@ -38,7 +39,7 @@
             "body": {
               "behavior": {
                 "injection": {
-                  "insets": [],
+                  "injectedItems": [],
                   "main": {
                     "source": {
                       "search": {
@@ -48,6 +49,7 @@
                   }
                 }
               },
+              "name": "my first composition",
               "objectID": "foo"
             }
           },