rusackas opened a new pull request, #37434: URL: https://github.com/apache/superset/pull/37434
### SUMMARY Integrates the [docusaurus-openapi-docs](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs) plugin to generate interactive API documentation from Superset's OpenAPI specification. This provides a "Try It Out" experience similar to Swagger UI directly in the documentation site. **Key changes:** - Add `docusaurus-openapi-docs` plugin and theme dependencies - Generate MDX files for all 245 API endpoints with interactive request/response examples - Create API landing page with quick links to common endpoints (Dashboards, Charts, Databases, Datasets) - Update sidebar navigation to include the API reference section - Fix OpenAPI spec issues for better plugin compatibility - Add helper scripts for spec conversion and sidebar generation **Benefits:** - Users can explore the full API without running a local Superset instance - Interactive "Try It Out" functionality for testing requests - Auto-generated from the same OpenAPI spec that powers `/swagger/v1` - Consistent with the existing docs site styling ### BEFORE/AFTER SCREENSHOTS OR ANIMATED GIF This adds a new section to the docs. The API reference will be accessible at `/docs/api/` with interactive documentation for all endpoints. ### TESTING INSTRUCTIONS 1. Build and run the docs locally: ```bash cd docs yarn install yarn build yarn serve ``` 2. Navigate to the API Reference section and verify: - Landing page loads with quick links - Individual endpoint pages have request/response schemas - Sidebar shows all API endpoints organized by category ### ADDITIONAL INFORMATION - [ ] Has associated issue: - [ ] Required feature flags: - [ ] Changes UI - [ ] Includes DB Migration - [x] Introduces new feature or API 🤖 Generated with [Claude Code](https://claude.com/claude-code) -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
