OpenAPI (Experimental)

The current self-contained spec file is 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/slo 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 manually validate the docs before bundling them with the following command in the x-pack/solutions/observability/plugins/slo/docs/openapi/slo folder:

make validate

Then you can generate the bundled files by running the following command- this target will automatically validate inputs and lint the result:

make bundle

To lint the generated bundle manually, run:

make lint

To join these files with the rest of the Kibana APIs, refer to oas_docs/README.md