11---
22title : Protocol Reference
3- description : Every schema published by @objectstack/spec — 1585 schemas across 14 protocol modules
3+ description : Every schema published by @objectstack/spec — 1604 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 ) | 29 | 423 | REST contracts, endpoints, routing, realtime, batch, discovery. |
23+ | [ API Protocol] ( /docs/references/api ) | 31 | 439 | REST 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 ) | 29 | 166 | Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer. |
@@ -31,9 +31,9 @@ counts are sums of the rows they head. Regenerate with
3131| [ Security Protocol] ( /docs/references/security ) | 5 | 29 | Permission sets, row-level security, sharing rules, tenancy posture. |
3232| [ Shared Protocol] ( /docs/references/shared ) | 8 | 32 | Primitives used across every protocol — identifiers, HTTP, expressions, error maps, enums. |
3333| [ Studio Protocol] ( /docs/references/studio ) | 3 | 35 | Studio designer metadata — the authoring surfaces for the protocols above. |
34- | [ System Protocol] ( /docs/references/system ) | 36 | 288 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
34+ | [ System Protocol] ( /docs/references/system ) | 36 | 291 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
3535| [ UI Protocol] ( /docs/references/ui ) | 16 | 152 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
36- | ** Total** | ** 199 ** | ** 1585 ** | 14 protocol modules |
36+ | ** Total** | ** 201 ** | ** 1604 ** | 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 ` · ** 29 pages, 423 schemas**
64+ ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 31 pages, 439 schemas**
6565
6666REST contracts, endpoints, routing, realtime, batch, discovery.
6767
@@ -83,10 +83,12 @@ REST contracts, endpoints, routing, realtime, batch, discovery.
8383| [ ` export.zod.ts ` ] ( /docs/references/api/export ) | ` CreateExportJobRequest ` , ` CreateExportJobResponse ` , ` CreateImportJobRequest ` , ` CreateImportJobResponse ` , ` DeduplicationStrategy ` , ` ExportFormat ` , ` ExportImportTemplate ` , ` ExportJobProgress ` , ` ExportJobStatus ` , ` ExportJobSummary ` , ` FieldMappingEntry ` , ` GetExportJobDownloadRequest ` , ` GetExportJobDownloadResponse ` , ` ImportJobProgress ` , ` ImportJobResults ` , ` ImportJobStatus ` , ` ImportJobSummary ` , ` ImportMapping ` , ` ImportRequest ` , ` ImportResponse ` , ` ImportRowResult ` , ` ImportValidationConfig ` , ` ImportValidationMode ` , ` ImportValidationResult ` , ` ImportWriteMode ` , ` ListExportJobsRequest ` , ` ListExportJobsResponse ` , ` ListImportJobsRequest ` , ` ListImportJobsResponse ` , ` ScheduleExportRequest ` , ` ScheduleExportResponse ` , ` ScheduledExport ` , ` UndoImportJobResponse ` |
8484| [ ` http-cache.zod.ts ` ] ( /docs/references/api/http-cache ) | ` CacheControl ` , ` CacheDirective ` , ` CacheInvalidationRequest ` , ` CacheInvalidationResponse ` , ` CacheInvalidationTarget ` , ` ETag ` , ` MetadataCacheRequest ` , ` MetadataCacheResponse ` |
8585| [ ` metadata.zod.ts ` ] ( /docs/references/api/metadata ) | ` AppDefinitionResponse ` , ` ConceptListResponse ` , ` MetadataBulkRegisterRequest ` , ` MetadataBulkResponse ` , ` MetadataBulkUnregisterRequest ` , ` MetadataDeleteResponse ` , ` MetadataDependenciesResponse ` , ` MetadataDependentsResponse ` , ` MetadataEffectiveResponse ` , ` MetadataExistsResponse ` , ` MetadataExportRequest ` , ` MetadataExportResponse ` , ` MetadataImportRequest ` , ` MetadataImportResponse ` , ` MetadataItemResponse ` , ` MetadataListResponse ` , ` MetadataNamesResponse ` , ` MetadataOverlayResponse ` , ` MetadataOverlaySaveRequest ` , ` MetadataQueryRequest ` , ` MetadataQueryResponse ` , ` MetadataRegisterRequest ` , ` MetadataTypeInfoResponse ` , ` MetadataTypesResponse ` , ` MetadataValidateRequest ` , ` MetadataValidateResponse ` , ` ObjectDefinitionResponse ` |
86+ | [ ` misc ` ] ( /docs/references/api/misc ) * (no single source file)* | ` ResolvedBook ` , ` ResolvedEntry ` , ` ResolvedGroup ` |
8687| [ ` odata.zod.ts ` ] ( /docs/references/api/odata ) | ` ODataConfig ` , ` ODataError ` , ` ODataFilterFunction ` , ` ODataMetadata ` , ` ODataQuery ` , ` ODataResponse ` |
87- | [ ` 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 ` |
88+ | [ ` package-api.zod.ts ` ] ( /docs/references/api/package-api ) | ` GetInstalledPackageRequest ` , ` GetInstalledPackageResponse ` , ` ListInstalledPackagesRequest ` , ` ListInstalledPackagesResponse ` , ` PackageApiErrorCode ` , ` PackageInstallRequest ` , ` PackageInstallResponse ` , ` PackagePathParams ` , ` PackageRollbackRequest ` , ` PackageUpgradeRequest ` , ` PackageUpgradeResponse ` , ` ResolveDependenciesRequest ` , ` ResolveDependenciesResponse ` , ` UninstallPackageApiRequest ` , ` UninstallPackageApiResponse ` , ` UploadArtifactRequest ` , ` UploadArtifactResponse ` |
89+ | [ ` package-lifecycle.zod.ts ` ] ( /docs/references/api/package-lifecycle ) | ` DiscardPackageDraftsResponse ` , ` DuplicatePackageResponse ` , ` ListPackageCommitsResponse ` , ` PackageExportManifest ` , ` PackagePublishResult ` , ` ReassignOrphanedMetadataResponse ` , ` RevertPackageCommitResponse ` , ` RollbackToPackageCommitResponse ` |
8890| [ ` 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`, `AuditMetaItemRequest`, `AuditMetaItemResponse`, `AutomationActionsResponse`, `AutomationTriggerRequest`, `AutomationTriggerResponse`, `BatchDataRequest`, `BatchDataResponse`, `CheckPermissionRequest`, `CheckPermissionResponse`, `CloneDataResponse`, `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`, `GetMetaItemLayeredRequest`, `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`, `PublishMetaItemRequest`, `PublishMetaItemResponse`, `PublishPackageDraftsResponse`, `RealtimeConnectRequest`, `RealtimeConnectResponse`, `RealtimeDisconnectRequest`, `RealtimeDisconnectResponse`, `RealtimeSubscribeRequest`, `RealtimeSubscribeResponse`, `RealtimeUnsubscribeRequest`, `RealtimeUnsubscribeResponse`, `RegisterDeviceRequest`, `RegisterDeviceResponse`, `RejectAiPendingActionResponse`, `RuntimeAuthoringIssue`, `SaveMetaItemRequest`, `SaveMetaItemResponse`, `SearchAllHit`, `SearchAllResponse`, `SetPresenceRequest`, `SetPresenceResponse`, `UninstallPackageRequest`, `UninstallPackageResponse`, `UnregisterDeviceRequest`, `UnregisterDeviceResponse`, `UpdateAiConversationRequest`, `UpdateDataRequest`, `UpdateDataResponse`, `UpdateManyDataRequest`, `UpdateManyDataResponse`, `UpdateNotificationPreferencesRequest`, `UpdateNotificationPreferencesResponse`, `ValidateDataIssue`, `ValidateDataRequest`, `ValidateDataResponse` |
91+ | [`protocol.zod.ts`](/docs/references/api/protocol) | `AiAgentCapabilities`, `AiAgentChatRequest`, `AiAgentSummary`, `AiAgentsResponse`, `AiChatRequest`, `AiChatResponse`, `AiCompleteRequest`, `AiConversation`, `AiMessage`, `AiModelsResponse`, `AiPendingAction`, `AiPendingActionStatus`, `AiStreamChunk`, `ApproveAiPendingActionResponse`, `AuditMetaItemRequest`, `AuditMetaItemResponse`, `AutomationActionsResponse`, `AutomationTriggerRequest`, `AutomationTriggerResponse`, `BatchDataRequest`, `BatchDataResponse`, `CheckPermissionRequest`, `CheckPermissionResponse`, `CloneDataResponse`, `CreateAiConversationRequest`, `CreateDataRequest`, `CreateDataResponse`, `CreateManyDataRequest`, `CreateManyDataResponse`, `DeleteDataRequest`, `DeleteDataResponse`, `DeleteManyDataRequest`, `DeleteManyDataResponse`, `DeleteMetaItemRequest`, `DeleteMetaItemResponse`, `DiffMetaItemResponse`, `DisablePackageRequest`, `DisablePackageResponse`, `EnablePackageRequest`, `EnablePackageResponse`, `FindDataRequest`, `FindDataResponse`, `FindReferencesToMetaResponse`, `GetDataRequest`, `GetDataResponse`, `GetDiscoveryRequest`, `GetDiscoveryResponse`, `GetEffectivePermissionsRequest`, `GetEffectivePermissionsResponse`, `GetFieldLabelsRequest`, `GetFieldLabelsResponse`, `GetLocalesRequest`, `GetLocalesResponse`, `GetMetaDiagnosticsResponse`, `GetMetaItemCachedRequest`, `GetMetaItemCachedResponse`, `GetMetaItemLayeredRequest`, `GetMetaItemLayeredResponse`, `GetMetaItemRequest`, `GetMetaItemResponse`, `GetMetaItemsRequest`, `GetMetaItemsResponse`, `GetMetaTypesRequest`, `GetMetaTypesResponse`, `GetNotificationPreferencesRequest`, `GetNotificationPreferencesResponse`, `GetObjectPermissionsRequest`, `GetObjectPermissionsResponse`, `GetPackageRequest`, `GetPackageResponse`, `GetPresenceRequest`, `GetPresenceResponse`, `GetPublishedMetaItemResponse`, `GetTranslationsRequest`, `GetTranslationsResponse`, `GetUiViewRequest`, `GetUiViewResponse`, `HttpFindQueryParams`, `InstallPackageRequest`, `InstallPackageResponse`, `ListAiConversationsRequest`, `ListAiConversationsResponse`, `ListAiPendingActionsRequest`, `ListAiPendingActionsResponse`, `ListDraftsResponse`, `ListNotificationsRequest`, `ListNotificationsResponse`, `ListPackagesRequest`, `ListPackagesResponse`, `MarkAllNotificationsReadRequest`, `MarkAllNotificationsReadResponse`, `MarkNotificationsReadRequest`, `MarkNotificationsReadResponse`, `Notification`, `NotificationPreferences`, `PublishMetaItemRequest`, `PublishMetaItemResponse`, `PublishPackageDraftsResponse`, `RealtimeConnectRequest`, `RealtimeConnectResponse`, `RealtimeDisconnectRequest`, `RealtimeDisconnectResponse`, `RealtimeSubscribeRequest`, `RealtimeSubscribeResponse`, `RealtimeUnsubscribeRequest`, `RealtimeUnsubscribeResponse`, `RegisterDeviceRequest`, `RegisterDeviceResponse`, `RejectAiPendingActionResponse`, `RollbackMetaItemResponse`, `RuntimeAuthoringIssue`, `SaveMetaItemRequest`, `SaveMetaItemResponse`, `SearchAllHit`, `SearchAllResponse`, `SetPresenceRequest`, `SetPresenceResponse`, `UninstallPackageRequest`, `UninstallPackageResponse`, `UnregisterDeviceRequest`, `UnregisterDeviceResponse`, `UpdateAiConversationRequest`, `UpdateDataRequest`, `UpdateDataResponse`, `UpdateManyDataRequest`, `UpdateManyDataResponse`, `UpdateNotificationPreferencesRequest`, `UpdateNotificationPreferencesResponse`, `ValidateDataIssue`, `ValidateDataRequest`, `ValidateDataResponse` |
9092| [ ` query-adapter.zod.ts ` ] ( /docs/references/api/query-adapter ) | ` ODataQueryAdapter ` , ` OperatorMapping ` , ` QueryAdapterConfig ` , ` QueryAdapterTarget ` , ` RestQueryAdapter ` |
9193| [ ` realtime.zod.ts ` ] ( /docs/references/api/realtime ) | ` RealtimeConfig ` , ` RealtimeEvent ` , ` RealtimeEventType ` , ` RealtimePresence ` , ` Subscription ` , ` SubscriptionEvent ` , ` TransportProtocol ` |
9294| [ ` realtime-shared.zod.ts ` ] ( /docs/references/api/realtime-shared ) | ` BasePresence ` , ` PresenceStatus ` , ` RealtimeRecordAction ` |
@@ -318,15 +320,15 @@ Studio designer metadata — the authoring surfaces for the protocols above.
318320
319321## System Protocol
320322
321- ** Source:** ` packages/spec/src/system/ ` · ** Import:** ` @objectstack/spec/system ` · ** 36 pages, 288 schemas**
323+ ** Source:** ` packages/spec/src/system/ ` · ** Import:** ` @objectstack/spec/system ` · ** 36 pages, 291 schemas**
322324
323325The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance.
324326
325327| File | Schemas |
326328| :--- | :--- |
327329| [ ` app-install.zod.ts ` ] ( /docs/references/system/app-install ) | ` AppCompatibilityCheck ` , ` AppInstallRequest ` , ` AppInstallResult ` , ` AppManifest ` |
328330| [ ` auth-config.zod.ts ` ] ( /docs/references/system/auth-config ) | ` AdvancedAuthConfig ` , ` AudienceConfig ` , ` AuthConfig ` , ` AuthPluginConfig ` , ` AuthProviderConfig ` , ` EmailAndPasswordConfig ` , ` EmailVerificationConfig ` , ` MutualTLSConfig ` , ` OidcProviderConfig ` , ` OidcProvidersConfig ` , ` SocialProviderConfig ` |
329- | [ ` book.zod.ts ` ] ( /docs/references/system/book ) | ` Book ` , ` BookAudience ` , ` BookGroup ` , ` BookInclude ` , ` BookNode ` |
331+ | [ ` book.zod.ts ` ] ( /docs/references/system/book ) | ` Book ` , ` BookAudience ` , ` BookGroup ` , ` BookInclude ` , ` BookNode ` , ` ResolvedBook ` , ` ResolvedEntry ` , ` ResolvedGroup ` |
330332| [ ` cache.zod.ts ` ] ( /docs/references/system/cache ) | ` CacheAvalanchePrevention ` , ` CacheConfig ` , ` CacheConsistency ` , ` CacheInvalidation ` , ` CacheStrategy ` , ` CacheTier ` , ` CacheWarmup ` , ` DistributedCacheConfig ` |
331333| [ ` change-management.zod.ts ` ] ( /docs/references/system/change-management ) | ` ChangeImpact ` , ` ChangePriority ` , ` ChangeRequest ` , ` ChangeStatus ` , ` ChangeType ` , ` RollbackPlan ` |
332334| [ ` collaboration.zod.ts ` ] ( /docs/references/system/collaboration ) | ` AwarenessEvent ` , ` AwarenessSession ` , ` AwarenessUpdate ` , ` AwarenessUserState ` , ` CRDTMergeResult ` , ` CRDTState ` , ` CRDTType ` , ` CollaborationMode ` , ` CollaborationSession ` , ` CollaborationSessionConfig ` , ` CollaborativeCursor ` , ` CounterOperation ` , ` CursorColorPreset ` , ` CursorSelection ` , ` CursorStyle ` , ` CursorUpdate ` , ` GCounter ` , ` LWWRegister ` , ` ORSet ` , ` ORSetElement ` , ` OTComponent ` , ` OTOperation ` , ` OTOperationType ` , ` OTTransformResult ` , ` PNCounter ` , ` TextCRDTOperation ` , ` TextCRDTState ` , ` UserActivityStatus ` , ` VectorClock ` |
0 commit comments