用途:对限定范围的 Kibana OAS(OpenAPI 规范)区域做快速校验,只给出 VALID 或 NOT VALID 结果,不负责详细问题分类。
主要能力:通过 node ./scripts/validate_oas_docs.js 对指定 API 路径做通过/失败检查;支持多个 --path 过滤;默认使用 --only traditional 并始终加 --skip-printing-issues;若结果 NOT VALID,提示改用 debug-oas 技能查看细节。
使用方式:先询问开发者正在处理的 API,并索取一个或多个路由式路径(如 /api/fleet/agent_policies),不要手动转成 JSON 指针。需要时先刷新 oas_docs 生成物:yarn kbn bootstrap,再从 .buildkite/scripts/steps/checks/capture_oas_snapshot.sh 读取 include 路径并运行 node scripts/capture_oas_snapshot,接着执行两个 openapi_bundling 脚本,最后 cd oas_docs && make api-docs。随后运行:node ./scripts/validate_oas_docs.js --only traditional --skip-printing-issues --path <api_route_prefix>。仅当明确要求时才用 --only serverless。
结果判定:输出 Found 0 errors 为 VALID;Found N errors(N>0)为 NOT VALID;若无路径匹配,仍为 VALID 但需附警告。输出保持简洁,仅三种模板之一。
限制:生成物过期应视为环境问题而非校验结果;不要写入 .buildkite/;路径列表以 CI 脚本为准;未提供的信息暂未说明。