11---
22title : Protocol reference — every schema by module
33navTitle : Protocol Reference
4- description : Every schema published by @objectstack/spec — 1542 schemas across 14 protocol modules
4+ description : Every schema published by @objectstack/spec — 1544 schemas across 14 protocol modules
55---
66
77{ /* ⚠️ AUTO-GENERATED — DO NOT EDIT. Run build-docs.ts to regenerate. Hand-written docs live in the module folders under content/docs/. */ }
@@ -23,7 +23,7 @@ counts are sums of the rows they head. Regenerate with
2323| [ AI Protocol] ( /docs/references/ai ) | 12 | 68 | Agents, tools, skills, RAG and knowledge sources, model registry, conversations. |
2424| [ API Protocol] ( /docs/references/api ) | 32 | 438 | REST contracts, endpoints, routing, realtime, batch, discovery. |
2525| [ Automation Protocol] ( /docs/references/automation ) | 14 | 73 | Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execution records. |
26- | [ Data Protocol] ( /docs/references/data ) | 29 | 178 | Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer. |
26+ | [ Data Protocol] ( /docs/references/data ) | 30 | 180 | Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer. |
2727| [ Identity Protocol] ( /docs/references/identity ) | 5 | 27 | Users and accounts, organizations, positions, SCIM provisioning. |
2828| [ Integration Protocol] ( /docs/references/integration ) | 1 | 12 | The single connector protocol (ADR-0097) — catalog descriptors and provider-bound instances. |
2929| [ Kernel Protocol] ( /docs/references/kernel ) | 29 | 151 | Plugin lifecycle and manifests, capabilities and security, metadata loading, service registry. |
@@ -34,7 +34,7 @@ counts are sums of the rows they head. Regenerate with
3434| [ Studio Protocol] ( /docs/references/studio ) | 3 | 35 | Studio designer metadata — the authoring surfaces for the protocols above. |
3535| [ System Protocol] ( /docs/references/system ) | 37 | 286 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
3636| [ UI Protocol] ( /docs/references/ui ) | 16 | 171 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
37- | ** Total** | ** 198 ** | ** 1542 ** | 14 protocol modules |
37+ | ** Total** | ** 199 ** | ** 1544 ** | 14 protocol modules |
3838
3939---
4040
@@ -131,13 +131,14 @@ Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execu
131131
132132## Data Protocol
133133
134- ** Source:** ` packages/spec/src/data/ ` · ** Import:** ` @objectstack/spec/data ` · ** 29 pages, 178 schemas**
134+ ** Source:** ` packages/spec/src/data/ ` · ** Import:** ` @objectstack/spec/data ` · ** 30 pages, 180 schemas**
135135
136136Objects, fields, queries, filters, datasources and drivers — the ObjectQL layer.
137137
138138| File | Schemas |
139139| :--- | :--- |
140140| [ ` analytics.zod.ts ` ] ( /docs/references/data/analytics ) | ` AggregationMetricType ` , ` AnalyticsDateRange ` , ` AnalyticsDateRangePreset ` , ` AnalyticsQuery ` , ` Cube ` , ` CubeJoin ` , ` Dimension ` , ` DimensionType ` , ` Metric ` , ` TimeUpdateInterval ` |
141+ | [ ` column-apply-on.zod.ts ` ] ( /docs/references/data/column-apply-on ) | ` ColumnApplyOn ` |
141142| [ ` context-tokens.zod.ts ` ] ( /docs/references/data/context-tokens ) | ` ContextToken ` , ` ContextTokenPlaceholder ` |
142143| [ ` data-engine.zod.ts ` ] ( /docs/references/data/data-engine ) | ` BaseEngineOptions ` , ` DataEngineAggregateOptions ` , ` DataEngineAggregateRequest ` , ` DataEngineCountOptions ` , ` DataEngineCountRequest ` , ` DataEngineDeleteOptions ` , ` DataEngineDeleteRequest ` , ` DataEngineExecuteRequest ` , ` DataEngineFilter ` , ` DataEngineFindOneRequest ` , ` DataEngineFindRequest ` , ` DataEngineInsertOptions ` , ` DataEngineInsertRequest ` , ` DataEngineQueryOptions ` , ` DataEngineRequest ` , ` DataEngineSort ` , ` DataEngineUpdateOptions ` , ` DataEngineUpdateRequest ` , ` DataEngineVectorFindRequest ` , ` DroppedFieldsEvent ` , ` EngineAggregateOptions ` , ` EngineCountOptions ` , ` EngineDeleteOptions ` , ` EngineQueryOptions ` , ` EngineUpdateOptions ` , ` QueryPageWindow ` , ` QueryPageWindowParam ` , ` QueryTransportParams ` , ` QueryWithTransport ` , ` ValidationAdvisoryEvent ` |
143144| [ ` datasource.zod.ts ` ] ( /docs/references/data/datasource ) | ` Datasource ` , ` DriverDefinition ` , ` DriverType ` , ` ExternalDatasourceSettings ` , ` SchemaMode ` |
@@ -163,7 +164,7 @@ Objects, fields, queries, filters, datasources and drivers — the ObjectQL laye
163164| [ ` object.zod.ts ` ] ( /docs/references/data/object ) | ` ApiMethod ` , ` ApiOperation ` , ` Index ` , ` Lifecycle ` , ` LifecycleClass ` , ` Object ` , ` ObjectAccessConfig ` , ` ObjectCapabilities ` , ` ObjectExtension ` , ` ObjectExternalBinding ` , ` ObjectFieldGroup ` , ` ObjectOwnershipEnum ` , ` ObjectRequiredPermissions ` , ` PerOperationRequiredPermissions ` , ` RowCrudActionOverride ` , ` TenancyConfig ` |
164165| [ ` picklist.zod.ts ` ] ( /docs/references/data/picklist ) | ` Picklist ` , ` PicklistExtension ` , ` PicklistServedField ` |
165166| [ ` query.zod.ts ` ] ( /docs/references/data/query ) | ` AggregationFunction ` , ` AggregationNode ` , ` DateGranularity ` , ` FieldNode ` , ` FullTextSearch ` , ` GroupByNode ` , ` Query ` , ` SortNode ` |
166- | [ ` seed.zod.ts ` ] ( /docs/references/data/seed ) | ` Seed ` , ` SeedMode ` |
167+ | [ ` seed.zod.ts ` ] ( /docs/references/data/seed ) | ` Seed ` , ` SeedColumn ` , ` SeedMode ` |
167168| [ ` seed-loader.zod.ts ` ] ( /docs/references/data/seed-loader ) | ` ObjectDependencyGraph ` , ` ObjectDependencyNode ` , ` ReferenceResolution ` , ` ReferenceResolutionError ` , ` SeedIdentity ` , ` SeedLoadResult ` , ` SeedLoaderConfig ` , ` SeedLoaderRequest ` , ` SeedLoaderResult ` |
168169| [ ` validation.zod.ts ` ] ( /docs/references/data/validation ) | ` ConditionalValidation ` , ` CrossFieldValidation ` , ` FormatValidation ` , ` JSONValidation ` , ` ScriptValidation ` , ` StateMachineValidation ` , ` ValidationRule ` |
169170
0 commit comments