Source Artifact summary
| Artifact | Role |
|---|
packages/generated-realtime-api/server/asyncapi.yaml | Server-side realtime source artifact |
packages/generated-realtime-api/client/asyncapi.yaml | Client-side realtime source artifact |
docs/api-specs/realtime-server-asyncapi.yaml | Docs-local render input for Mintlify-generated realtime reference |
Ownership chain
| Layer | Ownership |
|---|
| Package-owned AsyncAPI artifacts | Authoritative contract source for the public realtime family |
docs/api-specs/realtime-server-asyncapi.yaml | Docs-local render input copied into the docs repo scope for Mintlify rendering |
| Generated realtime pages | Public channel/message rendering layer that depends on the docs-local mirror |
Ownership rule
The package-owned AsyncAPI artifacts remain the source of truth for the realtime family. The docs-local mirror exists only because Mintlify-generated reference must read spec files from within the docs repo scope.
Regeneration and verification
| Step | Required action |
|---|
| Update the upstream public server contract | Change packages/generated-realtime-api/server/asyncapi.yaml in the owning package surface |
| Keep the docs-local render input aligned | Copy the updated server artifact into docs/api-specs/realtime-server-asyncapi.yaml in the same MR |
| Re-read the support pages | Update the authored realtime family pages whenever the AsyncAPI change alters auth, connection, rate-limit, or error claims |
| Validate Mintlify rendering | Run mint validate after the mirror is refreshed |
Publication rule
This source-artifact chain applies to the active public realtime family only. It does not imply that adjacent restricted or product-specific WebSocket contracts are published as public generated pages.Last modified on April 13, 2026