kibana/packages/core/saved-objects/docs/openapi

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.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.

Tools

To validate and bundle the docs, you can use Redocly and Swagger/OpenAPI CLI.

For example, run the following commands from the packages/core/saved-objects/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

After generating the json bundle ensure that it is also valid by running the following command:

npx @redocly/cli lint bundled.json