update-api-docs
Installation
SKILL.md
Update API Documentation
This skill guides you through updating the API reference documentation from the production OpenAPI specification.
Overview
The API documentation is generated from an OpenAPI spec using docusaurus-plugin-openapi-docs. The workflow involves:
- Downloading the latest
openapi.jsonfrom production - Replacing the local spec file
- Regenerating the API documentation pages
File Locations
| Purpose | Path |
|---|---|
| OpenAPI spec (source) | docs/docs/reference/openapi.json |
| Generated API docs | docs/docs/reference/api/*.api.mdx |
| Generated sidebar | docs/docs/reference/api/sidebar.ts |
| Docusaurus config | docs/docusaurus.config.ts |