kibana/packages/kbn-spec-to-console
Yulia Čech 538dfba513
[Console] Autocomplete definitions (manual backport) (#105086)
* [Console] Removed x-pack console extensions folder and moved json files to src/plugins/console

* [Console] Generated console definitions with ES repo on master branch

* Added some overrides and doc links fixes

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-07-13 10:31:50 +02:00
..
bin
lib [Console] Autocomplete definitions (manual backport) (#105086) 2021-07-13 10:31:50 +02:00
BUILD.bazel
index.js
jest.config.js
package.json
README.md [Console] Autocomplete definitions (manual backport) (#105086) 2021-07-13 10:31:50 +02:00

A mini utility to convert Elasticsearch's REST spec to Console's (Kibana) 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 Elasticsearch repo on your machine, follow these steps to clone only the rest API specs

mkdir es-spec && cd es-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

At the root of the Kibana repository, run the following commands:

yarn spec_to_console -g "<ELASTICSEARCH-REPO-FOLDER>/rest-api-spec/src/main/resources/rest-api-spec/api/*" -d "src/plugins/console/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