11---
22title : Protocol Reference
3- description : Every schema published by @objectstack/spec — 1535 schemas across 14 protocol modules
3+ description : Every schema published by @objectstack/spec — 1536 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,20 +20,20 @@ counts are sums of the rows they head. Regenerate with
2020| Module | Pages | Schemas | Description |
2121| :--- | ---: | ---: | :--- |
2222| [ AI Protocol] ( /docs/references/ai ) | 12 | 68 | Agents, tools, skills, RAG and knowledge sources, model registry, conversations. |
23- | [ API Protocol] ( /docs/references/api ) | 31 | 441 | REST contracts, endpoints, routing, realtime, batch, discovery. |
23+ | [ API Protocol] ( /docs/references/api ) | 31 | 444 | REST contracts, endpoints, routing, realtime, batch, discovery. |
2424| [ Automation Protocol] ( /docs/references/automation ) | 14 | 74 | Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execution records. |
2525| [ Data Protocol] ( /docs/references/data ) | 29 | 175 | Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer. |
2626| [ Identity Protocol] ( /docs/references/identity ) | 5 | 27 | Users and accounts, organizations, positions, SCIM provisioning. |
2727| [ Integration Protocol] ( /docs/references/integration ) | 1 | 24 | The single connector protocol (ADR-0097) — catalog descriptors and provider-bound instances. |
28- | [ Kernel Protocol] ( /docs/references/kernel ) | 30 | 159 | Plugin lifecycle and manifests, capabilities and security, metadata loading, service registry. |
28+ | [ Kernel Protocol] ( /docs/references/kernel ) | 30 | 157 | Plugin lifecycle and manifests, capabilities and security, metadata loading, service registry. |
2929| [ Marketplace Protocol] ( /docs/references/marketplace ) | 4 | 30 | The package & marketplace format — package identity and versions, listing, publish, review, search, install, template manifests. |
3030| [ QA Protocol] ( /docs/references/qa ) | 1 | 8 | Declarative test suites — scenarios, steps, actions and assertions. |
3131| [ Security Protocol] ( /docs/references/security ) | 5 | 30 | Permission sets, row-level security, sharing rules, tenancy posture. |
3232| [ Shared Protocol] ( /docs/references/shared ) | 10 | 31 | 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. |
3434| [ System Protocol] ( /docs/references/system ) | 34 | 275 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
3535| [ UI Protocol] ( /docs/references/ui ) | 16 | 158 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
36- | ** Total** | ** 195** | ** 1535 ** | 14 protocol modules |
36+ | ** Total** | ** 195** | ** 1536 ** | 14 protocol modules |
3737
3838---
3939
@@ -62,13 +62,13 @@ Agents, tools, skills, RAG and knowledge sources, model registry, conversations.
6262
6363## API Protocol
6464
65- ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 31 pages, 441 schemas**
65+ ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 31 pages, 444 schemas**
6666
6767REST contracts, endpoints, routing, realtime, batch, discovery.
6868
6969| File | Schemas |
7070| :--- | :--- |
71- | [ ` analytics.zod.ts ` ] ( /docs/references/api/analytics ) | ` AnalyticsEndpoint ` , ` AnalyticsMetadataResponse ` , ` AnalyticsQueryRequest ` , ` AnalyticsResultResponse ` , ` AnalyticsSqlResponse ` , ` GetAnalyticsMetaRequest ` |
71+ | [ ` analytics.zod.ts ` ] ( /docs/references/api/analytics ) | ` AnalyticsEndpoint ` , ` AnalyticsMetadataResponse ` , ` AnalyticsQueryRequest ` , ` AnalyticsResultResponse ` , ` AnalyticsSqlResponse ` , ` DatasetCompareTo ` , ` DatasetSelection ` , ` DatasetTotals ` , ` GetAnalyticsMetaRequest ` |
7272| [ ` auth.zod.ts ` ] ( /docs/references/api/auth ) | ` AuthProvider ` , ` LoginRequest ` , ` LoginType ` , ` RefreshTokenRequest ` , ` RegisterRequest ` , ` Session ` , ` SessionResponse ` , ` SessionUser ` , ` UserProfileResponse ` |
7373| [ ` auth-endpoints.zod.ts ` ] ( /docs/references/api/auth-endpoints ) | ` AuthEndpoint ` , ` AuthFeaturesConfig ` , ` AuthProviderInfo ` , ` DeviceRequestResponse ` , ` DeviceTokenResponse ` , ` EmailPasswordConfigPublic ` , ` GetAuthConfigResponse ` |
7474| [ ` automation-api.zod.ts ` ] ( /docs/references/api/automation-api ) | ` AutomationApiErrorCode ` , ` AutomationFlowPathParams ` , ` AutomationRunPathParams ` , ` CreateFlowRequest ` , ` CreateFlowResponse ` , ` DeleteFlowRequest ` , ` DeleteFlowResponse ` , ` FlowSummary ` , ` GetFlowRequest ` , ` GetFlowResponse ` , ` GetRunRequest ` , ` GetRunResponse ` , ` ListFlowsRequest ` , ` ListFlowsResponse ` , ` ListRunsRequest ` , ` ListRunsResponse ` , ` ResumeFailureDetails ` , ` ToggleFlowRequest ` , ` ToggleFlowResponse ` , ` TriggerFlowRequest ` , ` TriggerFlowResponse ` , ` UpdateFlowRequest ` , ` UpdateFlowResponse ` |
@@ -197,7 +197,7 @@ The single connector protocol (ADR-0097) — catalog descriptors and provider-bo
197197
198198## Kernel Protocol
199199
200- ** Source:** ` packages/spec/src/kernel/ ` · ** Import:** ` @objectstack/spec/kernel ` · ** 30 pages, 159 schemas**
200+ ** Source:** ` packages/spec/src/kernel/ ` · ** Import:** ` @objectstack/spec/kernel ` · ** 30 pages, 157 schemas**
201201
202202Plugin lifecycle and manifests, capabilities and security, metadata loading, service registry.
203203
@@ -227,7 +227,7 @@ Plugin lifecycle and manifests, capabilities and security, metadata loading, ser
227227| [ ` plugin-loading.zod.ts ` ] ( /docs/references/kernel/plugin-loading ) | ` PluginLoadingEvent ` , ` PluginLoadingState ` |
228228| [ ` plugin-registry.zod.ts ` ] ( /docs/references/kernel/plugin-registry ) | ` PluginInstallConfig ` , ` PluginQualityMetrics ` , ` PluginRegistryEntry ` , ` PluginSearchFilters ` , ` PluginStatistics ` , ` PluginVendor ` |
229229| [ ` plugin-security.zod.ts ` ] ( /docs/references/kernel/plugin-security ) | ` DependencyGraph ` , ` DependencyGraphNode ` , ` PackageDependencyConflict ` , ` PackageDependencyResolutionResult ` , ` PluginProvenance ` , ` PluginTrustScore ` , ` ResolvedPackageDependency ` , ` SBOM ` , ` SBOMEntry ` , ` SecurityPolicy ` , ` SecurityScanResult ` , ` SecurityVulnerability ` , ` VulnerabilitySeverity ` |
230- | [ ` plugin-security-advanced.zod.ts ` ] ( /docs/references/kernel/plugin-security-advanced ) | ` KernelSecurityPolicy ` , ` KernelSecurityScanResult ` , ` KernelSecurityVulnerability ` , ` PermissionAction ` , ` PermissionScope ` , ` PluginPermission ` , ` PluginPermissionSet ` , ` PluginSecurityManifest ` , ` PluginTrustLevel ` , ` ResourceType ` , ` RuntimeConfig ` , ` SandboxConfig ` |
230+ | [ ` plugin-security-advanced.zod.ts ` ] ( /docs/references/kernel/plugin-security-advanced ) | ` KernelSecurityPolicy ` , ` PermissionAction ` , ` PermissionScope ` , ` PluginPermission ` , ` PluginPermissionSet ` , ` PluginSecurityManifest ` , ` PluginTrustLevel ` , ` ResourceType ` , ` RuntimeConfig ` , ` SandboxConfig ` |
231231| [ ` plugin-structure.zod.ts ` ] ( /docs/references/kernel/plugin-structure ) | ` OpsDomainModule ` , ` OpsFilePath ` , ` OpsPluginStructure ` |
232232| [ ` plugin-validator.zod.ts ` ] ( /docs/references/kernel/plugin-validator ) | ` PluginMetadata ` , ` ValidationError ` , ` ValidationResult ` , ` ValidationWarning ` |
233233| [ ` plugin-versioning.zod.ts ` ] ( /docs/references/kernel/plugin-versioning ) | ` BreakingChange ` , ` CompatibilityLevel ` , ` CompatibilityMatrixEntry ` , ` DependencyConflict ` , ` DeprecationNotice ` , ` MultiVersionSupport ` , ` PluginCompatibilityMatrix ` , ` PluginDependencyResolutionResult ` , ` PluginVersionMetadata ` , ` SemanticVersion ` , ` VersionConstraint ` |
0 commit comments