Back to Kibana

APM app OpenAPI documentation

x-pack/solutions/observability/plugins/apm/docs/openapi/apm/README.md

9.4.21.2 KB
Original Source

APM app OpenAPI documentation

This directory contains OpenAPI specifications for the APM app API in Kibana.

OpenAPI (Experimental)

The current self-contained spec file is available as 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: Defines each endpoint. A path can have one operation per http method.
  • Components: Defines reusable components.

Tools

Generate the bundled files by running the following commands:

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

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