codeant-ai-for-open-source[bot] commented on PR #37434:
URL: https://github.com/apache/superset/pull/37434#issuecomment-3807060973
## **Sequence Diagram**
This PR adds an automated pipeline that patches the OpenAPI spec, generates
interactive API docs (MDX) via docusaurus-plugin-openapi-docs, and produces the
API index/sidebar so the docs site exposes a comprehensive API Reference. The
diagram shows the main success path of the generation flow added by the PR.
```mermaid
sequenceDiagram
participant Developer/CI
participant fix-openapi-spec.py
participant OpenAPI_Spec
participant Docusaurus_Generator
participant Postprocessors
participant Docs_Site
Developer/CI->>fix-openapi-spec.py: Run generate:api-docs (yarn)
fix-openapi-spec.py->>OpenAPI_Spec: Patch spec (schemas, tags, code
samples, servers, examples)
Developer/CI->>Docusaurus_Generator: docusaurus gen-api-docs superset
(plugin)
Docusaurus_Generator->>Postprocessors: Emit generated MDX + sidebar.ts
Postprocessors->>Postprocessors: convert-api-sidebar.mjs &
generate-api-index.mjs (sidebar.js, api.mdx)
Postprocessors->>Docs_Site: Docs directory populated; plugin/theme + CSS
included
Docs_Site-->>Developer/CI: Serve/build site with API Reference at
/docs/api/
```
---
*Generated by [CodeAnt AI](https://codeant.ai)*
--
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]
