codeant-ai-for-open-source[bot] commented on PR #37434:
URL: https://github.com/apache/superset/pull/37434#issuecomment-3802374160
## **Sequence Diagram**
Shows the core flow added in this PR: a script patches the OpenAPI spec, the
docusaurus-openapi-docs plugin generates MDX API pages, and helper scripts
produce the sidebar and landing index so the docs site can serve the
interactive API reference.
```mermaid
sequenceDiagram
participant Developer
participant FixScript as fix-openapi-spec.py
participant OpenAPI as openapi.json
participant GenPlugin as docusaurus-plugin-openapi-docs
participant SidebarScripts as convert/generate-index scripts
participant DocsSite as Docusaurus
Developer->>FixScript: Run "yarn generate:api-docs"
FixScript->>OpenAPI: Read & patch spec (add schemas, tag descriptions,
x-codeSamples, servers, examples)
FixScript-->>Developer: Write updated openapi.json
Developer->>GenPlugin: Run "docusaurus gen-api-docs superset"
GenPlugin->>OpenAPI: Generate MDX pages under docs/api from spec
GenPlugin-->>Developer: Generated endpoint & schema MDX (gitignored)
Developer->>SidebarScripts: Run convert-api-sidebar.mjs &
generate-api-index.mjs
SidebarScripts->>DocsSite: Produce sidebar.js and api.mdx landing page
Developer->>DocsSite: Start/build docs (includes
docusaurus-theme-openapi-docs)
DocsSite->>DocsSite: Include CSS to hide non-functional "Send" UI and
render API Reference
DocsSite-->>Developer: Serve 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]
