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/. */ }
@@ -21,7 +21,7 @@ counts are sums of the rows they head. Regenerate with
2121| Module | Pages | Schemas | Description |
2222| :--- | ---: | ---: | :--- |
2323| [ AI Protocol] ( /docs/references/ai ) | 12 | 68 | Agents, tools, skills, RAG and knowledge sources, model registry, conversations. |
24- | [ API Protocol] ( /docs/references/api ) | 32 | 438 | REST contracts, endpoints, routing, realtime, batch, discovery. |
24+ | [ API Protocol] ( /docs/references/api ) | 32 | 440 | REST contracts, endpoints, routing, realtime, batch, discovery. |
2525| [ Automation Protocol] ( /docs/references/automation ) | 13 | 71 | Flows and their nodes, approvals, ETL pipelines, webhooks, state machines, execution records. |
2626| [ Data Protocol] ( /docs/references/data ) | 29 | 176 | 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. |
@@ -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 ) | 36 | 285 | The runtime environment — logging, jobs, cache, metrics, notifications, i18n and compliance. |
3636| [ UI Protocol] ( /docs/references/ui ) | 16 | 169 | Apps, pages, views, dashboards, reports, actions and themes — the ObjectUI layer. |
37- | ** Total** | ** 197** | ** 1542 ** | 14 protocol modules |
37+ | ** Total** | ** 197** | ** 1544 ** | 14 protocol modules |
3838
3939---
4040
@@ -63,7 +63,7 @@ Agents, tools, skills, RAG and knowledge sources, model registry, conversations.
6363
6464## API Protocol
6565
66- ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 32 pages, 438 schemas**
66+ ** Source:** ` packages/spec/src/api/ ` · ** Import:** ` @objectstack/spec/api ` · ** 32 pages, 440 schemas**
6767
6868REST contracts, endpoints, routing, realtime, batch, discovery.
6969
@@ -72,7 +72,7 @@ REST contracts, endpoints, routing, realtime, batch, discovery.
7272| [ ` analytics.zod.ts ` ] ( /docs/references/api/analytics ) | ` AnalyticsEndpoint ` , ` AnalyticsMetadataResponse ` , ` AnalyticsQueryRequest ` , ` AnalyticsResultResponse ` , ` AnalyticsSqlResponse ` , ` DatasetCompareTo ` , ` DatasetSelection ` , ` DatasetTotals ` , ` GetAnalyticsMetaRequest ` |
7373| [ ` auth.zod.ts ` ] ( /docs/references/api/auth ) | ` AuthProvider ` , ` LoginRequest ` , ` LoginType ` , ` RefreshTokenRequest ` , ` RegisterRequest ` , ` Session ` , ` SessionResponse ` , ` SessionUser ` , ` UserProfileResponse ` |
7474| [ ` auth-endpoints.zod.ts ` ] ( /docs/references/api/auth-endpoints ) | ` AuthEndpoint ` , ` AuthFeaturesConfig ` , ` AuthProviderInfo ` , ` DeviceRequestResponse ` , ` DeviceTokenResponse ` , ` EmailPasswordConfigPublic ` , ` GetAuthConfigResponse ` |
75- | [ ` automation-api.zod.ts ` ] ( /docs/references/api/automation-api ) | ` AutomationApiErrorCode ` , ` AutomationFlowPathParams ` , ` AutomationRunPathParams ` , ` CreateFlowRequest ` , ` CreateFlowResponse ` , ` DeleteFlowRequest ` , ` DeleteFlowResponse ` , ` GetFlowRequest ` , ` GetFlowResponse ` , ` GetRunRequest ` , ` GetRunResponse ` , ` ListRunsRequest ` , ` ListRunsResponse ` , ` ResumeFailureDetails ` , ` ToggleFlowRequest ` , ` ToggleFlowResponse ` , ` TriggerFlowRequest ` , ` TriggerFlowResponse ` , ` UpdateFlowRequest ` , ` UpdateFlowResponse ` |
75+ | [ ` automation-api.zod.ts ` ] ( /docs/references/api/automation-api ) | ` AutomationApiErrorCode ` , ` AutomationFlowPathParams ` , ` AutomationRunPathParams ` , ` CreateFlowRequest ` , ` CreateFlowResponse ` , ` DeleteFlowRequest ` , ` DeleteFlowResponse ` , ` FlowFailureDetails ` , ` FlowInnerRefusal ` , ` GetFlowRequest ` , ` GetFlowResponse ` , ` GetRunRequest ` , ` GetRunResponse ` , ` ListRunsRequest ` , ` ListRunsResponse ` , ` ResumeFailureDetails ` , ` ToggleFlowRequest ` , ` ToggleFlowResponse ` , ` TriggerFlowRequest ` , ` TriggerFlowResponse ` , ` UpdateFlowRequest ` , ` UpdateFlowResponse ` |
7676| [ ` batch.zod.ts ` ] ( /docs/references/api/batch ) | ` BatchConfig ` , ` BatchOperationResult ` , ` BatchOperationType ` , ` BatchOptions ` , ` BatchRecord ` , ` BatchUpdateRequest ` , ` BatchUpdateResponse ` , ` CrossObjectBatchDroppedFields ` , ` CrossObjectBatchOperation ` , ` CrossObjectBatchRequest ` , ` CrossObjectBatchResponse ` , ` DeleteManyRequest ` , ` UpdateManyRecord ` , ` UpdateManyRequest ` |
7777| [ ` contract.zod.ts ` ] ( /docs/references/api/contract ) | ` ApiError ` , ` BaseResponse ` , ` BatchLoadingStrategy ` , ` BulkRequest ` , ` BulkResponse ` , ` CreateRequest ` , ` DataLoaderConfig ` , ` DeleteResponse ` , ` ExportRequest ` , ` IdRequest ` , ` ListRecordResponse ` , ` ModificationResult ` , ` QueryOptimizationConfig ` , ` RecordData ` , ` SingleRecordResponse ` , ` UpdateRequest ` |
7878| [ ` discovery.zod.ts ` ] ( /docs/references/api/discovery ) | ` ApiRoutes ` , ` AuthFamilies ` , ` CapabilityDescriptor ` , ` Discovery ` , ` DiscoveryEnvironment ` , ` EnvironmentType ` , ` RouteHealthEntry ` , ` RouteHealthReport ` , ` ServiceInfo ` , ` ServiceSelfInfo ` , ` ServiceStatus ` , ` WellKnownCapabilities ` |
0 commit comments