Renamed synonyms API namespaces (#2234)

elastic · Aug 11, 2023 · 82a3e5f · 82a3e5f
1 parent d91da1a
commit 82a3e5f
Show file tree

Hide file tree

Showing 24 changed files with 480 additions and 485 deletions.
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/output/schema/validation-errors.json b/output/schema/validation-errors.json
diff --git a/output/typescript/types.ts b/output/typescript/types.ts
diff --git a/...ification/_json_spec/synonyms.delete.json → ...n/_json_spec/synonyms.delete_synonym.json b/...ification/_json_spec/synonyms.delete.json → ...n/_json_spec/synonyms.delete_synonym.json
@@ -1,5 +1,5 @@
 {
-  "synonyms.delete": {
+  "synonyms.delete_synonym": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonyms-set.html",
       "description": "Deletes a synonym set"
@@ -12,12 +12,12 @@
     "url": {
       "paths": [
         {
-          "path": "/_synonyms/{synonyms_set}",
+          "path": "/_synonyms/{id}",
           "methods": ["DELETE"],
           "parts": {
-            "synonyms_set": {
+            "id": {
               "type": "string",
-              "description": "The name of the synonyms set to be deleted"
+              "description": "The id of the synonyms set to be deleted"
             }
           }
         }

diff --git a/...ation/_json_spec/synonym_rule.delete.json → ...on_spec/synonyms.delete_synonym_rule.json b/...ation/_json_spec/synonym_rule.delete.json → ...on_spec/synonyms.delete_synonym_rule.json
@@ -1,5 +1,5 @@
 {
-  "synonym_rule.delete": {
+  "synonyms.delete_synonym_rule": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-synonym-rule.html",
       "description": "Deletes a synonym rule in a synonym set"
@@ -13,14 +13,14 @@
     "url": {
       "paths": [
         {
-          "path": "/_synonyms/{synonyms_set}/{synonym_rule}",
+          "path": "/_synonyms/{set_id}/{rule_id}",
           "methods": ["DELETE"],
           "parts": {
-            "synonyms_set": {
+            "set_id": {
               "type": "string",
               "description": "The id of the synonym set to be updated"
             },
-            "synonym_rule": {
+            "rule_id": {
               "type": "string",
               "description": "The id of the synonym rule to be deleted"
             }

diff --git a/specification/_json_spec/synonyms.get.json → ...tion/_json_spec/synonyms.get_synonym.json b/specification/_json_spec/synonyms.get.json → ...tion/_json_spec/synonyms.get_synonym.json
@@ -1,5 +1,5 @@
 {
-  "synonyms.get": {
+  "synonyms.get_synonym": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonyms-set.html",
       "description": "Retrieves a synonym set"
@@ -12,10 +12,10 @@
     "url": {
       "paths": [
         {
-          "path": "/_synonyms/{synonyms_set}",
+          "path": "/_synonyms/{id}",
           "methods": ["GET"],
           "parts": {
-            "synonyms_set": {
+            "id": {
               "type": "string",
               "description": "The name of the synonyms set to be retrieved"
             }

diff --git a/...fication/_json_spec/synonym_rule.get.json → ..._json_spec/synonyms.get_synonym_rule.json b/...fication/_json_spec/synonym_rule.get.json → ..._json_spec/synonyms.get_synonym_rule.json
@@ -1,5 +1,5 @@
 {
-  "synonym_rule.get": {
+  "synonyms.get_synonym_rule": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-synonym-rule.html",
       "description": "Retrieves a synonym rule from a synonym set"
@@ -13,14 +13,14 @@
     "url": {
       "paths": [
         {
-          "path": "/_synonyms/{synonyms_set}/{synonym_rule}",
+          "path": "/_synonyms/{set_id}/{rule_id}",
           "methods": ["GET"],
           "parts": {
-            "synonyms_set": {
+            "set_id": {
               "type": "string",
               "description": "The id of the synonym set to retrieve the synonym rule from"
             },
-            "synonym_rule": {
+            "rule_id": {
               "type": "string",
               "description": "The id of the synonym rule to retrieve"
             }

diff --git a/...ication/_json_spec/synonyms_sets.get.json → ...json_spec/synonyms.get_synonyms_sets.json b/...ication/_json_spec/synonyms_sets.get.json → ...json_spec/synonyms.get_synonyms_sets.json
@@ -1,5 +1,5 @@
 {
-  "synonyms_sets.get": {
+  "synonyms.get_synonyms_sets": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/list-synonyms-sets.html",
       "description": "Retrieves a summary of all defined synonym sets"

diff --git a/specification/_json_spec/synonyms.put.json → ...tion/_json_spec/synonyms.put_synonym.json b/specification/_json_spec/synonyms.put.json → ...tion/_json_spec/synonyms.put_synonym.json
@@ -1,5 +1,5 @@
 {
-  "synonyms.put": {
+  "synonyms.put_synonym": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonyms-set.html",
       "description": "Creates or updates a synonyms set"
@@ -13,12 +13,12 @@
     "url": {
       "paths": [
         {
-          "path": "/_synonyms/{synonyms_set}",
+          "path": "/_synonyms/{id}",
           "methods": ["PUT"],
           "parts": {
-            "synonyms_set": {
+            "id": {
               "type": "string",
-              "description": "The name of the synonyms set to be created or updated"
+              "description": "The id of the synonyms set to be created or updated"
             }
           }
         }

diff --git a/...fication/_json_spec/synonym_rule.put.json → ..._json_spec/synonyms.put_synonym_rule.json b/...fication/_json_spec/synonym_rule.put.json → ..._json_spec/synonyms.put_synonym_rule.json
@@ -1,5 +1,5 @@
 {
-  "synonym_rule.put": {
+  "synonyms.put_synonym_rule": {
     "documentation": {
       "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-synonym-rule.html",
       "description": "Creates or updates a synonym rule in a synonym set"
@@ -13,14 +13,14 @@
     "url": {
       "paths": [
         {
-          "path": "/_synonyms/{synonyms_set}/{synonym_rule}",
+          "path": "/_synonyms/{set_id}/{rule_id}",
           "methods": ["PUT"],
           "parts": {
-            "synonyms_set": {
+            "set_id": {
               "type": "string",
               "description": "The id of the synonym set to be updated with the synonym rule"
             },
-            "synonym_rule": {
+            "rule_id": {
               "type": "string",
               "description": "The id of the synonym rule to be updated or created"
             }

diff --git a/.../synonyms/delete/SynonymsDeleteRequest.ts → ...s/delete_synonym/SynonymsDeleteRequest.ts b/.../synonyms/delete/SynonymsDeleteRequest.ts → ...s/delete_synonym/SynonymsDeleteRequest.ts
@@ -21,15 +21,15 @@ import { Name } from '@_types/common'
 
 /**
  * Deletes a synonym set
- * @rest_spec_name synonyms.delete
+ * @rest_spec_name synonyms.delete_synonym
  * @availability stack since=8.10.0 stability=experimental
  * @availability serverless stability=experimental visibility=public
  */
 interface Request extends RequestBase {
   path_parts: {
     /**
-     * The name of the synonyms set to be deleted
+     * The id of the synonyms set to be deleted
      */
-    synonyms_set: Name
+    id: Name
   }
 }
diff --git a/...synonyms/delete/SynonymsDeleteResponse.ts → .../delete_synonym/SynonymsDeleteResponse.ts b/...synonyms/delete/SynonymsDeleteResponse.ts → .../delete_synonym/SynonymsDeleteResponse.ts
diff --git a/...m_rule/delete/SynonymRuleDeleteRequest.ts → ..._synonym_rule/SynonymRuleDeleteRequest.ts b/...m_rule/delete/SynonymRuleDeleteRequest.ts → ..._synonym_rule/SynonymRuleDeleteRequest.ts
@@ -21,7 +21,7 @@ import { Name } from '@_types/common'
 
 /**
  * Deletes a synonym rule in a synonym set
- * @rest_spec_name synonym_rule.delete
+ * @rest_spec_name synonyms.delete_synonym_rule
  * @availability stack since=8.10.0 stability=experimental
  * @availability serverless stability=experimental visibility=public
  */
@@ -30,11 +30,11 @@ interface Request extends RequestBase {
     /**
      * The id of the synonym set to be updated
      */
-    synonyms_set: Name
+    set_id: Name
 
     /**
      * The id of the synonym rule to be deleted
      */
-    synonym_rule: Name
+    rule_id: Name
   }
 }
diff --git a/..._rule/delete/SynonymRuleDeleteResponse.ts → ...synonym_rule/SynonymRuleDeleteResponse.ts b/..._rule/delete/SynonymRuleDeleteResponse.ts → ...synonym_rule/SynonymRuleDeleteResponse.ts
@@ -17,7 +17,7 @@
  * under the License.
  */
 
-import { SynonymsUpdateResult } from '../../synonyms/_types/SynonymsUpdateResult'
+import { SynonymsUpdateResult } from '../_types/SynonymsUpdateResult'
 
 export class Response {
   body: SynonymsUpdateResult

diff --git a/...cation/synonyms/get/SynonymsGetRequest.ts → ...ynonyms/get_synonym/SynonymsGetRequest.ts b/...cation/synonyms/get/SynonymsGetRequest.ts → ...ynonyms/get_synonym/SynonymsGetRequest.ts
@@ -23,16 +23,16 @@ import { integer } from '@_types/Numeric'
 
 /**
  * Retrieves a synonym set
- * @rest_spec_name synonyms.get
+ * @rest_spec_name synonyms.get_synonym
  * @availability stack since=8.10.0 stability=experimental
  * @availability serverless stability=experimental visibility=public
  */
 interface Request extends RequestBase {
   path_parts: {
     /**
-     * "The name of the synonyms set to be retrieved
+     * "The id of the synonyms set to be retrieved
      */
-    synonyms_set: Name
+    id: Name
   }
   query_parameters: {
     /**

diff --git a/...ation/synonyms/get/SynonymsGetResponse.ts → ...nonyms/get_synonym/SynonymsGetResponse.ts b/...ation/synonyms/get/SynonymsGetResponse.ts → ...nonyms/get_synonym/SynonymsGetResponse.ts