kibana/packages/kbn-spec-to-console
Bill McConaghy e16bb422ba
adding spec to console utility as Kibana script (#35232)
* adding spec to console utility as Kibana script

* fixing yarn.lock

* aligning dep versions with Kibana

* fixing test
2019-04-17 20:40:32 -04:00
..
bin adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04:00
lib adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04:00
test/fixtures adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04:00
index.js adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04:00
package.json adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04:00
README.md adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04:00
yarn.lock adding spec to console utility as Kibana script (#35232) 2019-04-17 20:40:32 -04: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

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/*" > .git/info/sparse-checkout
git pull --depth=1 origin master

Usage

yarn spec_to_console \
  -g "es-spec/rest-api-spec/src/main/resources/rest-api-spec/api/*.json" \
  -d "../kibana/src/core_plugins/console/api_server/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