edc4d58e12
* create newJob route and start of wizard * wip: create configStep component * finish configStep form and details * wip: create andvanced step components * create details step component * createStep component * ensure advanced options are correct for each job type * add validation to each step * use custom table for excludes * move customSelectionTable to shared components * form validation for advanced fields * wip: source index selection modal * add source index preview * update details * ensure advanced parameters added to config on creation * can create job from savedSearch. can set source query in ui * validate source object has supported fields * eslint updates * update tests. comment out clone action for now * add create button to advanced editor * remove deprecated test helper functions * fix translation errors * update help text. read only once job created. * fix functional tests * add nextStepNav to df service for tests * fix excludes table page jump and hyperParameter not showing in details * fix checkbox width for custom table |
||
|---|---|---|
| .. | ||
| apidoc_scripts | ||
| schemas | ||
| annotations.ts | ||
| anomaly_detectors.ts | ||
| apidoc.json | ||
| calendars.ts | ||
| data_frame_analytics.ts | ||
| data_visualizer.ts | ||
| datafeeds.ts | ||
| fields_service.ts | ||
| file_data_visualizer.ts | ||
| filters.ts | ||
| indices.ts | ||
| job_audit_messages.ts | ||
| job_service.ts | ||
| job_validation.ts | ||
| modules.ts | ||
| notification_settings.ts | ||
| README.md | ||
| results_service.ts | ||
| system.ts | ||
ML Kibana API routes
This folder contains ML API routes in Kibana.
Each route handler requires apiDoc annotations in order to generate documentation. The apidoc-markdown package is also required in order to generate the markdown.
There are custom parser and worker (x-pack/plugins/ml/server/routes/apidoc_scripts) to process api schemas for each documentation entry. It's written with typescript so make sure all the scripts in the folder are compiled before executing apidoc command.
Make sure you have run yarn kbn bootstrap to get all requires dev dependencies. Then execute the following command from the ml plugin folder:
yarn run apiDocs
It compiles all the required scripts and generates the documentation both in HTML and Markdown formats.
It will create a new directory routes_doc (next to the routes folder) which contains the documentation in HTML format
as well as ML_API.md file.