improve-oas
Improve OAS
Add descriptions, examples, and code samples to a Kibana API area so that the generated OpenAPI specification is complete and useful for humans and AI agents.
This skill operates on any package or plugin in the Kibana repo. It detects how the plugin generates its OAS contribution and adapts accordingly. For issue categorization, use debug-oas.
Required interaction flow
- Ask which API area the developer wants to improve (e.g. "fleet", "alerting", "streams").
- Ask for the plugin or package directory path if not obvious from the API area.
- Run discovery to detect the plugin's OAS approach.
- Run
debug-oasto get the current issue list and baseline count. - Present a summary of what needs to be done: how many routes, which categories of work (descriptions, examples, code samples, deprecation markers).
- Implement changes route-by-route, bundling all improvements for one endpoint together.
- After completing all routes, run validation to confirm the issue count dropped to zero (or to the expected residual).
Do not skip steps 1-2 unless the developer already provided the API area and path.
Phase 1: Discovery
More from elastic/kibana
codeql
Work with CodeQL in Kibana — write, test, and debug custom queries locally, fetch scan results from GitHub, and validate inline suppression comments. Use when writing or debugging CodeQL queries, running CodeQL unit tests, analyzing SARIF results, fetching scan results, or checking codeql suppression justifications.
2cypress-to-scout-migration
>
2kibana-api
Shared utilities for interacting with a local Kibana instance. Provides auto-detection of Kibana URL and auth, and a kibana_curl wrapper.
2api-authz
Kibana API route authorization patterns. Use when configuring route security, working with requiredPrivileges, using authzResult for privilege-based branching, opting out of authorization, or naming custom privileges.
2ftr-testing
Deep reference for the Kibana Functional Test Runner (FTR). Use when reading, analyzing, debugging, or reviewing FTR tests, including config anatomy, services, page objects, loadTestFile patterns, data loading, tags, CI wiring, and common FTR idioms.
2validate-oas
Use when you need a quick VALID or NOT VALID result for a scoped Kibana OAS area, and first ensure the generated `oas_docs` inputs are up to date so validation runs against the current environment rather than stale snapshots.
2