juzhiyuan opened a new pull request, #2141:
URL: https://github.com/apache/apisix-website/pull/2141
## Summary
Render the current English and Chinese Admin API URLs with Scalar, including
searchable operations, request/response schemas, and the API client.
```text
English / Chinese Admin API pages
├─ Scalar → unchanged API7 OAS 3.19.0 snapshot
└─ upstream Markdown guide → reading panel / no-JavaScript fallback
```
Use the same locally bundled OAS for both locales and the download button.
Keep its English descriptions, localize Scalar's controls, and retain the
compact version/download toolbar and mobile layout. Historical Docusaurus pages
keep their existing renderer; other documentation pages do not load Scalar's
scripts or styles.
Include `openapi/` in the deployment overlay and verify that the published
asset matches the source snapshot. Document the public source URL, license,
version, and SHA-256 in `next/README.md`.
## Evidence
- **Before:** the current Admin API URLs render the Markdown reference as a
long static document.
**After:** the same URLs render the existing OAS's 93 operations and 85
schemas with Scalar; the original full guide remains readable without
JavaScript.
- `npm run build`: 1,336 pages built successfully.
- Full desktop/mobile Playwright suite: **100 passed, 48 skipped** under the
existing test conditions. Includes 10 Admin API checks covering both locales,
OAS loading, request dialogs, guide dialogs, the no-JavaScript fallback, and
asset isolation.
- `npm run test:sitemap`, `npm run test:redirects`, and `npm run
test:doc-signals`: passed.
- Markdown, CSS, YAML, and `git diff --check`: passed.
- Executed the deployment overlay's copy loop in a temporary directory and
confirmed that the shipped OAS is byte-identical to the vendored snapshot.
## Merge Danger
**Door:** two-way
Reverting the routes, dependency, and deployment allowlist restores the
previous renderer. No database or runtime gateway changes.
**Blast Radius:** documentation
The current English/Chinese Admin API routes and their static assets. The
OAS is pinned to APISIX 3.19.0 and needs to be updated alongside future
documentation releases.
--
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]
