mirror of
https://github.com/baptisteArno/typebot.io.git
synced 2026-07-21 21:13:45 +08:00
## 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>
|
||
|---|---|---|
| .. | ||
| ai | ||
| auth | ||
| billing | ||
| blocks | ||
| bot-engine | ||
| chat-api | ||
| chat-session | ||
| conditions | ||
| config | ||
| credentials | ||
| deprecated/legacy | ||
| emails | ||
| embeds | ||
| env | ||
| events | ||
| forge | ||
| groups | ||
| lib | ||
| logs | ||
| partykit | ||
| playwright | ||
| prisma | ||
| radar | ||
| results | ||
| rich-text | ||
| runtime-session-store | ||
| schemas | ||
| scripts | ||
| services/feature-flags | ||
| settings | ||
| shared-core | ||
| spaces | ||
| telemetry | ||
| templates | ||
| theme | ||
| typebot | ||
| ui | ||
| user | ||
| variables | ||
| workspaces | ||