kibana

History

Jonathan Budzenski 1cc2a34745 Removes references to Elasticsearch mapping types (#47610 ) * rm types * fix infra/reindex test * rm max_adjacency_matrix_filters * lint * more fixes * comment return * override documentation links * typo * return unfedined * skip highlight test * lint		2019-11-11 16:41:08 -06:00
..
bin
lib	[Console] Mappings 7.5 part 2 (#48492 )	2019-10-17 14:27:58 +02:00
test/fixtures	Backport spec_to_console script to work with new JSON file format. (#43427 )	2019-08-19 12:26:33 -07:00
index.js
package.json	Update dependency prettier to ^1.18.2 (#47340 )	2019-10-05 05:32:24 -07:00
README.md	Removes references to Elasticsearch mapping types (#47610 )	2019-11-11 16:41:08 -06:00

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/server/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/legacy/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