typebot.io/apps/docs/api-reference
Baptiste Arnaud 9d2d7ead8e
🔧 Restore OpenAPI docs generation pipeline (#2553)
## Summary

- Restores OpenAPI docs generation, lost in the oRPC migration: new
`generate-openapi` nx targets regenerate
`apps/docs/openapi/{builder,viewer}.json` offline from the oRPC routers,
reusing the exact options served by the live `/api/openapi.json`
endpoints. Both specs are regenerated in this PR (builder.json was stale
since March).
- Fixes spec generation crashing on the spaces router (Effect Schema had
no JSON Schema converter — this also breaks the live builder
`/api/openapi.json` today) and sanitizes an `AppendValue(s)` component
name that made Mintlify silently render every builder API page empty.
- Keeps the docs from going stale again: pre-commit regenerates affected
specs and auto-stages them, CI fails PRs with stale specs, and a new
check requires lockstep `@typebot.io/js` / `@typebot.io/react` version
bumps whenever embed files change.

## Test plan

- [x] `bunx nx generate-openapi builder viewer` produces valid OpenAPI
3.1 files matching the live endpoints (works without env: isolated-vm
stubbed, dummy DATABASE_URL auto-matched to the generated Prisma client)
- [x] All 34 `openapi:` references in `apps/docs/api-reference/*.mdx`
resolve against the new specs; pages verified rendering in `mintlify
dev` (params, unions, curl samples)
- [x] Embeds version check: fails when js or react files change without
both bumps, passes on the historical 0.10.5 bump commit, ignores
unrelated changes
- [x] Pre-commit pipeline (lint, tests, generation, embeds check) passes
end to end
- [ ] Confirm the "Check OpenAPI docs are up to date" step passes on
this PR

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
2026-07-03 20:19:08 +02:00
..
analytics 🐛 (docs) Fix "Get stats" empty api ref 2024-02-08 09:10:01 +01:00
billing 📝 Migrate from Docusaurus to Mintlify (#1115) 2023-12-22 09:13:53 +01:00
chat 🔧 Restore OpenAPI docs generation pipeline (#2553) 2026-07-03 20:19:08 +02:00
folder 🧑‍💻 (folders) Add folder trpc endpoints (#1218) 2024-02-05 12:14:03 +01:00
results 📝 Migrate from Docusaurus to Mintlify (#1115) 2023-12-22 09:13:53 +01:00
typebot 📝 Migrate from Docusaurus to Mintlify (#1115) 2023-12-22 09:13:53 +01:00
user ♻️ Create new user package and migrate update API to tRPC 2025-06-04 11:39:40 +02:00
workspace 📝 Migrate from Docusaurus to Mintlify (#1115) 2023-12-22 09:13:53 +01:00
authentication.mdx 📝 Migrate from Docusaurus to Mintlify (#1115) 2023-12-22 09:13:53 +01:00
how-to.mdx 📝 Add message stream API instructions 2024-09-10 12:28:11 +02:00