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

Generate the bundled files by running the following commands:

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

Then join these files with the rest of the Kibana APIs per oas_docs/README.md