mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 01:38:56 -04:00
6d11fa0e92
# Backport This will backport the following commits from `main` to `8.10`: - [[DOCS] Add Webhook connector SSL authentication configuration details (#163983)](https://github.com/elastic/kibana/pull/163983) <!--- Backport version: 8.9.8 --> ### 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-08-23T18:45:08Z","message":"[DOCS] Add Webhook connector SSL authentication configuration details (#163983)","sha":"4686472f9ec930c1cfe56d87f70e4ce2dcc70be4","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorTypes","v8.10.0","v8.11.0"],"number":163983,"url":"https://github.com/elastic/kibana/pull/163983","mergeCommit":{"message":"[DOCS] Add Webhook connector SSL authentication configuration details (#163983)","sha":"4686472f9ec930c1cfe56d87f70e4ce2dcc70be4"}},"sourceBranch":"main","suggestedTargetBranches":["8.10"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/163983","number":163983,"mergeCommit":{"message":"[DOCS] Add Webhook connector SSL authentication configuration details (#163983)","sha":"4686472f9ec930c1cfe56d87f70e4ce2dcc70be4"}}]}] BACKPORT--> |
||
|---|---|---|
| .. | ||
| cases | ||
| connectors | ||
| machine-learning | ||
| rules | ||
| template | ||
| 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, andallOfmight not display properly in the preview. These are on the Short-term roadmap at this time.