Migration Status
Current status
Section titled “Current status”This docs site is live, but the OpenAPI migration is still in progress.
The current OpenAPI file already documents a meaningful first slice of the API:
- health
- authentication
- invitations and onboarding
- organizations and memberships
- buildings and residential units
- announcements
- full ticket API surface:
- ticket CRUD
- ticket activity
- ticket comments
- ticket notes
- ticket attachments
- ticket duplicate detection
- users and profile/preferences
- dashboard summary
- global search
- realtime SSE
- AI self-service answer generation
- AI staff draft replies
- notification preferences
- analytics
- knowledge base
- subscriptions
Next recommended migrations
Section titled “Next recommended migrations”- decide whether to split the OpenAPI file into modular source files before it grows further
- add endpoint-specific examples for lower-traffic admin endpoints where useful
- continue expanding product documentation for customer onboarding and feature adoption
Rule while migrating
Section titled “Rule while migrating”Until migration is complete:
- use the checked-in OpenAPI file as the growing source of truth
- use guide pages for explanations and integration caveats
- treat the old monolithic Markdown contract as legacy material to be phased out