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 a2f5eb720c
[8.9] [OAS] Remove redundant connector properties (#163987) (#164360) 
# Backport

This will backport the following commits from `main` to `8.9`:
- [[OAS] Remove redundant connector properties
(#163987)](https://github.com/elastic/kibana/pull/163987)

<!--- 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-21T16:29:08Z","message":"[OAS]
Remove redundant connector properties
(#163987)","sha":"c1d2834f1aa675f2682793d83ac9ad07c3854990","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","docs","Feature:Actions/ConnectorTypes","backport:prev-minor","v8.10.0","v8.11.0"],"number":163987,"url":"https://github.com/elastic/kibana/pull/163987","mergeCommit":{"message":"[OAS]
Remove redundant connector properties
(#163987)","sha":"c1d2834f1aa675f2682793d83ac9ad07c3854990"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"url":"https://github.com/elastic/kibana/pull/164338","number":164338,"state":"MERGED","mergeCommit":{"sha":"df9b17fb7ce2b90db9d954f17432a8906faee3b7","message":"[8.10]
[OAS] Remove redundant connector properties (#163987) (#164338)\n\n#
Backport\n\nThis will backport the following commits from `main` to
`8.10`:\n- [[OAS] Remove redundant connector
properties\n(#163987)](https://github.com/elastic/kibana/pull/163987)\n\n<!---
Backport version: 8.9.7 -->\n\n### Questions ?\nPlease refer to the
[Backport
tool\ndocumentation](https://github.com/sqren/backport)\n\n<!--BACKPORT
[{\"author\":{\"name\":\"Lisa\nCawley\",\"email\":\"lcawley@elastic.co\"},\"sourceCommit\":{\"committedDate\":\"2023-08-21T16:29:08Z\",\"message\":\"[OAS]\nRemove
redundant connector
properties\n(#163987)\",\"sha\":\"c1d2834f1aa675f2682793d83ac9ad07c3854990\",\"branchLabelMapping\":{\"^v8.11.0$\":\"main\",\"^v(\\\\d+).(\\\\d+).\\\\d+$\":\"$1.$2\"}},\"sourcePullRequest\":{\"labels\":[\"release_note:skip\",\"Team:ResponseOps\",\"docs\",\"Feature:Actions/ConnectorTypes\",\"backport:prev-minor\",\"v8.10.0\",\"v8.11.0\"],\"number\":163987,\"url\":\"https://github.com/elastic/kibana/pull/163987\",\"mergeCommit\":{\"message\":\"[OAS]\nRemove
redundant connector
properties\n(#163987)\",\"sha\":\"c1d2834f1aa675f2682793d83ac9ad07c3854990\"}},\"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/163987\",\"number\":163987,\"mergeCommit\":{\"message\":\"[OAS]\nRemove
redundant connector
properties\n(#163987)\",\"sha\":\"c1d2834f1aa675f2682793d83ac9ad07c3854990\"}}]}]\nBACKPORT-->\n\nCo-authored-by:
Lisa Cawley
<lcawley@elastic.co>"}},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/163987","number":163987,"mergeCommit":{"message":"[OAS]
Remove redundant connector properties
(#163987)","sha":"c1d2834f1aa675f2682793d83ac9ad07c3854990"}}]}]
BACKPORT-->
2023-08-21 14:01:11 -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] [OAS] Remove redundant connector properties (#163987) (#164360) 2023-08-21 14:01:11 -07:00
machine-learning [DOCS] Lint ML sync API specification (#148841) 2023-01-13 08:44:07 -08:00
rules [8.9] [OAS] Clarify rule action descriptions (#162199) (#163418) 2023-08-08 08:57:24 -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.