kayx23 opened a new pull request, #14134:
URL: https://github.com/apache/apisix/pull/14134

   ## Summary
   
   - add the APISIX 3.17 Control API OpenAPI 3.1 contract
   - document all 16 operations implemented by the matching release branch
   - distinguish core endpoints from configuration-dependent plugin and service 
discovery endpoints
   - use Apache-owned documentation links and source-valid response examples
   
   This is the `release/3.17` source portion of 
[api7/docs#2793](https://github.com/api7/docs/issues/2793). Each maintained 
release owns its version-specific contract; no newer specification is copied 
unchanged into this branch.
   
   ## Source verification
   
   The contract was audited against this release branch's implementation and 
tests:
   
   - built-in routes in `apisix/control/v1.lua`
   - router behavior in `apisix/control/router.lua`
   - `server-info` and service discovery registrations
   - Control API tests under `t/control/` and `t/plugin/server-info.t`
   
   The branch-specific contract reflects the event-publication reload failure 
implemented on this release line.
   
   The contract also models the released empty-collection behavior, where 
populated results are arrays but an empty plain Lua table serializes as `{}`.
   
   ## Validation
   
   - Redocly OpenAPI validation
   - OpenAPI version, release version, path/operation count, security, and 
operation-ID assertions
   - independent source review of operations, responses, examples, and 
availability conditions
   - Apache documentation links and anchors resolve
   - `git diff --check`
   
   Redocly reports only its generic missing-4xx warnings for operations whose 
implementation defines no operation-level 4xx response.
   
   ## Compatibility
   
   This adds a documentation contract 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]

Reply via email to