fix(specs): Add customSearchParameters to Variant schema, and add direction query param for GET abtests (#5130) (generated) [skip ci]

algolia-bot · leonardogavaudan · shortcuts · algolia-bot · commit 753864993c69 · 2025-07-21T09:28:16.000Z
Co-authored-by: Leonardo Gavaudan &lt;leonardogavaudan@gmail.com&gt;
Co-authored-by: Clément Vannicatte &lt;vannicattec@gmail.com&gt;
diff --git a/clients/algoliasearch-client-javascript/packages/abtesting/model/clientMethodProps.ts b/clients/algoliasearch-client-javascript/packages/abtesting/model/clientMethodProps.ts
@@ -1,5 +1,7 @@
 // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
+import type { Direction } from '../model/direction';
+
 import type { MetricName } from '../model/metricName';
 
 /**
@@ -128,6 +130,10 @@ export type ListABTestsProps = {
    * Index name suffix. Only A/B tests for indices ending with this string are included in the response.
    */
   indexSuffix?: string | undefined;
+  /**
+   * Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
+   */
+  direction?: Direction | undefined;
 };
 
 /**
diff --git a/clients/algoliasearch-client-javascript/packages/abtesting/model/direction.ts b/clients/algoliasearch-client-javascript/packages/abtesting/model/direction.ts
@@ -0,0 +1,6 @@
+// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+/**
+ * Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
+ */
+export type Direction = 'asc' | 'desc';
diff --git a/clients/algoliasearch-client-javascript/packages/abtesting/model/index.ts b/clients/algoliasearch-client-javascript/packages/abtesting/model/index.ts
@@ -10,6 +10,7 @@ export * from './addABTestsVariant';
 export * from './clientMethodProps';
 export * from './createMetric';
 export * from './customSearchParams';
+export * from './direction';
 export * from './effectMetric';
 export * from './emptySearchFilter';
 export * from './errorBase';
diff --git a/clients/algoliasearch-client-javascript/packages/abtesting/model/variant.ts b/clients/algoliasearch-client-javascript/packages/abtesting/model/variant.ts
@@ -30,4 +30,9 @@ export type Variant = {
   metrics: Array<MetricResult>;
 
   metadata?: VariantMetadata | undefined;
+
+  /**
+   * Search parameters applied to this variant when the same index is used for multiple variants. Only present if custom search parameters were provided during test creation.
+   */
+  customSearchParameters?: Record<string, unknown> | undefined;
 };
diff --git a/clients/algoliasearch-client-javascript/packages/abtesting/src/abtestingClient.ts b/clients/algoliasearch-client-javascript/packages/abtesting/src/abtestingClient.ts
@@ -433,10 +433,11 @@ export function createAbtestingClient({
      * @param listABTests.limit - Number of items to return.
      * @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
      * @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
+     * @param listABTests.direction - Sort order for A/B tests by start date. Use \'asc\' for ascending or \'desc\' for descending. Active A/B tests are always listed first.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     listABTests(
-      { offset, limit, indexPrefix, indexSuffix }: ListABTestsProps = {},
+      { offset, limit, indexPrefix, indexSuffix, direction }: ListABTestsProps = {},
       requestOptions: RequestOptions | undefined = undefined,
     ): Promise<ListABTestsResponse> {
       const requestPath = '/3/abtests';
@@ -459,6 +460,10 @@ export function createAbtestingClient({
         queryParameters['indexSuffix'] = indexSuffix.toString();
       }
 
+      if (direction !== undefined) {
+        queryParameters['direction'] = direction.toString();
+      }
+
       const request: Request = {
         method: 'GET',
         path: requestPath,
diff --git a/docs/bundled/abtesting-v3.json b/docs/bundled/abtesting-v3.json
@@ -350,6 +350,15 @@
             "schema": {
               "type": "string"
             }
+          },
+          {
+            "name": "direction",
+            "in": "query",
+            "description": "Sort order for A/B tests by start date.\nUse 'asc' for ascending or 'desc' for descending. Active A/B tests are always listed first.\n",
+            "example": "desc",
+            "schema": {
+              "$ref": "#/components/schemas/direction"
+            }
           }
         ],
         "responses": {
@@ -932,6 +941,15 @@
           }
         }
       },
+      "direction": {
+        "type": "string",
+        "description": "Sort order for A/B tests by start date.\nUse 'asc' for ascending or 'desc' for descending.\nActive A/B tests are always listed first.\n",
+        "enum": [
+          "asc",
+          "desc"
+        ],
+        "example": "desc"
+      },
       "abTestID": {
         "type": "integer",
         "description": "Unique A/B test identifier.",
@@ -1180,6 +1198,14 @@
           },
           "metadata": {
             "$ref": "#/components/schemas/variantMetadata"
+          },
+          "customSearchParameters": {
+            "type": "object",
+            "description": "Search parameters applied to this variant when the same index is used for multiple variants.\nOnly present if custom search parameters were provided during test creation.\n",
+            "example": {
+              "enablePersonalization": true,
+              "personalizationImpact": 50
+            }
           }
         },
         "required": [
diff --git a/docs/bundled/abtesting-v3.yml b/docs/bundled/abtesting-v3.yml
@@ -448,6 +448,16 @@ paths:
           example: _development
           schema:
             type: string
+        - name: direction
+          in: query
+          description: >
+            Sort order for A/B tests by start date.
+
+            Use 'asc' for ascending or 'desc' for descending. Active A/B tests
+            are always listed first.
+          example: desc
+          schema:
+            $ref: '#/components/schemas/direction'
       responses:
         '200':
           description: OK
@@ -513,7 +523,7 @@ paths:
           label: curl
           source: |-
             curl --request GET \
-              --url 'https://analytics.us.algolia.com/3/abtests?offset=0&limit=10&indexPrefix=dev_&indexSuffix=_development' \
+              --url 'https://analytics.us.algolia.com/3/abtests?offset=0&limit=10&indexPrefix=dev_&indexSuffix=_development&direction=desc' \
               --header 'accept: application/json' \
               --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
               --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
@@ -1062,6 +1072,16 @@ components:
         message:
           type: string
           example: Invalid Application-Id or API-Key
+    direction:
+      type: string
+      description: |
+        Sort order for A/B tests by start date.
+        Use 'asc' for ascending or 'desc' for descending.
+        Active A/B tests are always listed first.
+      enum:
+        - asc
+        - desc
+      example: desc
     abTestID:
       type: integer
       description: Unique A/B test identifier.
@@ -1315,6 +1335,17 @@ components:
           $ref: '#/components/schemas/metrics'
         metadata:
           $ref: '#/components/schemas/variantMetadata'
+        customSearchParameters:
+          type: object
+          description: >
+            Search parameters applied to this variant when the same index is
+            used for multiple variants.
+
+            Only present if custom search parameters were provided during test
+            creation.
+          example:
+            enablePersonalization: true
+            personalizationImpact: 50
       required:
         - index
         - description
diff --git a/specs/bundled/abtesting-v3.yml b/specs/bundled/abtesting-v3.yml
@@ -327,6 +327,16 @@ paths:
           example: _development
           schema:
             type: string
+        - name: direction
+          in: query
+          description: >
+            Sort order for A/B tests by start date.
+
+            Use 'asc' for ascending or 'desc' for descending. Active A/B tests
+            are always listed first.
+          example: desc
+          schema:
+            $ref: '#/components/schemas/direction'
       responses:
         '200':
           description: OK
@@ -732,6 +742,16 @@ components:
         message:
           type: string
           example: Invalid Application-Id or API-Key
+    direction:
+      type: string
+      description: |
+        Sort order for A/B tests by start date.
+        Use 'asc' for ascending or 'desc' for descending.
+        Active A/B tests are always listed first.
+      enum:
+        - asc
+        - desc
+      example: desc
     abTestID:
       type: integer
       description: Unique A/B test identifier.
@@ -985,6 +1005,17 @@ components:
           $ref: '#/components/schemas/metrics'
         metadata:
           $ref: '#/components/schemas/variantMetadata'
+        customSearchParameters:
+          type: object
+          description: >
+            Search parameters applied to this variant when the same index is
+            used for multiple variants.
+
+            Only present if custom search parameters were provided during test
+            creation.
+          example:
+            enablePersonalization: true
+            personalizationImpact: 50
       required:
         - index
         - description
