feat(api): OpenAPI surface, MCP tools, conversation actions & API keys#280
Open
melihsunbul wants to merge 9 commits into
Open
feat(api): OpenAPI surface, MCP tools, conversation actions & API keys#280melihsunbul wants to merge 9 commits into
melihsunbul wants to merge 9 commits into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
The external API surface: a comprehensive OpenAPI document, MCP tool expansion, conversation action endpoints, comment reactions, moderation, chat tags and API keys.
Concepts
openapi.json; a route-coverage test fails the build if a route ships undocumented.How it works
openapi.jsonregenerated for the full v1 surface; schema modules underdomains/api/schemas/(tickets, roles, teams, segments, settings, suggestions, help-centre, widget-profiles, user-attributes, portal-tabs, chat-tags, conversation-actions, moderation, comments/reactions, apps) registered viaopenapi.ts/index.ts;openapi-route-coverage.test.tsasserts every route is documented.server/mcp/tools.ts) — tools across all new domains, includingmanage_routing_rule(create/update/delete/reorder) and thread/attachment tools (getThread,attachToThread,listAttachmentsForThread,removeAttachment,canEditFields); handler tests updated./api/v1/conversations(assign, reply, note, priority, read, end, status, tags),/comments/{id}/reactionsadd/remove,/chat-tagsCRUD plus attach/detach, and moderation review/actions (domains/moderation/).domains/api-keys/) — scope-gated management.How to use
openapi.jsondocuments every v1 route and schema; point your client/codegen at it./api/v1/…with the key.Safety
Verification
bun run typecheck,bun run lint;openapi-route-coverage.test.ts, conversation-actions/chat-tags/comment-reactions coverage and MCP handler tests (included).📚 This is a stacked series — please review & merge in order
These 10 PRs are split by concern and ordered by dependency. Each is opened against
main, so until the PRs before it have merged, a PR's diff is cumulative (it also contains the earlier batches). As the earlier PRs merge and we rebase the next branch ontomain, each diff reduces to just its own batch. Merging all 10 in order reproduces our integrated branch exactly (verified: the cumulative tip of the series is byte-identical to it).Order (by branch):
01-data-model-foundation— data model, TypeIDs, migrations02-rbac-authz-teams— RBAC, teams, organisation & auth surfaces03-events-audit-webhooks— event dispatch, audit log, webhooks, notifications04-ticketing-crm-core— ticketing / CRM core05-sla-inboxes-routing— SLA policies, inboxes, business hours, routing06-github-sync-and-ticket-email— GitHub ticket sync, ticket email, integration platform07-widget-profiles— scoped widget profiles + ticket submission08-api-openapi-mcp— OpenAPI surface, MCP tools, conversation actions, API keys09-content-visibility— changelog/help-centre visibility, segments, portal tabs10-test-coverage— broad unit/integration test suite + supporting infraPart of the roadmap: #283