Fix and tune synonyms API (#2235)

Author: swallez

output/schema/schema.json

@@ -17,9 +17,8 @@
  * under the License.
  */
 
-import { ShardStatistics } from '@_types/Stats'
-import { ReloadDetails } from './types'
+import { ReloadResult } from './types'
 
 export class Response {
-  body: { reload_details: ReloadDetails[]; _shards: ShardStatistics }
+  body: ReloadResult
 }

output/schema/validation-errors.json

@@ -17,6 +17,13 @@
  * under the License.
  */
 
+import { ShardStatistics } from '@_types/Stats'
+
+export class ReloadResult {
+  reload_details: ReloadDetails[]
+  _shards: ShardStatistics
+}
+
 export class ReloadDetails {
   index: string
   reloaded_analyzers: string[]

output/typescript/types.ts

@@ -18,11 +18,12 @@
  */
 
 import { Id } from '@_types/common'
+import { OverloadOf } from '@spec_utils/behaviors'
 
 export type SynonymString = string
 
 // Synonym Rule with optional ID, used for PUT method
-export class SynonymRuleOptionalId {
+export class SynonymRule {
   /**
    * Synonym Rule identifier
    */
@@ -34,9 +35,13 @@ export class SynonymRuleOptionalId {
 }
 
 // Synonym Rule with mandatory ID, used for responses (which always include it)
-export class SynonymRule extends SynonymRuleOptionalId {
+export class SynonymRuleRead implements OverloadOf<SynonymRule> {
   /**
    * Synonym Rule identifier
    */
   id: Id
+  /**
+   * Synonyms, in Solr format, that conform the synonym rule. See https://www.elastic.co/guide/en/elasticsearch/reference/current/analysis-synonym-graph-tokenfilter.html#_solr_synonyms_2
+   */
+  synonyms: SynonymString
 }

specification/indices/reload_search_analyzers/ReloadSearchAnalyzersResponse.ts

@@ -18,8 +18,7 @@
  */
 
 import { Result } from '@_types/Result'
-import { ReloadDetails } from '@indices/reload_search_analyzers/types'
-import { ShardStatistics } from '@_types/Stats'
+import { ReloadResult } from '@indices/reload_search_analyzers/types'
 
 export class SynonymsUpdateResult {
   /**
@@ -31,6 +30,5 @@ export class SynonymsUpdateResult {
    * Updating synonyms in a synonym set reloads the associated analyzers.
    * This is the analyzers reloading result
    */
-  reload_analyzers_details: ReloadDetails[]
-  _shards: ShardStatistics
+  reload_analyzers_details: ReloadResult
 }

specification/indices/reload_search_analyzers/types.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 import { RequestBase } from '@_types/Base'
-import { Name } from '@_types/common'
+import { Id } from '@_types/common'
 
 /**
  * Deletes a synonym set
@@ -30,6 +30,6 @@ interface Request extends RequestBase {
     /**
      * The id of the synonyms set to be deleted
      */
-    id: Name
+    id: Id
   }
 }

specification/synonyms/_types/SynonymRule.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 import { RequestBase } from '@_types/Base'
-import { Name } from '@_types/common'
+import { Id } from '@_types/common'
 
 /**
  * Deletes a synonym rule in a synonym set
@@ -30,11 +30,11 @@ interface Request extends RequestBase {
     /**
      * The id of the synonym set to be updated
      */
-    set_id: Name
+    set_id: Id
 
     /**
      * The id of the synonym rule to be deleted
      */
-    rule_id: Name
+    rule_id: Id
   }
 }

specification/synonyms/_types/SynonymsSet.ts

@@ -17,8 +17,7 @@
  * under the License.
  */
 import { RequestBase } from '@_types/Base'
-import { Name } from '@_types/common'
-import { SynonymsSet } from '../_types/SynonymsSet'
+import { Id } from '@_types/common'
 import { integer } from '@_types/Numeric'
 
 /**
@@ -32,15 +31,17 @@ interface Request extends RequestBase {
     /**
      * "The id of the synonyms set to be retrieved
      */
-    id: Name
+    id: Id
   }
   query_parameters: {
     /**
-     * Starting offset for query rules to be retrieved (default: 0)
+     * Starting offset for query rules to be retrieved
+     * @server_default 0
      */
     from?: integer
     /**
-     * specifies a max number of query rules to retrieve (default: 10)
+     * specifies a max number of query rules to retrieve
+     * @server_default 10
      */
     size?: integer
   }

specification/synonyms/_types/SynonymsUpdateResult.ts

@@ -17,15 +17,12 @@
  * under the License.
  */
 
-import { Result } from '@_types/Result'
-import { ReloadDetails } from '@indices/reload_search_analyzers/types'
-import { ShardStatistics } from '@_types/Stats'
 import { integer } from '@_types/Numeric'
-import { SynonymsSet } from '../_types/SynonymsSet'
+import { SynonymRuleRead } from '../_types/SynonymRule'
 
 export class Response {
   body: {
     count: integer
-    synonyms_set: SynonymsSet
+    synonyms_set: SynonymRuleRead[]
   }
 }

specification/synonyms/delete_synonym/SynonymsDeleteRequest.ts

@@ -17,7 +17,7 @@
  * under the License.
  */
 import { RequestBase } from '@_types/Base'
-import { Name } from '@_types/common'
+import { Id } from '@_types/common'
 
 /**
  * Retrieves a synonym rule from a synonym set
@@ -30,11 +30,11 @@ interface Request extends RequestBase {
     /**
      * The id of the synonym set to retrieve the synonym rule from
      */
-    set_id: Name
+    set_id: Id
 
     /**
      * The id of the synonym rule to retrieve
      */
-    rule_id: Name
+    rule_id: Id
   }
 }