kayx23 opened a new pull request, #14131: URL: https://github.com/apache/apisix/pull/14131
## Summary - add the canonical APISIX Control API OpenAPI 3.1 contract for `master` - document 17 source-verified operations, including configuration-dependent server information and service discovery endpoints - validate the contract against built-in Lua route registrations and shipped optional endpoint patterns - add regression checks for operation coverage, response envelopes, content types, error examples, security, and the loopback-only default server - extend the API contract workflow and contributor guidance to cover both Admin and Control APIs The existing Markdown Control API page remains the readable documentation and renderer fallback. The OpenAPI document is the machine-readable contract consumed by the Apache website and downstream documentation. This is the Next/master source portion of [api7/docs#2793](https://github.com/api7/docs/issues/2793). ## Source verification The contract was audited against: - `apisix/control/v1.lua` and `apisix/control/router.lua` - plugin `control_api()` registrations, including `server-info` - service discovery `dump_data()` and `control_api()` registrations - Control API and plugin tests under `t/control/` and `t/plugin/server-info.t` The contract distinguishes always-registered core endpoints from stable patterns that exist only when the corresponding plugin or discovery module is enabled. ## Validation - 18 OpenAPI validator unit tests - `python utils/validate-admin-api.py` - `python utils/validate-control-api.py` - Python compilation for the validator and its tests - Redocly OpenAPI validation - `git diff --check` Redocly reports only its generic missing-4xx warnings for operations whose implementation defines no operation-level 4xx response. ## Compatibility This adds documentation and CI validation only. It does not change runtime routes or behavior. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
