用途:为 Kibana 仓库中任意插件或包的 API 区域补充或改进 OpenAPI 描述、示例与代码示例,使生成的 OAS 规范更完整、对人和 AI 智能体更有用。
主要能力:先探测插件采用 code-first 还是 spec-first 的 OAS 生成方式,以及所用 schema 库(@kbn/config-schema 或 Zod),再据此适配。可补充 schema 字段描述、路由 summary 与 description、请求/响应示例、curl 与 Console 代码示例、弃用标记,并为共享 schema 设置 meta.id 以生成 $ref。
使用方式:需先确认要改进的 API 区域与插件目录路径;运行 discovery 探测 OAS 方式;用 debug-oas 获取当前问题清单与基线数量;逐路由实现改进;最后用 validate-oas 验证问题数下降。spec-first 插件只改 YAML,不手改 *.gen.ts,改后需运行生成脚本(如 yarn openapi);若存在 docs/openapi/ 路径与示例 YAML,必须同步更新并重新打包(cd <plugin_path>/docs/openapi && npx @redocly/cli bundle)。
适用场景:Kibana 插件或包需要更完善的 OAS 文档时,例如缺少字段描述、路由说明、示例或代码示例。
限制:描述须对照 handler 实现核实,不得仅凭参数名推断;不得暴露内部实现细节;未使用参数应标记而非编造行为;示例需真实数据并含错误响应;不得为凑数编造描述。具体版本号、收费与平台信息暂未提供。