[Rename] kbn-spec-to-console in packages directory to osd-spec-to-con…

…sole #37 (#57) * [Rename] kbn-spec-to-console in packages directory to osd-spec-to-console Signed-off-by: Mihir Soni <mihirsoni.123@gmail.com> * [Rename] in-corporate review comments Signed-off-by: Mihir Soni <mihirsoni.123@gmail.com>
kavilla · Mar 19, 2021 · 23af201 · 23af201
1 parent 3480004
commit 23af201
Show file tree

Hide file tree

Showing 16 changed files with 38 additions and 38 deletions.
diff --git a/packages/kbn-spec-to-console/README.md b/packages/kbn-spec-to-console/README.md
diff --git a/packages/osd-spec-to-console/README.md b/packages/osd-spec-to-console/README.md
@@ -0,0 +1,36 @@
+\ mini utility to convert [OpenSearch's REST spec](https://github.com/elastic/elasticsearch/blob/master/rest-api-spec) to Console's (OpenSearch Dashboards) autocomplete format.
+
+
+It is used to semi-manually update Console's autocompletion rules.
+
+### Retrieving the spec
+
+If you don't have a copy of the OpenSearch repo on your machine, follow these steps to clone only the rest API specs
+
+```
+mkdir opensearch-spec && cd opensearch-spec
+git init
+git remote add origin https://github.com/elastic/elasticsearch
+git config core.sparsecheckout true
+echo "rest-api-spec/src/main/resources/rest-api-spec/api/*\nx-pack/plugin/src/test/resources/rest-api-spec/api/*" > .git/info/sparse-checkout
+git pull --depth=1 origin master
+```
+
+### Usage
+
+You need to run the command twice: once for the **OSS** specs and once for the **X-Pack** specs  
+At the root of the OpenSearch Dashboards repository, run the following commands:
+
+```sh
+# OSS
+yarn spec_to_console -g "<OPENSEARCH-REPO-FOLDER>/rest-api-spec/src/main/resources/rest-api-spec/api/*" -d "src/plugins/console/server/lib/spec_definitions/json/generated"
+
+# X-pack
+yarn spec_to_console -g "<OPENSEARCH-REPO-FOLDER>/x-pack/plugin/src/test/resources/rest-api-spec/api/*" -d "x-pack/plugins/console_extensions/server/lib/spec_definitions/json/generated"
+```
+
+### Information used in Console that is not available in the REST spec
+
+* Request bodies
+* Data fetched at runtime: indices, fields, snapshots, etc
+* Ad hoc additions
diff --git a/...bn-spec-to-console/bin/spec_to_console.js → ...sd-spec-to-console/bin/spec_to_console.js b/...bn-spec-to-console/bin/spec_to_console.js → ...sd-spec-to-console/bin/spec_to_console.js
diff --git a/packages/kbn-spec-to-console/index.js → packages/osd-spec-to-console/index.js b/packages/kbn-spec-to-console/index.js → packages/osd-spec-to-console/index.js
diff --git a/packages/kbn-spec-to-console/lib/convert.js → packages/osd-spec-to-console/lib/convert.js b/packages/kbn-spec-to-console/lib/convert.js → packages/osd-spec-to-console/lib/convert.js
diff --git a/...s/kbn-spec-to-console/lib/convert.test.js → ...s/osd-spec-to-console/lib/convert.test.js b/...s/kbn-spec-to-console/lib/convert.test.js → ...s/osd-spec-to-console/lib/convert.test.js
diff --git a/...bn-spec-to-console/lib/convert/methods.js → ...sd-spec-to-console/lib/convert/methods.js b/...bn-spec-to-console/lib/convert/methods.js → ...sd-spec-to-console/lib/convert/methods.js
diff --git a/...kbn-spec-to-console/lib/convert/params.js → ...osd-spec-to-console/lib/convert/params.js b/...kbn-spec-to-console/lib/convert/params.js → ...osd-spec-to-console/lib/convert/params.js
diff --git a/.../kbn-spec-to-console/lib/convert/parts.js → .../osd-spec-to-console/lib/convert/parts.js b/.../kbn-spec-to-console/lib/convert/parts.js → .../osd-spec-to-console/lib/convert/parts.js
diff --git a/.../kbn-spec-to-console/lib/convert/paths.js → .../osd-spec-to-console/lib/convert/paths.js b/.../kbn-spec-to-console/lib/convert/paths.js → .../osd-spec-to-console/lib/convert/paths.js
diff --git a/...bn-spec-to-console/lib/replace_pattern.js → ...sd-spec-to-console/lib/replace_pattern.js b/...bn-spec-to-console/lib/replace_pattern.js → ...sd-spec-to-console/lib/replace_pattern.js
diff --git a/...console/lib/static/map_interpolation.json → ...console/lib/static/map_interpolation.json b/...console/lib/static/map_interpolation.json → ...console/lib/static/map_interpolation.json
diff --git a/packages/kbn-spec-to-console/package.json → packages/osd-spec-to-console/package.json b/packages/kbn-spec-to-console/package.json → packages/osd-spec-to-console/package.json
@@ -1,7 +1,7 @@
 {
   "name": "spec-to-console",
   "version": "0.0.0",
-  "description": "ES REST spec -> Console autocomplete",
+  "description": "OpenSearch REST spec -> Console autocomplete",
   "main": "index.js",
   "directories": {
     "lib": "lib"
@@ -12,7 +12,7 @@
   },
   "author": "",
   "license": "Apache-2.0",
-  "kibana": {
+  "opensearchDashboards": {
     "devOnly": true
   },
   "bugs": {

diff --git a/...fixtures/cluster_health_autocomplete.json → ...fixtures/cluster_health_autocomplete.json b/...fixtures/cluster_health_autocomplete.json → ...fixtures/cluster_health_autocomplete.json
diff --git a/...le/test/fixtures/cluster_health_spec.json → ...le/test/fixtures/cluster_health_spec.json b/...le/test/fixtures/cluster_health_spec.json → ...le/test/fixtures/cluster_health_spec.json
diff --git a/packages/kbn-spec-to-console/yarn.lock → packages/osd-spec-to-console/yarn.lock b/packages/kbn-spec-to-console/yarn.lock → packages/osd-spec-to-console/yarn.lock