11---
22title : Protocol Reference
3- description : Every schema published by @objectstack/spec — 1576 schemas across 14 protocol modules
3+ description : Every schema published by @objectstack/spec — 1577 schemas across 14 protocol modules
44---
55
66{ /* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */ }
@@ -20,7 +20,7 @@ counts are sums of the rows they head. Regenerate with
2020| Module | Pages | Schemas | Description |
2121| :--- | ---: | ---: | :--- |
2222| [ AI Protocol] ( /docs/references/ai ) | 11 | 66 | Agents, tools, skills, RAG and knowledge sources, model registry, conversations. |
23- | [ API Protocol] ( /docs/references/api ) | 28 | 411 | REST/GraphQL contracts, endpoints, routing, realtime, batch, discovery. |
23+ | [ API Protocol] ( /docs/references/api ) | 28 | 412 | REST/GraphQL contracts, endpoints, routing, realtime, batch, discovery. |
2424| [ Automation Protocol] ( /docs/references/automation ) | 13 | 68 | Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execution records. |
2525| [ Cloud Protocol] ( /docs/references/cloud ) | 11 | 94 | Environments, packages and versions, marketplace, developer portal, tenancy. |
2626| [ Data Protocol] ( /docs/references/data ) | 30 | 166 | Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer. |
@@ -33,7 +33,7 @@ counts are sums of the rows they head. Regenerate with
3333| [ Studio Protocol] ( /docs/references/studio ) | 3 | 35 | Studio designer metadata — the authoring surfaces for the protocols above. |
3434| [ System Protocol] ( /docs/references/system ) | 37 | 292 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
3535| [ UI Protocol] ( /docs/references/ui ) | 16 | 147 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
36- | ** Total** | ** 200** | ** 1576 ** | 14 protocol modules |
36+ | ** Total** | ** 200** | ** 1577 ** | 14 protocol modules |
3737
3838---
3939
@@ -61,7 +61,7 @@ Agents, tools, skills, RAG and knowledge sources, model registry, conversations.
6161
6262## API Protocol
6363
64- ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 28 pages, 411 schemas**
64+ ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 28 pages, 412 schemas**
6565
6666REST/GraphQL contracts, endpoints, routing, realtime, batch, discovery.
6767
@@ -86,7 +86,7 @@ REST/GraphQL contracts, endpoints, routing, realtime, batch, discovery.
8686| [ ` odata.zod.ts ` ] ( /docs/references/api/odata ) | ` ODataConfig ` , ` ODataError ` , ` ODataFilterFunction ` , ` ODataMetadata ` , ` ODataQuery ` , ` ODataResponse ` |
8787| [ ` package-api.zod.ts ` ] ( /docs/references/api/package-api ) | ` GetInstalledPackageRequest ` , ` GetInstalledPackageResponse ` , ` ListInstalledPackagesRequest ` , ` ListInstalledPackagesResponse ` , ` PackageApiErrorCode ` , ` PackageInstallRequest ` , ` PackageInstallResponse ` , ` PackagePathParams ` , ` PackageRollbackRequest ` , ` PackageRollbackResponse ` , ` PackageUpgradeRequest ` , ` PackageUpgradeResponse ` , ` ResolveDependenciesRequest ` , ` ResolveDependenciesResponse ` , ` UninstallPackageApiRequest ` , ` UninstallPackageApiResponse ` , ` UploadArtifactRequest ` , ` UploadArtifactResponse ` |
8888| [ ` plugin-rest-api.zod.ts ` ] ( /docs/references/api/plugin-rest-api ) | ` ErrorHandlingConfig ` , ` HandlerStatus ` , ` OpenApiGenerationConfig ` , ` RequestValidationConfig ` , ` ResponseEnvelopeConfig ` , ` RestApiEndpoint ` , ` RestApiPluginConfig ` , ` RestApiRouteCategory ` , ` RestApiRouteRegistration ` , ` RouteCoverageEntry ` , ` RouteCoverageReport ` , ` ValidationMode ` |
89- | [`protocol.zod.ts`](/docs/references/api/protocol) | `AiAgentCapabilities`, `AiAgentChatRequest`, `AiAgentSummary`, `AiAgentsResponse`, `AiChatRequest`, `AiChatResponse`, `AiCompleteRequest`, `AiConversation`, `AiMessage`, `AiModelsResponse`, `AiPendingAction`, `AiPendingActionStatus`, `AiStreamChunk`, `ApproveAiPendingActionResponse`, `AutomationActionsResponse`, `AutomationTriggerRequest`, `AutomationTriggerResponse`, `BatchDataRequest`, `BatchDataResponse`, `CheckPermissionRequest`, `CheckPermissionResponse`, `CreateAiConversationRequest`, `CreateDataRequest`, `CreateDataResponse`, `CreateManyDataRequest`, `CreateManyDataResponse`, `DeleteDataRequest`, `DeleteDataResponse`, `DeleteManyDataRequest`, `DeleteManyDataResponse`, `DeleteMetaItemRequest`, `DeleteMetaItemResponse`, `DisablePackageRequest`, `DisablePackageResponse`, `EnablePackageRequest`, `EnablePackageResponse`, `FindDataRequest`, `FindDataResponse`, `GetDataRequest`, `GetDataResponse`, `GetDiscoveryRequest`, `GetDiscoveryResponse`, `GetEffectivePermissionsRequest`, `GetEffectivePermissionsResponse`, `GetFieldLabelsRequest`, `GetFieldLabelsResponse`, `GetLocalesRequest`, `GetLocalesResponse`, `GetMetaItemCachedRequest`, `GetMetaItemCachedResponse`, `GetMetaItemLayeredResponse`, `GetMetaItemRequest`, `GetMetaItemResponse`, `GetMetaItemsRequest`, `GetMetaItemsResponse`, `GetMetaTypesRequest`, `GetMetaTypesResponse`, `GetNotificationPreferencesRequest`, `GetNotificationPreferencesResponse`, `GetObjectPermissionsRequest`, `GetObjectPermissionsResponse`, `GetPackageRequest`, `GetPackageResponse`, `GetPresenceRequest`, `GetPresenceResponse`, `GetTranslationsRequest`, `GetTranslationsResponse`, `GetUiViewRequest`, `GetUiViewResponse`, `HttpFindQueryParams`, `InstallPackageRequest`, `InstallPackageResponse`, `ListAiConversationsRequest`, `ListAiConversationsResponse`, `ListAiPendingActionsRequest`, `ListAiPendingActionsResponse`, `ListNotificationsRequest`, `ListNotificationsResponse`, `ListPackagesRequest`, `ListPackagesResponse`, `MarkAllNotificationsReadRequest`, `MarkAllNotificationsReadResponse`, `MarkNotificationsReadRequest`, `MarkNotificationsReadResponse`, `Notification`, `NotificationPreferences`, `PublishMetaItemResponse`, `RealtimeConnectRequest`, `RealtimeConnectResponse`, `RealtimeDisconnectRequest`, `RealtimeDisconnectResponse`, `RealtimeSubscribeRequest`, `RealtimeSubscribeResponse`, `RealtimeUnsubscribeRequest`, `RealtimeUnsubscribeResponse`, `RegisterDeviceRequest`, `RegisterDeviceResponse`, `RejectAiPendingActionResponse`, `SaveMetaItemRequest`, `SaveMetaItemResponse`, `SetPresenceRequest`, `SetPresenceResponse`, `UninstallPackageRequest`, `UninstallPackageResponse`, `UnregisterDeviceRequest`, `UnregisterDeviceResponse`, `UpdateAiConversationRequest`, `UpdateDataRequest`, `UpdateDataResponse`, `UpdateManyDataRequest`, `UpdateManyDataResponse`, `UpdateNotificationPreferencesRequest`, `UpdateNotificationPreferencesResponse`, `ValidateDataIssue`, `ValidateDataRequest`, `ValidateDataResponse` |
89+ | [`protocol.zod.ts`](/docs/references/api/protocol) | `AiAgentCapabilities`, `AiAgentChatRequest`, `AiAgentSummary`, `AiAgentsResponse`, `AiChatRequest`, `AiChatResponse`, `AiCompleteRequest`, `AiConversation`, `AiMessage`, `AiModelsResponse`, `AiPendingAction`, `AiPendingActionStatus`, `AiStreamChunk`, `ApproveAiPendingActionResponse`, `AutomationActionsResponse`, `AutomationTriggerRequest`, `AutomationTriggerResponse`, `BatchDataRequest`, `BatchDataResponse`, `CheckPermissionRequest`, `CheckPermissionResponse`, `CreateAiConversationRequest`, `CreateDataRequest`, `CreateDataResponse`, `CreateManyDataRequest`, `CreateManyDataResponse`, `DeleteDataRequest`, `DeleteDataResponse`, `DeleteManyDataRequest`, `DeleteManyDataResponse`, `DeleteMetaItemRequest`, `DeleteMetaItemResponse`, `DisablePackageRequest`, `DisablePackageResponse`, `EnablePackageRequest`, `EnablePackageResponse`, `FindDataRequest`, `FindDataResponse`, `GetDataRequest`, `GetDataResponse`, `GetDiscoveryRequest`, `GetDiscoveryResponse`, `GetEffectivePermissionsRequest`, `GetEffectivePermissionsResponse`, `GetFieldLabelsRequest`, `GetFieldLabelsResponse`, `GetLocalesRequest`, `GetLocalesResponse`, `GetMetaItemCachedRequest`, `GetMetaItemCachedResponse`, `GetMetaItemLayeredResponse`, `GetMetaItemRequest`, `GetMetaItemResponse`, `GetMetaItemsRequest`, `GetMetaItemsResponse`, `GetMetaTypesRequest`, `GetMetaTypesResponse`, `GetNotificationPreferencesRequest`, `GetNotificationPreferencesResponse`, `GetObjectPermissionsRequest`, `GetObjectPermissionsResponse`, `GetPackageRequest`, `GetPackageResponse`, `GetPresenceRequest`, `GetPresenceResponse`, `GetTranslationsRequest`, `GetTranslationsResponse`, `GetUiViewRequest`, `GetUiViewResponse`, `HttpFindQueryParams`, `InstallPackageRequest`, `InstallPackageResponse`, `ListAiConversationsRequest`, `ListAiConversationsResponse`, `ListAiPendingActionsRequest`, `ListAiPendingActionsResponse`, `ListNotificationsRequest`, `ListNotificationsResponse`, `ListPackagesRequest`, `ListPackagesResponse`, `MarkAllNotificationsReadRequest`, `MarkAllNotificationsReadResponse`, `MarkNotificationsReadRequest`, `MarkNotificationsReadResponse`, `Notification`, `NotificationPreferences`, `PublishMetaItemResponse`, `RealtimeConnectRequest`, `RealtimeConnectResponse`, `RealtimeDisconnectRequest`, `RealtimeDisconnectResponse`, `RealtimeSubscribeRequest`, `RealtimeSubscribeResponse`, `RealtimeUnsubscribeRequest`, `RealtimeUnsubscribeResponse`, `RegisterDeviceRequest`, `RegisterDeviceResponse`, `RejectAiPendingActionResponse`, `RuntimeAuthoringIssue`, `SaveMetaItemRequest`, `SaveMetaItemResponse`, `SetPresenceRequest`, `SetPresenceResponse`, `UninstallPackageRequest`, `UninstallPackageResponse`, `UnregisterDeviceRequest`, `UnregisterDeviceResponse`, `UpdateAiConversationRequest`, `UpdateDataRequest`, `UpdateDataResponse`, `UpdateManyDataRequest`, `UpdateManyDataResponse`, `UpdateNotificationPreferencesRequest`, `UpdateNotificationPreferencesResponse`, `ValidateDataIssue`, `ValidateDataRequest`, `ValidateDataResponse` |
9090| [ ` query-adapter.zod.ts ` ] ( /docs/references/api/query-adapter ) | ` ODataQueryAdapter ` , ` OperatorMapping ` , ` QueryAdapterConfig ` , ` QueryAdapterTarget ` , ` RestQueryAdapter ` |
9191| [ ` realtime.zod.ts ` ] ( /docs/references/api/realtime ) | ` RealtimeConfig ` , ` RealtimeEvent ` , ` RealtimeEventType ` , ` RealtimePresence ` , ` Subscription ` , ` SubscriptionEvent ` , ` TransportProtocol ` |
9292| [ ` realtime-shared.zod.ts ` ] ( /docs/references/api/realtime-shared ) | ` BasePresence ` , ` PresenceStatus ` , ` RealtimeRecordAction ` |
0 commit comments