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

   ## Why
   
   The APISIX 3.19 Admin API OpenAPI contract is stored as one minified line. 
GitHub therefore renders every contract update as one deleted line and one 
added line, preventing normal line-level review and making concurrent changes 
conflict on the same physical line.
   
   This backports the modular source and deterministic generation workflow from 
#14147 to the 3.19 contract. The branches keep their version-appropriate API 
content while using the same maintenance model.
   
   ## What changed
   
   - add `docs/openapi/admin-api/openapi.json` as the modular OpenAPI entry 
point
   - split all 47 Path Items into individual files under `paths/`
   - split schemas, parameters, request bodies, responses, and security schemes 
into individual component files
   - add `make bundle-admin-api-spec`, backed by the pinned 
`@redocly/[email protected]`
   - regenerate `docs/en/latest/admin-api.json` as formatted, self-contained 
JSON
   - mark the bundle as generated so reviewers can focus on the modular source
   - add contributor guidance for editing references and regenerating the bundle
   - add CI that regenerates the bundle and fails when the committed output is 
stale
   
   This migration changes source organization and formatting only. It does not 
intentionally change the APISIX 3.19 Admin API contract.
   
   ## Validation
   
   - bundled all 182 OpenAPI source files with no unresolved external references
   - parsed and normalized the pre-migration and generated documents, then 
compared their complete JSON structures: identical
   - generated the bundle twice and confirmed byte-identical SHA-256 output
   - validated the workflow YAML
   - checked the bundle script with `bash -n`
   - passed Markdownlint on the new contributor guide
   - `git diff --check`
   
   Closes #14145.


-- 
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