Merge branch 'main' into clara/fix/ordering-in-payload (generated)

Co-authored-by: Clara Muller <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/client-composition/src/compositionClient.ts

@@ -317,7 +317,6 @@ export function createCompositionClient({
      *
      * Required API Key ACLs:
      *  - editSettings
-     *  - settings
      * @param deleteComposition - The deleteComposition object.
      * @param deleteComposition.compositionID - Unique Composition ObjectID.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -352,7 +351,6 @@ export function createCompositionClient({
      *
      * Required API Key ACLs:
      *  - editSettings
-     *  - settings
      * @param deleteCompositionRule - The deleteCompositionRule object.
      * @param deleteCompositionRule.compositionID - Unique Composition ObjectID.
      * @param deleteCompositionRule.objectID - Unique identifier of a rule object.
@@ -422,6 +420,7 @@ export function createCompositionClient({
      * Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
      *
      * Required API Key ACLs:
+     *  - editSettings
      *  - settings
      * @param getRule - The getRule object.
      * @param getRule.compositionID - Unique Composition ObjectID.
@@ -566,7 +565,6 @@ export function createCompositionClient({
      *
      * Required API Key ACLs:
      *  - editSettings
-     *  - settings
      * @param putComposition - The putComposition object.
      * @param putComposition.compositionID - Unique Composition ObjectID.
      * @param putComposition.composition - The composition object.
@@ -617,7 +615,6 @@ export function createCompositionClient({
      *
      * Required API Key ACLs:
      *  - editSettings
-     *  - settings
      * @param putCompositionRule - The putCompositionRule object.
      * @param putCompositionRule.compositionID - Unique Composition ObjectID.
      * @param putCompositionRule.objectID - Unique identifier of a rule object.

docs/bundled/composition-full.json

@@ -474,8 +474,7 @@
         ],
         "operationId": "putComposition",
         "x-acl": [
-          "editSettings",
-          "settings"
+          "editSettings"
         ],
         "summary": "Upsert a composition",
         "description": "Upsert a composition in the current Algolia application.\n",
@@ -535,8 +534,7 @@
         ],
         "operationId": "deleteComposition",
         "x-acl": [
-          "editSettings",
-          "settings"
+          "editSettings"
         ],
         "summary": "Delete a composition",
         "description": "Delete a composition from the current Algolia application.\n",
@@ -674,6 +672,7 @@
         ],
         "operationId": "getRule",
         "x-acl": [
+          "editSettings",
           "settings"
         ],
         "summary": "Retrieve a rule",
@@ -717,8 +716,7 @@
         ],
         "operationId": "putCompositionRule",
         "x-acl": [
-          "editSettings",
-          "settings"
+          "editSettings"
         ],
         "summary": "Upsert a composition rule",
         "description": "Upsert a Composition Rule for the specified composition ID.\n",
@@ -784,8 +782,7 @@
         ],
         "operationId": "deleteCompositionRule",
         "x-acl": [
-          "editSettings",
-          "settings"
+          "editSettings"
         ],
         "summary": "Delete a Composition Rule",
         "description": "Delete a Composition Rule from the specified Composition ID.\n",
@@ -1295,7 +1292,11 @@
       },
       "getRankingInfo": {
         "type": "boolean",
-        "description": "Whether the run response should include detailed ranking information."
+        "description": "Whether the run response should include detailed ranking information.",
+        "default": false,
+        "x-categories": [
+          "Advanced"
+        ]
       },
       "relevancyStrictness": {
         "type": "integer",
@@ -1649,7 +1650,10 @@
       "enableRules": {
         "type": "boolean",
         "description": "Whether to enable composition rules.",
-        "default": true
+        "default": true,
+        "x-categories": [
+          "Rules"
+        ]
       },
       "ruleContexts": {
         "type": "array",
@@ -1760,7 +1764,7 @@
         "description": "A list of extenrally injected objectID groups into from an external source.\n",
         "default": {},
         "x-categories": [
-          "Advanced"
+          "Retail Media Network"
         ]
       },
       "params": {

docs/bundled/composition-full.yml

@@ -312,7 +312,7 @@ paths:
               --header 'content-type: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
               --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
-              --data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
+              --data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
   /1/compositions/{compositionID}/facets/{facetName}/query:
     post:
       tags:
@@ -411,7 +411,7 @@ paths:
               --header 'content-type: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
               --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
-              --data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
+              --data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
   /1/compositions:
     get:
       tags:
@@ -532,7 +532,6 @@ paths:
       operationId: putComposition
       x-acl:
         - editSettings
-        - settings
       summary: Upsert a composition
       description: |
         Upsert a composition in the current Algolia application.
@@ -653,7 +652,6 @@ paths:
       operationId: deleteComposition
       x-acl:
         - editSettings
-        - settings
       summary: Delete a composition
       description: |
         Delete a composition from the current Algolia application.
@@ -860,6 +858,7 @@ paths:
         - Rules
       operationId: getRule
       x-acl:
+        - editSettings
         - settings
       summary: Retrieve a rule
       description: >
@@ -920,7 +919,6 @@ paths:
       operationId: putCompositionRule
       x-acl:
         - editSettings
-        - settings
       summary: Upsert a composition rule
       description: |
         Upsert a Composition Rule for the specified composition ID.
@@ -1024,7 +1022,6 @@ paths:
       operationId: deleteCompositionRule
       x-acl:
         - editSettings
-        - settings
       summary: Delete a Composition Rule
       description: |
         Delete a Composition Rule from the specified Composition ID.
@@ -1538,6 +1535,9 @@ components:
     getRankingInfo:
       type: boolean
       description: Whether the run response should include detailed ranking information.
+      default: false
+      x-categories:
+        - Advanced
     relevancyStrictness:
       type: integer
       example: 90
@@ -1967,6 +1967,8 @@ components:
       type: boolean
       description: Whether to enable composition rules.
       default: true
+      x-categories:
+        - Rules
     ruleContexts:
       type: array
       items:
@@ -2082,7 +2084,7 @@ components:
         source.
       default: {}
       x-categories:
-        - Advanced
+        - Retail Media Network
     params:
       title: Run composition parameters as object
       type: object

docs/bundled/composition.json

@@ -259,7 +259,11 @@
       },
       "getRankingInfo": {
         "type": "boolean",
-        "description": "Whether the run response should include detailed ranking information."
+        "description": "Whether the run response should include detailed ranking information.",
+        "default": false,
+        "x-categories": [
+          "Advanced"
+        ]
       },
       "relevancyStrictness": {
         "type": "integer",
@@ -613,7 +617,10 @@
       "enableRules": {
         "type": "boolean",
         "description": "Whether to enable composition rules.",
-        "default": true
+        "default": true,
+        "x-categories": [
+          "Rules"
+        ]
       },
       "ruleContexts": {
         "type": "array",
@@ -724,7 +731,7 @@
         "description": "A list of extenrally injected objectID groups into from an external source.\n",
         "default": {},
         "x-categories": [
-          "Advanced"
+          "Retail Media Network"
         ]
       },
       "params": {

docs/bundled/composition.yml

@@ -457,7 +457,7 @@ paths:
               --header 'content-type: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
               --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
-              --data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
+              --data '{"params":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}'
   /1/compositions/{compositionID}/facets/{facetName}/query:
     post:
       tags:
@@ -803,7 +803,7 @@ paths:
               --header 'content-type: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
               --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \
-              --data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":true,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
+              --data '{"params":{"query":"","maxFacetHits":10,"searchQuery":{"query":"","filters":"(category:Book OR category:Ebook) AND _tags:published","page":0,"getRankingInfo":false,"relevancyStrictness":90,"facetFilters":[["category:Book","category:-Movie"],"author:John Doe"],"optionalFilters":["category:Book","author:John Doe"],"numericFilters":[["inStock = 1","deliveryDate < 1441755506"],"price < 1000"],"hitsPerPage":20,"aroundLatLng":"40.71,-74.01","aroundLatLngViaIP":false,"aroundRadius":1,"aroundPrecision":10,"minimumAroundRadius":1,"insideBoundingBox":"lorem","insidePolygon":[[47.3165,4.9665,47.3424,5.0201,47.32,4.9],[40.9234,2.1185,38.643,1.9916,39.2587,2.0104]],"queryLanguages":["es"],"naturalLanguages":[],"enableRules":true,"ruleContexts":["mobile"],"userToken":"test-user-123","clickAnalytics":false,"analytics":true,"analyticsTags":[],"enableABTest":true,"enableReRanking":true,"injectedItems":{}}}}'
 components:
   securitySchemes:
     appId:
@@ -891,6 +891,9 @@ components:
     getRankingInfo:
       type: boolean
       description: Whether the run response should include detailed ranking information.
+      default: false
+      x-categories:
+        - Advanced
     relevancyStrictness:
       type: integer
       example: 90
@@ -1320,6 +1323,8 @@ components:
       type: boolean
       description: Whether to enable composition rules.
       default: true
+      x-categories:
+        - Rules
     ruleContexts:
       type: array
       items:
@@ -1435,7 +1440,7 @@ components:
         source.
       default: {}
       x-categories:
-        - Advanced
+        - Retail Media Network
     params:
       title: Run composition parameters as object
       type: object

specs/bundled/composition-full.yml

@@ -313,7 +313,6 @@ paths:
       operationId: putComposition
       x-acl:
         - editSettings
-        - settings
       summary: Upsert a composition
       description: |
         Upsert a composition in the current Algolia application.
@@ -353,7 +352,6 @@ paths:
       operationId: deleteComposition
       x-acl:
         - editSettings
-        - settings
       summary: Delete a composition
       description: |
         Delete a composition from the current Algolia application.
@@ -446,6 +444,7 @@ paths:
         - composition-full
       operationId: getRule
       x-acl:
+        - editSettings
         - settings
       summary: Retrieve a rule
       description: >
@@ -477,7 +476,6 @@ paths:
       operationId: putCompositionRule
       x-acl:
         - editSettings
-        - settings
       summary: Upsert a composition rule
       description: |
         Upsert a Composition Rule for the specified composition ID.
@@ -520,7 +518,6 @@ paths:
       operationId: deleteCompositionRule
       x-acl:
         - editSettings
-        - settings
       summary: Delete a Composition Rule
       description: |
         Delete a Composition Rule from the specified Composition ID.
@@ -934,6 +931,9 @@ components:
     getRankingInfo:
       type: boolean
       description: Whether the run response should include detailed ranking information.
+      default: false
+      x-categories:
+        - Advanced
     relevancyStrictness:
       type: integer
       example: 90
@@ -1369,6 +1369,8 @@ components:
       type: boolean
       description: Whether to enable composition rules.
       default: true
+      x-categories:
+        - Rules
     ruleContexts:
       type: array
       items:
@@ -1484,7 +1486,7 @@ components:
         source.
       default: {}
       x-categories:
-        - Advanced
+        - Retail Media Network
     params:
       title: Run composition parameters as object
       type: object

specs/bundled/composition.yml

@@ -352,6 +352,9 @@ components:
     getRankingInfo:
       type: boolean
       description: Whether the run response should include detailed ranking information.
+      default: false
+      x-categories:
+        - Advanced
     relevancyStrictness:
       type: integer
       example: 90
@@ -787,6 +790,8 @@ components:
       type: boolean
       description: Whether to enable composition rules.
       default: true
+      x-categories:
+        - Rules
     ruleContexts:
       type: array
       items:
@@ -902,7 +907,7 @@ components:
         source.
       default: {}
       x-categories:
-        - Advanced
+        - Retail Media Network
     params:
       title: Run composition parameters as object
       type: object