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
Kibana Machine 5f7237c4ae
[8.9] [OAS] Add default spaces to case paths (#160831) (#160918) 
# Backport

This will backport the following commits from `main` to `8.9`:
- [[OAS] Add default spaces to case paths
(#160831)](https://github.com/elastic/kibana/pull/160831)

<!--- Backport version: 8.9.7 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2023-06-29T15:41:58Z","message":"[OAS]
Add default spaces to case paths
(#160831)","sha":"8a1902c66eb1c5748a2300fd2e00f0a7b1bc5c76","branchLabelMapping":{"^v8.10.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Cases","v8.9.0","v8.10.0"],"number":160831,"url":"https://github.com/elastic/kibana/pull/160831","mergeCommit":{"message":"[OAS]
Add default spaces to case paths
(#160831)","sha":"8a1902c66eb1c5748a2300fd2e00f0a7b1bc5c76"}},"sourceBranch":"main","suggestedTargetBranches":["8.9"],"targetPullRequestStates":[{"branch":"8.9","label":"v8.9.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.10.0","labelRegex":"^v8.10.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/160831","number":160831,"mergeCommit":{"message":"[OAS]
Add default spaces to case paths
(#160831)","sha":"8a1902c66eb1c5748a2300fd2e00f0a7b1bc5c76"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2023-06-29 10:28:49 -07:00
..
cases [8.9] [OAS] Add default spaces to case paths (#160831) (#160918) 2023-06-29 10:28:49 -07:00
connectors [8.9] [Security solution] Generative AI Connector API specification (#158423) (#160690) 2023-06-27 16:17:53 -07:00
machine-learning [DOCS] Lint ML sync API specification (#148841) 2023-01-13 08:44:07 -08:00
rules [8.9] [DOCS] Fix create rule open API specification (#157950) (#160530) 2023-06-26 08:55:03 -07: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.