From 4ea645e86193de9fd25d6cecf199d48ce033bd55 Mon Sep 17 00:00:00 2001
From: Manasvini B Suryanarayana <manasvis@amazon.com>
Date: Wed, 29 Jun 2022 12:52:39 -0700
Subject: [PATCH] [Deprecation] Deprecate cat master API in favor of cat
 cluster_manager (#1800)

Resolves the issue :
https://github.com/opensearch-project/OpenSearch-Dashboards/issues/1686

Signed-off-by: Manasvini B Suryanarayana <manasvis@amazon.com>
---
 .../server/opensearch/legacy/api_types.ts     |  1 +
 src/core/server/server.api.md                 |  4 +++-
 .../json/generated/cat.cluster_manager.json   | 21 +++++++++++++++++++
 3 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 src/plugins/console/server/lib/spec_definitions/json/generated/cat.cluster_manager.json

diff --git a/src/core/server/opensearch/legacy/api_types.ts b/src/core/server/opensearch/legacy/api_types.ts
index 9fbbe6dd3632..6f2f5f92ab84 100644
--- a/src/core/server/opensearch/legacy/api_types.ts
+++ b/src/core/server/opensearch/legacy/api_types.ts
@@ -232,6 +232,7 @@ export interface LegacyAPICaller {
   (endpoint: 'cat.help', params: CatHelpParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['help']>;
   (endpoint: 'cat.indices', params: CatIndicesParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['indices']>;
   (endpoint: 'cat.master', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['master']>;
+  (endpoint: 'cat.cluster_manager', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['master']>;
   (endpoint: 'cat.nodeattrs', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['nodeattrs']>;
   (endpoint: 'cat.nodes', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['nodes']>;
   (endpoint: 'cat.pendingTasks', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['pendingTasks']>;
diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
index 6061f78557b5..4cfe9f477e74 100644
--- a/src/core/server/server.api.md
+++ b/src/core/server/server.api.md
@@ -1041,9 +1041,11 @@ export interface LegacyAPICaller {
     (endpoint: 'cat.help', params: CatHelpParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['help']>;
     // (undocumented)
     (endpoint: 'cat.indices', params: CatIndicesParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['indices']>;
-    // (undocumented)
+    // @deprecated (undocumented)
     (endpoint: 'cat.master', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['master']>;
     // (undocumented)
+    (endpoint: 'cat.cluster_manager', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['master']>;
+    // (undocumented)
     (endpoint: 'cat.nodeattrs', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['nodeattrs']>;
     // (undocumented)
     (endpoint: 'cat.nodes', params: CatCommonParams, options?: LegacyCallAPIOptions): ReturnType<Client['cat']['nodes']>;
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.cluster_manager.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.cluster_manager.json
new file mode 100644
index 000000000000..16d91c9a1d4b
--- /dev/null
+++ b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.cluster_manager.json
@@ -0,0 +1,21 @@
+{
+  "cat.cluster_manager": {
+    "url_params": {
+      "format": "",
+      "local": "__flag__",
+      "master_timeout": "",
+      "cluster_manager_timeout": "",
+      "h": [],
+      "help": "__flag__",
+      "s": [],
+      "v": "__flag__"
+    },
+    "methods": [
+      "GET"
+    ],
+    "patterns": [
+      "_cat/cluster_manager"
+    ],
+    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-master/"
+  }
+}