mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 19:13:14 -04:00
9b99070470
## Summary resolves https://github.com/elastic/kibana/issues/159454 Remove experimental message from saved objects import and export apis. ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| components | ||
| paths | ||
| bundled.json | ||
| bundled.yaml | ||
| bundled_serverless.json | ||
| bundled_serverless.yaml | ||
| entrypoint.yaml | ||
| entrypoint_serverless.yaml | ||
| README.md | ||
OpenAPI (Experimental)
The current self-contained spec file is bundled.json or bundled.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.yamlis 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.
Tools
To validate and bundle the docs, you can use Redocly and Swagger/OpenAPI CLI.
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
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.yaml --ext yaml
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.json --ext json
Then join these files with the rest of the Kibana APIs per oas_docs/README.md