Document dispatcher protocol in PROTOCOL_MAP by Copilot · Pull Request #549 · objectstack-ai/objectstack

Copilot · 2026-02-08T09:31:23Z

Phase 1 API Protocol infrastructure was already complete. All requirements (CoreServiceName extensions, ApiRoutesSchema, dispatcher.zod.ts, ManifestSchema.contributes.routes, tests) existed. Only documentation was missing.

Changes

Added dispatcher.zod.ts to PROTOCOL_MAP.md as primary protocol (⭐)
Promoted discovery.zod.ts to primary protocol status
Clarified discovery includes API routes registry

Context

The HttpDispatcher protocol defines route-to-service mapping for 14 API namespaces:

// packages/spec/src/api/dispatcher.zod.tsexportconstDEFAULT_DISPATCHER_ROUTES=[{prefix: '/api/v1/discovery',service: 'metadata',authRequired: false},{prefix: '/api/v1/meta',service: 'metadata'},{prefix: '/api/v1/data',service: 'data'},{prefix: '/api/v1/ai',service: 'ai'},{prefix: '/api/v1/i18n',service: 'i18n'},{prefix: '/api/v1/ui',service: 'ui'},{prefix: '/api/v1/workflow',service: 'workflow'},// ... 7 more routes];

Plugins declare routes via ManifestSchema.contributes.routes, allowing dynamic API extension without kernel changes.

Phase 2 Scope

Phase 2 (REST API plugin implementation) requires code outside spec repository - not included in this PR.

Original prompt

完成 API Protocol 改造
Phase 1: 内核基础改造（1-2 周）
1.1 扩展 CoreServiceName，增加 ai、i18n、ui、workflow 四个服务标识
1.2 扩展 ApiRoutesSchema，增加新的路由端点声明
1.3 创建 src/api/dispatcher.zod.ts，定义 HttpDispatcher 路由配置协议
1.4 扩展 ManifestSchema contributes.routes，允许插件声明 API 路由贡献
1.5 补充所有相关 .test.ts 单元测试
1.6 更新 PROTOCOL_MAP.md 文档
Phase 2: 核心 REST API 插件（2-3 周）
2.1 实现 plugin-rest-api：注册 Discovery、Metadata、Data CRUD、Batch、Permission 路由
2.2 Request 校验中间件：使用 Zod Schema 自动验证请求体
2.3 Response 封装：统一使用 BaseResponseSchema 信封格式
2.4 错误处理：统一使用 ApiErrorSchema 格式
2.5 OpenAPI 文档自动生成（基于 documentation.zod.ts）
The user has attached the following file paths as relevant context:
.github/copilot-instructions.md

Created from VS Code.

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

vercel · 2026-02-08T09:31:30Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
objectstack-studio	Error		Feb 8, 2026 9:37am
spec	Ready	Preview, Comment	Feb 8, 2026 9:37am

…very Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Copilot

Pull request overview

Updates the ObjectStack spec documentation map and regenerates/extends JSON Schema artifacts to reflect the HttpDispatcher + Discovery routing model and newly recognized core services.

Changes:

Documented dispatcher.zod.ts as a primary (⭐) API protocol and promoted discovery.zod.ts to ⭐ in PROTOCOL_MAP.md.
Updated generated JSON schemas to include new CoreServiceName values (ai, i18n, ui, workflow) and expanded Discovery/Routes outputs to use /api/v1/* examples and include additional namespaces.
Added/updated generated JSON schemas for dispatcher configuration (DispatcherRoute, DispatcherConfig) and manifest contributes.routes structures across multiple response schemas.

Reviewed changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/spec/PROTOCOL_MAP.md	Adds dispatcher + promotes discovery to ⭐ in the protocol map.
packages/spec/json-schema/system/ServiceStatus.json	Extends service enum with `ai/i18n/ui/workflow`.
packages/spec/json-schema/system/ServiceConfig.json	Extends service enum with `ai/i18n/ui/workflow`.
packages/spec/json-schema/system/KernelServiceMap.json	Extends service enum with `ai/i18n/ui/workflow`.
packages/spec/json-schema/system/CoreServiceName.json	Extends core service enum with `ai/i18n/ui/workflow`.
packages/spec/json-schema/kernel/Manifest.json	Adds generated schema for `contributes.routes`.
packages/spec/json-schema/kernel/ListPackagesResponse.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/kernel/InstalledPackage.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/kernel/InstallPackageResponse.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/kernel/InstallPackageRequest.json	Propagates `contributes.routes` into request schema.
packages/spec/json-schema/kernel/GetPackageResponse.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/kernel/EnablePackageResponse.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/kernel/DisablePackageResponse.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/hub/ComposerResponse.json	Propagates `contributes.routes` into response schema.
packages/spec/json-schema/api/ListPackagesResponse.json	Propagates `contributes.routes` into API response schema.
packages/spec/json-schema/api/InstallPackageResponse.json	Propagates `contributes.routes` into API response schema.
packages/spec/json-schema/api/InstallPackageRequest.json	Propagates `contributes.routes` into API request schema.
packages/spec/json-schema/api/GetPackageResponse.json	Propagates `contributes.routes` into API response schema.
packages/spec/json-schema/api/EnablePackageResponse.json	Propagates `contributes.routes` into API response schema.
packages/spec/json-schema/api/DisablePackageResponse.json	Propagates `contributes.routes` into API response schema.
packages/spec/json-schema/api/CompileManifestResponse.json	Propagates `contributes.routes` into API response schema.
packages/spec/json-schema/api/GetDiscoveryResponse.json	Expands discovery endpoints/features to include more namespaces and `/api/v1/*` examples.
packages/spec/json-schema/api/Discovery.json	Expands discovery schema (routes + features) to include more namespaces and `/api/v1/*` examples.
packages/spec/json-schema/api/ApiRoutes.json	Adds additional route namespaces and updates examples to `/api/v1/*`.
packages/spec/json-schema/api/ApiCapabilities.json	Adds capabilities flags for `ai/workflow/notifications/i18n`.
packages/spec/json-schema/api/DispatcherRoute.json	Adds generated JSON schema for dispatcher route entries.
packages/spec/json-schema/api/DispatcherConfig.json	Adds generated JSON schema for dispatcher config.

Copilot · 2026-02-08T10:22:35Z

 | :--- | :--- | :--- |
 | [`protocol.zod.ts`](src/api/protocol.zod.ts) | ⭐ | **Stack Protocol**. valid requests and responses for the platform. |
+| [`dispatcher.zod.ts`](src/api/dispatcher.zod.ts) | ⭐ | **HttpDispatcher**. Route-to-service mapping for API routing. |
+| [`discovery.zod.ts`](src/api/discovery.zod.ts) | ⭐ | **Service Discovery**. Service registration and API routes discovery. |


PROTOCOL_MAP marks discovery.zod.ts as “Service registration and API routes discovery”, but src/api/discovery.zod.ts only defines a discovery response (routes + feature flags + locale). Consider rewording this row to avoid implying an unmodeled “service registration” protocol (or link that concept to kernel/service-registry.zod.ts if that’s what you mean).
Suggested change
|[`discovery.zod.ts`](src/api/discovery.zod.ts)| ⭐ |**Service Discovery**. Service registration and API routes discovery. |
|[`discovery.zod.ts`](src/api/discovery.zod.ts)| ⭐ |**API Discovery Response**. Describes available API routes, feature flags, and locale metadata. |

Copilot · 2026-02-08T10:22:36Z

 | [`protocol.zod.ts`](src/api/protocol.zod.ts) | ⭐ | **Stack Protocol**. valid requests and responses for the platform. |
+| [`dispatcher.zod.ts`](src/api/dispatcher.zod.ts) | ⭐ | **HttpDispatcher**. Route-to-service mapping for API routing. |
+| [`discovery.zod.ts`](src/api/discovery.zod.ts) | ⭐ | **Service Discovery**. Service registration and API routes discovery. |


The PR description says Phase 1 infrastructure (schemas + tests) already existed and that only PROTOCOL_MAP needed updates, but this PR also modifies/adds many packages/spec/json-schema/** artifacts (e.g., new DispatcherConfig/DispatcherRoute schemas and CoreServiceName enum expansions). Please either update the PR description to reflect the additional non-doc changes, or drop the generated schema changes if they’re unintended.

Copilot · 2026-02-08T10:22:36Z

+ "description": "API path prefix"
+ },
+ "service": {
+ "type": "string",


In contributes.routes, service is an unconstrained string. Since HttpDispatcher routes use CoreServiceName (enum), allowing arbitrary values here makes manifests validate even when the dispatcher/service-registry can’t resolve them. Recommend constraining service to the CoreServiceName enum in the source Zod schema and regenerating JSON schema outputs.
Suggested change
"type": "string",
"$ref": "#/definitions/CoreServiceName",

Copilot · 2026-02-08T10:22:36Z

+ "description": "API path prefix"
+ },
+ "service": {
+ "type": "string",


contributes.routes[].service is typed as a free-form string here as well. If this field is meant to integrate with HttpDispatcher routing, it should be constrained to the same CoreServiceName enum used by DispatcherRoute.service, otherwise invalid service names will pass manifest compilation but fail at routing time.
Suggested change
"type": "string",
"$ref": "#/definitions/CoreServiceName",

Initial plan
903b900

CopilotAI assigned Copilot and hotlong Feb 8, 2026

Copilotstarted work on behalf of hotlong February 8, 2026 09:31 View session

vercelBothad a problem deploying to Preview – objectstack-studio February 8, 2026 09:31 Failure

vercelBotdeployed to Preview – spec February 8, 2026 09:33 View deployment

docs: Update PROTOCOL_MAP.md to document dispatcher and promote disco…
7e90ad5
…very Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

vercelBotdeployed to Preview – spec February 8, 2026 09:36 View deployment

vercelBothad a problem deploying to Preview – objectstack-studio February 8, 2026 09:37 Failure

CopilotAI changed the title ~~[WIP] Update API protocol for service integration and routing~~Document dispatcher protocol in PROTOCOL_MAPFeb 8, 2026

CopilotAI requested a review from hotlong February 8, 2026 09:39

Copilotfinished work on behalf of hotlong February 8, 2026 09:39

hotlong approved these changes Feb 8, 2026
View reviewed changes

hotlong marked this pull request as ready for review February 8, 2026 10:18

CopilotAI review requested due to automatic review settings February 8, 2026 10:18

Copilotstarted reviewing on behalf of hotlong February 8, 2026 10:18 View session

hotlong merged commit 6028495 into mainFeb 8, 2026
6 of 7 checks passed

CopilotAI reviewed Feb 8, 2026
View reviewed changes

os-elon mentioned this pull request Aug 20, 2026
[PM seat] repo:hotcrm — 🔴 收班 vacant · 上一班 os-warren (session_01HoTmVdM6mN8HQWQ4pujEsN) R4 · 落地 10 PR / 10 卡 · 在飞 0 · 队列 4 · 决策箱 7 #10282
Open

Navigation Menu

Uh oh!

Document dispatcher protocol in PROTOCOL_MAP - #549

Document dispatcher protocol in PROTOCOL_MAP#549
hotlong merged 2 commits into
mainfrom
copilot/update-api-protocol-structure

CopilotAI commented Feb 8, 2026•
edited
Loading

Uh oh!

vercelBot commented Feb 8, 2026•
edited
Loading

Uh oh!

Uh oh!

CopilotAI left a comment

Uh oh!

CopilotAIFeb 8, 2026

Uh oh!

CopilotAIFeb 8, 2026

Uh oh!

CopilotAIFeb 8, 2026

Uh oh!

CopilotAIFeb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	\|[`discovery.zod.ts`](src/api/discovery.zod.ts)\| ⭐ \|Service Discovery. Service registration and API routes discovery. \|
	\|[`discovery.zod.ts`](src/api/discovery.zod.ts)\| ⭐ \|API Discovery Response. Describes available API routes, feature flags, and locale metadata. \|

Uh oh!

Conversation

CopilotAI commented Feb 8, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Context

Phase 2 Scope

Phase 1: 内核基础改造（1-2 周）

Phase 2: 核心 REST API 插件（2-3 周）

Uh oh!

vercelBot commented Feb 8, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

CopilotAIFeb 8, 2026

Choose a reason for hiding this comment

Uh oh!

CopilotAIFeb 8, 2026

Choose a reason for hiding this comment

Uh oh!

CopilotAIFeb 8, 2026

Choose a reason for hiding this comment

Uh oh!

CopilotAIFeb 8, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CopilotAI commented Feb 8, 2026•
edited
Loading

vercelBot commented Feb 8, 2026•
edited
Loading