github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/docs/api-generated
History
Lisa Cawley b75b272a88
[DOCS] Add deprecation details to case APIs (#152033)
2023-02-28 18:17:02 +01:00
..
cases [DOCS] Add deprecation details to case APIs (#152033) 2023-02-28 18:17:02 +01:00
connectors [DOCS] Add specifications for deprecated connector APIs (#149637) 2023-02-02 07:22:32 -08:00
machine-learning [DOCS] Lint ML sync API specification (#148841) 2023-01-13 08:44:07 -08:00
rules [DOCS] Add summary capabilities to the open API specification (#149998) 2023-02-08 08:30:14 -08:00
template [DOCS] Add ML open API output to appendix (#141556) 2022-09-26 11:00:00 -07:00
README.md [DOCS] Lint case API specifications (#149641) 2023-01-31 12:01:00 -08:00

README.md

OpenAPI (Experimental)

Open API specifications (OAS) exist in JSON or YAML format for some Kibana features, though they are experimental and may be incomplete or change later.

A preview of the API specifications can be added to the Kibana Guide by using the following process:

. Install OpenAPI Generator, or a similar tool that can generate HTML output from OAS.

. Optionally validate the specifications by using the commands listed in the appropriate readmes.

. Generate HTML output. For example:

openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/alerting/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/rules -t $GIT_HOME/kibana/docs/api-generated/template

openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/cases/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/cases -t $GIT_HOME/kibana/docs/api-generated/template

openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/actions/docs/openapi/bundled.yaml -o $GIT_HOME/kibana/docs/api-generated/connectors -t $GIT_HOME/kibana/docs/api-generated/template

openapi-generator-cli generate -g html -i $GIT_HOME/kibana/x-pack/plugins/ml/common/openapi/ml_apis_v3.yaml -o $GIT_HOME/kibana/docs/api-generated/machine-learning -t $GIT_HOME/kibana/docs/api-generated/template

. Rename the output files. For example:

mv $GIT_HOME/kibana/docs/api-generated/rules/index.html $GIT_HOME/kibana/docs/api-generated/rules/rule-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/cases/index.html $GIT_HOME/kibana/docs/api-generated/cases/case-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/connectors/index.html $GIT_HOME/kibana/docs/api-generated/connectors/connector-apis-passthru.asciidoc
mv $GIT_HOME/kibana/docs/api-generated/machine-learning/index.html $GIT_HOME/kibana/docs/api-generated/machine-learning/ml-apis-passthru.asciidoc

. If you're creating a new set of API output, you will need to have a page that incorporates the output by using passthrough blocks. For more information, refer to Asciidoctor docs

. Verify the output by building the Kibana documentation. At this time, the output is added as a technical preview in the appendix.

Known issues

  • Some OAS 3.0 features such as anyOf, oneOf, and allOf might not display properly in the preview. These are on the Short-term roadmap at this time.