[Docs] [Console] Fixed/updated documentation links in Dev Tools conso…

…le (#3724) (#3986) * Update console documentation links to corresponding documentation pages * Update console documentation links to https://opensearch.org/docs/ because corresponding pages are missing/not yet written in documentation * Update console documentation links for component_template delete, get and exists * Update console documentation links for info.json and ping.json to index page https://opensearch.org/docs/ * Fix: added missing documentation links to get_script_context and get_script_languages * Update links to processors in comments to their working documentation pages * Update links to processors with no corresponding pages in documentation to the general page about processors https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/ * Update CHANGELOG.md * Update cluster.* links with missing docs to https://opensearch.org/docs/latest/api-reference/cluster-api/index/ * Update indices.* links with missing docs to https://opensearch.org/docs/latest/api-reference/index-apis/index/ * Update links with anchor # if applicable * Update links Co-authored-by: Zhongnan Su <[email protected]> --------- Signed-off-by: Sirazh Gabdullin <[email protected]> Co-authored-by: Zhongnan Su <[email protected]> Co-authored-by: Josh Romero <[email protected]> (cherry picked from commit 01a0baf) Co-authored-by: Sirazh Gabdullin <[email protected]> Co-authored-by: Qingyang(Abby) Hu <[email protected]>
opensearch-project · May 26, 2023 · 916c096 · 916c096
1 parent d71c377
commit 916c096
Show file tree

Hide file tree

Showing 153 changed files with 649 additions and 291 deletions.
diff --git a/src/plugins/console/server/lib/spec_definitions/js/ingest.ts b/src/plugins/console/server/lib/spec_definitions/js/ingest.ts
@@ -41,7 +41,7 @@ const commonPipelineParams = {
   tag: '',
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/append-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const appendProcessorDefinition = {
   append: {
     __template: {
@@ -54,7 +54,7 @@ const appendProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/bytes-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const bytesProcessorDefinition = {
   bytes: {
     __template: {
@@ -69,7 +69,7 @@ const bytesProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/ingest-circle-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const circleProcessorDefinition = {
   circle: {
     __template: {
@@ -90,7 +90,7 @@ const circleProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/csv-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/csv/
 const csvProcessorDefinition = {
   csv: {
     __template: {
@@ -112,7 +112,7 @@ const csvProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/convert-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const convertProcessorDefinition = {
   convert: {
     __template: {
@@ -131,7 +131,7 @@ const convertProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/date-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/date/
 const dateProcessorDefinition = {
   date: {
     __template: {
@@ -147,7 +147,7 @@ const dateProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/date-index-name-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const dateIndexNameProcessorDefinition = {
   date_index_name: {
     __template: {
@@ -166,7 +166,7 @@ const dateIndexNameProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/dissect-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const dissectProcessorDefinition = {
   dissect: {
     __template: {
@@ -183,7 +183,7 @@ const dissectProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/dot-expand-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const dotExpanderProcessorDefinition = {
   dot_expander: {
     __template: {
@@ -195,15 +195,15 @@ const dotExpanderProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/drop-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const dropProcessorDefinition = {
   drop: {
     __template: {},
     ...commonPipelineParams,
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/fail-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const failProcessorDefinition = {
   fail: {
     __template: {
@@ -214,7 +214,7 @@ const failProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/foreach-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const foreachProcessorDefinition = {
   foreach: {
     __template: {
@@ -229,7 +229,7 @@ const foreachProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/geoip-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const geoipProcessorDefinition = {
   geoip: {
     __template: {
@@ -248,7 +248,7 @@ const geoipProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/grok-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/grok/
 const grokProcessorDefinition = {
   grok: {
     __template: {
@@ -268,7 +268,7 @@ const grokProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/gsub-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const gsubProcessorDefinition = {
   gsub: {
     __template: {
@@ -283,7 +283,7 @@ const gsubProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/htmlstrip-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const htmlStripProcessorDefinition = {
   html_strip: {
     __template: {
@@ -298,7 +298,7 @@ const htmlStripProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/inference-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const inferenceProcessorDefinition = {
   inference: {
     __template: {
@@ -314,7 +314,7 @@ const inferenceProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/join-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const joinProcessorDefinition = {
   join: {
     __template: {
@@ -327,7 +327,7 @@ const joinProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/json-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/parse-json/
 const jsonProcessorDefinition = {
   json: {
     __template: {
@@ -342,7 +342,7 @@ const jsonProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/kv-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const kvProcessorDefinition = {
   kv: {
     __template: {
@@ -362,7 +362,7 @@ const kvProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/lowercase-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/lowercase-string/
 const lowercaseProcessorDefinition = {
   lowercase: {
     __template: {
@@ -376,7 +376,7 @@ const lowercaseProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/pipeline-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const pipelineProcessorDefinition = {
   pipeline: {
     __template: {
@@ -387,7 +387,7 @@ const pipelineProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/remove-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const removeProcessorDefinition = {
   remove: {
     __template: {
@@ -398,7 +398,7 @@ const removeProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/rename-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const renameProcessorDefinition = {
   rename: {
     __template: {
@@ -414,7 +414,7 @@ const renameProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/script-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const scriptProcessorDefinition = {
   script: {
     __template: {},
@@ -427,7 +427,7 @@ const scriptProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/set-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const setProcessorDefinition = {
   set: {
     __template: {
@@ -443,7 +443,7 @@ const setProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/ingest-node-set-security-user-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const setSecurityUserProcessorDefinition = {
   set_security_user: {
     __template: {
@@ -455,7 +455,7 @@ const setSecurityUserProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/split-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/split-string/
 const splitProcessorDefinition = {
   split: {
     __template: {
@@ -471,7 +471,7 @@ const splitProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/sort-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const sortProcessorDefinition = {
   sort: {
     __template: {
@@ -483,7 +483,7 @@ const sortProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/trim-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/trim-string/
 const trimProcessorDefinition = {
   trim: {
     __template: {
@@ -497,7 +497,7 @@ const trimProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/uppercase-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/uppercase-string/
 const uppercaseProcessorDefinition = {
   uppercase: {
     __template: {
@@ -511,7 +511,7 @@ const uppercaseProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/urldecode-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const urlDecodeProcessorDefinition = {
   urldecode: {
     __template: {
@@ -526,7 +526,7 @@ const urlDecodeProcessorDefinition = {
   },
 };
 
-// Based on https://opensearch.org/docs/latest/guide/en/elasticsearch/reference/master/user-agent-processor.html
+// Based on https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/processors/processors/
 const userAgentProcessorDefinition = {
   user_agent: {
     __template: {

diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/bulk.json b/src/plugins/console/server/lib/spec_definitions/json/generated/bulk.json
@@ -24,6 +24,6 @@
       "{indices}/_bulk",
       "{indices}/{type}/_bulk"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/document-apis/bulk/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/document-apis/bulk/"
   }
-}
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.aliases.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.aliases.json
@@ -22,6 +22,6 @@
       "_cat/aliases",
       "_cat/aliases/{name}"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-aliases/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-aliases/"
   }
-}
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.allocation.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.allocation.json
@@ -29,6 +29,6 @@
       "_cat/allocation",
       "_cat/allocation/{nodes}"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-allocation/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-allocation/"
   }
-}
+}
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
@@ -0,0 +1,20 @@
+{
+  "cat.cluster_manager": {
+    "url_params": {
+      "format": "",
+      "local": "__flag__",
+      "cluster_manager_timeout": "",
+      "h": [],
+      "help": "__flag__",
+      "s": [],
+      "v": "__flag__"
+    },
+    "methods": [
+      "GET"
+    ],
+    "patterns": [
+      "_cat/cluster_manager"
+    ],
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-cluster_manager/"
+  }
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.count.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.count.json
@@ -14,6 +14,6 @@
       "_cat/count",
       "_cat/count/{indices}"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-count/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-count/"
   }
-}
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.fielddata.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.fielddata.json
@@ -28,6 +28,6 @@
       "_cat/fielddata",
       "_cat/fielddata/{fields}"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-field-data/#cat-fielddata"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-field-data/"
   }
-}
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.health.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.health.json
@@ -23,6 +23,6 @@
     "patterns": [
       "_cat/health"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-health/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-health/"
   }
-}
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.help.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.help.json
@@ -10,6 +10,6 @@
     "patterns": [
       "_cat"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/index/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/index"
   }
-}
+}
diff --git a/src/plugins/console/server/lib/spec_definitions/json/generated/cat.indices.json b/src/plugins/console/server/lib/spec_definitions/json/generated/cat.indices.json
@@ -52,6 +52,6 @@
       "_cat/indices",
       "_cat/indices/{indices}"
     ],
-    "documentation": "https://opensearch.org/docs/latest/opensearch/rest-api/cat/cat-indices/"
+    "documentation": "https://opensearch.org/docs/latest/api-reference/cat/cat-indices/"
   }
-}
+}