kibana

History

Spencer c77704dd64 [7.x] Update jest related packages (#46391 ) (#46624 ) * Update jest related packages (#46391) * Update jest related packages * use correct type * adapt spy and describe.each types * update yarn.lock * update snapshot * define types before passing to describe.each # Conflicts: # yarn.lock * update yarn.lock file		2019-09-25 15:16:26 -07:00
..
bin
lib	[Console] Update autocomplete api definition (#43651 ) (#43735 )	2019-08-26 15:16:29 +02:00
test/fixtures	Backport spec_to_console script to work with new JSON file format. (#43427 ) (#43544 )	2019-08-19 13:27:10 -07:00
index.js
package.json	[7.x] Update jest related packages (#46391 ) (#46624 )	2019-09-25 15:16:26 -07:00
README.md

README.md

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

You need to run the command twice: once for the OSS specs and once for the X-Pack specs
At the root of the Kibana repository, run the following commands:

# OSS
yarn spec_to_console \
  -g "<ELASTICSEARCH-REPO-FOLDER>/rest-api-spec/src/main/resources/rest-api-spec/api/*" \
  -d "src/legacy/core_plugins/console/api_server/spec/generated"

# X-pack
yarn spec_to_console \
  -g "<ELASTICSEARCH-REPO-FOLDER>/x-pack/plugin/src/test/resources/rest-api-spec/api/*" \
  -d "x-pack/plugins/console_extensions/spec/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