apache / apache/apisix-website

Render OpenAPI Spec of Admin APIs and Control APIs

Open
#1,899 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
146
Forks
204
Avg merge
2d 3h
Merged PRs (30d)
21

Description

## Description

So far, the APISIX Admin APIs and Control APIs are hosted at https://apisix.apache.org/docs/apisix/admin-api/ using Markdown. To enhance the experience, an OpenAPI Spec render page would be much better.

Note: This change applies starting with APISIX v3.13; previous versions will continue to use the markdown format.

## TODO

- [ ] Which OpenAPI Render Library to use?
- [ ] Build & Upload OpenAPI Spec files to `apache/apisix` repo.
- [ ] Delete Markdown contents. (Admin API and Control API)
- [ ] Use OpenAPI Render Library to render specs.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the Admin API and Control API documentation at https://apisix.apache.org/docs/apisix/admin-api/ and identify the existing Markdown content and the OpenAPI specification files in the apache/apisix repository. Research and choose an OpenAPI render library, then define how specs will be built and uploaded for APISIX v3.13. Done means the Markdown content is replaced by rendered specs while previous versions retain Markdown.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.