Synonyms API - Add refresh parameter (#4298)

Author: carlosdelest

output/openapi/elasticsearch-openapi.json

@@ -27,8 +27,8 @@ export class SynonymsUpdateResult {
   result: Result
 
   /**
-   * Updating synonyms in a synonym set reloads the associated analyzers.
+   * Updating synonyms in a synonym set can reload the associated analyzers in case refresh is set to true.
    * This information is the analyzers reloading result.
    */
-  reload_analyzers_details: ReloadResult
+  reload_analyzers_details?: ReloadResult
 }

output/openapi/elasticsearch-serverless-openapi.json

@@ -45,4 +45,13 @@ export interface Request extends RequestBase {
      */
     rule_id: Id
   }
+  query_parameters: {
+    /**
+     * If `true`, the request will refresh the analyzers with the deleted synonym rule and wait for the new synonyms to be available before returning.
+     * If `false`, analyzers will not be reloaded with the deleted synonym rule
+     * @server_default true
+     * @availability stack since=9.1.0
+     */
+    refresh?: boolean
+  }
 }

output/schema/schema-serverless.json

@@ -52,4 +52,13 @@ export interface Request extends RequestBase {
      */
     synonyms_set: SynonymRule | SynonymRule[]
   }
+  query_parameters: {
+    /**
+     * If `true`, the request will refresh the analyzers with the new synonyms set and wait for the new synonyms to be available before returning.
+     * If `false`, analyzers will not be reloaded with the new synonym set
+     * @server_default true
+     * @availability stack since=9.1.0
+     */
+    refresh?: boolean
+  }
 }

output/schema/schema.json

@@ -22,7 +22,15 @@ import { Result } from '@_types/Result'
 
 export class Response {
   body: {
+    /**
+     * The update operation result.
+     */
     result: Result
-    reload_analyzers_details: ReloadResult
+
+    /**
+     * Updating a synonyms set can reload the associated analyzers in case refresh is set to true.
+     * This information is the analyzers reloading result.
+     */
+    reload_analyzers_details?: ReloadResult
   }
 }

output/typescript/types.ts

@@ -57,4 +57,13 @@ export interface Request extends RequestBase {
      */
     synonyms: SynonymString
   }
+  query_parameters: {
+    /**
+     * If `true`, the request will refresh the analyzers with the new synonym rule and wait for the new synonyms to be available before returning.
+     * If `false`, analyzers will not be reloaded with the new synonym rule
+     * @server_default true
+     * @availability stack since=9.1.0
+     */
+    refresh?: boolean
+  }
 }