github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 17:59:23 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/x-pack/plugins/actions/docs/openapi
History
Exact
Lisa Cawley f55d719cf7
[8.8] [OAS] Remove redundant connector properties (#163987) (#164361) 
# Backport

This will backport the following commits from `main` to `8.8`:
- [[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 16:40:22 -07:00
..
components [8.8] [OAS] Remove redundant connector properties (#163987) (#164361) 2023-08-21 16:40:22 -07:00
paths [8.8] [Security solution] Generative AI Connector API specification (#158423) (#160689) 2023-06-27 16:46:18 -07:00
bundled.json [8.8] [OAS] Remove redundant connector properties (#163987) (#164361) 2023-08-21 16:40:22 -07:00
bundled.yaml [8.8] [OAS] Remove redundant connector properties (#163987) (#164361) 2023-08-21 16:40:22 -07:00
entrypoint.yaml [DOCS] Add specifications for deprecated connector APIs (#149637) 2023-02-02 07:22:32 -08:00
README.md Add open API specification for list connector types (#145951) 2022-11-24 11:30:51 -07:00

README.md

OpenAPI (Experimental)

The current self-contained spec file is as JSON or as YAML and can be used for online tools like those found at https://openapi.tools/. This spec is experimental and may be incomplete or change later.

A guide about the openApi specification can be found at https://swagger.io/docs/specification/about/.

The openapi folder

  • entrypoint.yaml is the overview file which pulls together all the paths and components.
  • Paths: this defines each endpoint. A path can have one operation per http method.
  • Components: Reusable components

Tools

It is possible to validate the docs before bundling them with the following command in the x-pack/plugins/actions/docs/openapi/ folder:

  npx swagger-cli validate entrypoint.yaml

Then you can generate the bundled files by running the following commands:

  npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
  npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json

You can run additional linting with the following command:

   npx @redocly/cli lint bundled.json