chore: generated code for commit 005f9ed. [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-java-2/algoliasearch-core/src/main/java/com/algolia/api/SearchClient.java

@@ -426,9 +426,9 @@ export type PartialUpdateObjectProps = {
    */
   objectID: string;
   /**
-   * List of attributes to update.
+   * Map of attribute(s) to update.
    */
-  attributeToUpdate: Array<Record<string, AttributeToUpdate>>;
+  attributesToUpdate: Record<string, AttributeToUpdate>;
   /**
    * Creates the record if it does not exist yet.
    */
@@ -542,7 +542,7 @@ export type SaveRulesProps = {
    * The index in which to perform the request.
    */
   indexName: string;
-  rule: Rule[];
+  rules: Rule[];
   /**
    * When true, changes are also propagated to replicas of the given indexName.
    */

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -1952,15 +1952,15 @@ export function createSearchClient({
      * @param partialUpdateObject - The partialUpdateObject object.
      * @param partialUpdateObject.indexName - The index in which to perform the request.
      * @param partialUpdateObject.objectID - Unique identifier of an object.
-     * @param partialUpdateObject.attributeToUpdate - List of attributes to update.
+     * @param partialUpdateObject.attributesToUpdate - Map of attribute(s) to update.
      * @param partialUpdateObject.createIfNotExists - Creates the record if it does not exist yet.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     partialUpdateObject(
       {
         indexName,
         objectID,
-        attributeToUpdate,
+        attributesToUpdate,
         createIfNotExists,
       }: PartialUpdateObjectProps,
       requestOptions?: RequestOptions
@@ -1977,9 +1977,9 @@ export function createSearchClient({
         );
       }
 
-      if (!attributeToUpdate) {
+      if (!attributesToUpdate) {
         throw new Error(
-          'Parameter `attributeToUpdate` is required when calling `partialUpdateObject`.'
+          'Parameter `attributesToUpdate` is required when calling `partialUpdateObject`.'
         );
       }
 
@@ -1998,7 +1998,7 @@ export function createSearchClient({
         path: requestPath,
         queryParameters,
         headers,
-        data: attributeToUpdate,
+        data: attributesToUpdate,
       };
 
       return transporter.request(request, requestOptions);
@@ -2282,15 +2282,15 @@ export function createSearchClient({
      * @summary Save a batch of rules.
      * @param saveRules - The saveRules object.
      * @param saveRules.indexName - The index in which to perform the request.
-     * @param saveRules.rule - The rule object.
+     * @param saveRules.rules - The rules object.
      * @param saveRules.forwardToReplicas - When true, changes are also propagated to replicas of the given indexName.
      * @param saveRules.clearExistingRules - When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
     saveRules(
       {
         indexName,
-        rule,
+        rules,
         forwardToReplicas,
         clearExistingRules,
       }: SaveRulesProps,
@@ -2302,9 +2302,9 @@ export function createSearchClient({
         );
       }
 
-      if (!rule) {
+      if (!rules) {
         throw new Error(
-          'Parameter `rule` is required when calling `saveRules`.'
+          'Parameter `rules` is required when calling `saveRules`.'
         );
       }
 
@@ -2328,7 +2328,7 @@ export function createSearchClient({
         path: requestPath,
         queryParameters,
         headers,
-        data: rule,
+        data: rules,
       };
 
       return transporter.request(request, requestOptions);

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -1906,7 +1906,7 @@ public function operationIndex(
      *
      * @param string $indexName The index in which to perform the request. (required)
      * @param string $objectID Unique identifier of an object. (required)
-     * @param array $attributeToUpdate List of attributes to update. (required)
+     * @param array $attributesToUpdate Map of attribute(s) to update. (required)
      * @param bool $createIfNotExists Creates the record if it does not exist yet. (optional, default to true)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
      *
@@ -1915,7 +1915,7 @@ public function operationIndex(
     public function partialUpdateObject(
         $indexName,
         $objectID,
-        $attributeToUpdate,
+        $attributesToUpdate,
         $createIfNotExists = null,
         $requestOptions = []
     ) {
@@ -1931,17 +1931,17 @@ public function partialUpdateObject(
                 'Parameter `objectID` is required when calling `partialUpdateObject`.'
             );
         }
-        // verify the required parameter 'attributeToUpdate' is set
-        if (!isset($attributeToUpdate)) {
+        // verify the required parameter 'attributesToUpdate' is set
+        if (!isset($attributesToUpdate)) {
             throw new \InvalidArgumentException(
-                'Parameter `attributeToUpdate` is required when calling `partialUpdateObject`.'
+                'Parameter `attributesToUpdate` is required when calling `partialUpdateObject`.'
             );
         }
 
         $resourcePath = '/1/indexes/{indexName}/{objectID}/partial';
         $queryParameters = [];
         $headers = [];
-        $httpBody = $attributeToUpdate;
+        $httpBody = $attributesToUpdate;
 
         if ($createIfNotExists !== null) {
             $queryParameters['createIfNotExists'] = $createIfNotExists;
@@ -2323,7 +2323,7 @@ public function saveRule(
      * Save a batch of rules.
      *
      * @param string $indexName The index in which to perform the request. (required)
-     * @param array $rule rule (required)
+     * @param array $rules rules (required)
      * @param bool $forwardToReplicas When true, changes are also propagated to replicas of the given indexName. (optional)
      * @param bool $clearExistingRules When true, existing Rules are cleared before adding this batch. When false, existing Rules are kept. (optional)
      * @param array $requestOptions the requestOptions to send along with the query, they will be merged with the transporter requestOptions
@@ -2332,7 +2332,7 @@ public function saveRule(
      */
     public function saveRules(
         $indexName,
-        $rule,
+        $rules,
         $forwardToReplicas = null,
         $clearExistingRules = null,
         $requestOptions = []
@@ -2343,17 +2343,17 @@ public function saveRules(
                 'Parameter `indexName` is required when calling `saveRules`.'
             );
         }
-        // verify the required parameter 'rule' is set
-        if (!isset($rule)) {
+        // verify the required parameter 'rules' is set
+        if (!isset($rules)) {
             throw new \InvalidArgumentException(
-                'Parameter `rule` is required when calling `saveRules`.'
+                'Parameter `rules` is required when calling `saveRules`.'
             );
         }
 
         $resourcePath = '/1/indexes/{indexName}/rules/batch';
         $queryParameters = [];
         $headers = [];
-        $httpBody = $rule;
+        $httpBody = $rules;
 
         if ($forwardToReplicas !== null) {
             $queryParameters['forwardToReplicas'] = $forwardToReplicas;

clients/algoliasearch-client-php/lib/Api/SearchClient.php

@@ -2032,11 +2032,6 @@ components:
         - objectID
         - updatedAt
         - taskID
-    rules:
-      type: array
-      description: Rules to add.
-      items:
-        $ref: '#/components/schemas/rule'
     parameters_query:
       type: string
       description: Full text query.

specs/bundled/algoliasearch.yml

@@ -2032,11 +2032,6 @@ components:
         - objectID
         - updatedAt
         - taskID
-    rules:
-      type: array
-      description: Rules to add.
-      items:
-        $ref: '#/components/schemas/rule'
     parameters_query:
       type: string
       description: Full text query.
@@ -2987,6 +2982,7 @@ paths:
         - search
       operationId: partialUpdateObject
       summary: Partially update an object.
+      x-codegen-request-body-name: attributesToUpdate
       description: >
         Update one or more attributes of an existing object.
 
@@ -3008,16 +3004,14 @@ paths:
             default: true
       requestBody:
         required: true
-        description: List of attributes to update.
+        description: Map of attribute(s) to update.
         content:
           application/json:
             schema:
-              type: array
-              items:
-                type: object
-                description: Attribute to update.
-                additionalProperties:
-                  $ref: '#/components/schemas/attributeToUpdate'
+              type: object
+              description: Attribute(s) to update.
+              additionalProperties:
+                $ref: '#/components/schemas/attributeToUpdate'
       responses:
         '200':
           $ref: '#/components/responses/UpdatedAtWithObjectId'
@@ -3730,6 +3724,7 @@ paths:
       operationId: saveRules
       summary: Save a batch of rules.
       description: Create/update multiple rules objects at once.
+      x-codegen-request-body-name: rules
       parameters:
         - $ref: '#/components/parameters/IndexName'
         - $ref: '#/components/parameters/ForwardToReplicas'
@@ -3739,7 +3734,10 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/rules'
+              type: array
+              description: Rules to add.
+              items:
+                $ref: '#/components/schemas/rule'
       responses:
         '200':
           $ref: '#/components/responses/UpdatedAt'