Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion content/docs/references/ai/agent.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Agent
title: Agent schema — AI Protocol property reference
navTitle: Agent
description: "Agent schemas of the ObjectStack AI Protocol: AIModelConfig, Agent and 3 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/build-progress.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Build Progress
title: Build Progress schema — AI Protocol reference
navTitle: Build Progress
description: "Build-progress PHASE vocabulary for the data-build-progress stream frame."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/conversation.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Conversation
title: Conversation schema — AI Protocol reference
navTitle: Conversation
description: "Multi-turn AI conversations with token budget management. Enables context preservation, conversation history, and token optimization."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/embedding.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Embedding
title: Embedding schema — AI Protocol reference
navTitle: Embedding
description: "Embedding & Vector Store Primitives — Platform contract for configuring embedding models and vector stores."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: AI Protocol
title: AI Protocol — complete schema reference
navTitle: AI Protocol
description: "The ObjectStack AI Protocol in 12 reference pages: every schema in @objectstack/spec with its properties, types, defaults and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/knowledge-document.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Knowledge Document
title: Knowledge Document — AI Protocol reference
navTitle: Knowledge Document
description: "Knowledge Document / Chunk / Hit — canonical shapes shared by every IKnowledgeAdapter implementation."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/knowledge-source.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Knowledge Source
title: Knowledge Source — AI Protocol reference
navTitle: Knowledge Source
description: "Knowledge Source — declarative metadata describing what to index and which adapter to use."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/mcp.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Mcp
title: Mcp schema — AI Protocol property reference
navTitle: Mcp
description: "Model Context Protocol (MCP) — Reference & Binding Primitives — MCP itself is an external protocol defined by Anthropic."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/model-registry.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Model Registry
title: Model Registry schema — AI Protocol reference
navTitle: Model Registry
description: "Centralized registry for managing AI models, prompt templates, and model versioning."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/skill.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Skill
title: Skill schema — AI Protocol property reference
navTitle: Skill
description: "Defines programmatic conditions under which a skill becomes active. Allows context-aware activation based on object type, user role, etc."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/solution-blueprint.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Solution Blueprint
title: Solution Blueprint — AI Protocol reference
navTitle: Solution Blueprint
description: "The structured-output target an AI agent emits for a high-level goal (\"build me a project-management system\") instead of transcribing a field list."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/tool.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Tool
title: Tool schema — AI Protocol property reference
navTitle: Tool
description: "Tool schemas of the ObjectStack AI Protocol: Tool — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/ai/usage.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Usage
title: Usage schema — AI Protocol property reference
navTitle: Usage
description: "AI Usage Primitives — Platform contract for measuring AI consumption. Reference for AIUsageRecord, TokenUsage: every property with its type and default."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/analytics.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Analytics
title: Analytics schema — API Protocol reference
navTitle: Analytics
description: "Defines the HTTP interface for the Semantic Layer. Provides endpoints for executing analytical queries and discovering metadata."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/auth-endpoints.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Auth Endpoints
title: Auth Endpoints schema — API Protocol reference
navTitle: Auth Endpoints
description: "Defines the canonical HTTP endpoints for the authentication service. Based on better-auth v1.4.18 endpoint conventions."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/auth.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Auth
title: Auth schema — API Protocol property reference
navTitle: Auth
description: "Defines the standard API contracts for Identity, Session Management, and Access Control."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/automation-api.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Automation Api
title: Automation Api schema — API Protocol reference
navTitle: Automation Api
description: "Defines REST CRUD endpoint schemas for managing automation flows, triggering executions, and querying execution history."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/batch.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Batch
title: Batch schema — API Protocol property reference
navTitle: Batch
description: "Batch Operations API — Provides efficient bulk data operations with transaction support."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/contract.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Contract
title: Contract schema — API Protocol reference
navTitle: Contract
description: "Contract schemas of the ObjectStack API Protocol: ApiError, BaseResponse and 14 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/discovery.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Discovery
title: Discovery schema — API Protocol reference
navTitle: Discovery
description: "Discovery schemas of the ObjectStack API Protocol: ApiRoutes, CapabilityDescriptor and 9 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/dispatcher.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Dispatcher
title: Dispatcher schema — API Protocol reference
navTitle: Dispatcher
description: "Defines how the ObjectStack HttpDispatcher routes incoming API requests to the correct kernel service based on URL prefix matching."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Documentation
title: Documentation schema — API Protocol reference
navTitle: Documentation
description: "Provides schemas for generating interactive API documentation and testing interfaces similar to Swagger UI, Postman, etc."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/endpoint.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Endpoint
title: Endpoint schema — API Protocol reference
navTitle: Endpoint
description: "Endpoint schemas of the ObjectStack API Protocol: ApiEndpoint, ApiMapping — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/error-code-ledger.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Error Code Ledger
title: Error Code Ledger — API Protocol reference
navTitle: Error Code Ledger
description: "Error-Code Ledger. Reference for ErrorCode, ProvenanceWaiver, StandardSynonymWaiver: every property with its type and default."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/errors.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Errors
title: Errors schema — API Protocol reference
navTitle: Errors
description: "Provides consistent, machine-readable error codes across the platform."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/events.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Events
title: Events schema — API Protocol reference
navTitle: Events
description: "Events schemas of the ObjectStack API Protocol: BulkDataEvent, BulkDataEventType and 4 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/export.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Export
title: Export schema — API Protocol reference
navTitle: Export
description: "Defines the export file formats, import validation, template-based field mapping, and the asynchronous import-job contracts."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/http-cache.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Http Cache
title: Http Cache schema — API Protocol reference
navTitle: Http Cache
description: "HTTP Metadata Cache Protocol — Implements efficient HTTP-level metadata caching with ETag support."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: API Protocol
title: API Protocol — complete schema reference
navTitle: API Protocol
description: "The ObjectStack API Protocol in 32 reference pages: every schema in @objectstack/spec with its properties, types, defaults and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/metadata.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Metadata
title: Metadata schema — API Protocol reference
navTitle: Metadata
description: "Defines the standard API contracts for the @objectstack/metadata package."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/misc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Misc
title: Misc schema — API Protocol property reference
navTitle: Misc
description: "Misc schemas of the ObjectStack API Protocol: ResolvedBook, ResolvedEntry, ResolvedGroup — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/odata.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Odata
title: Odata schema — API Protocol property reference
navTitle: Odata
description: "Open Data Protocol (OData) v4 is an industry-standard protocol for building and consuming RESTful APIs."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/package-api-assembled.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Package Api Assembled
title: Package Api Assembled — API Protocol reference
navTitle: Package Api Assembled
description: "The Package API declarations that carry the ASSEMBLED package body. Published from @objectstack/spec/api-assembled, never from @objectstack/spec/api."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/package-api.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Package Api
title: Package Api schema — API Protocol reference
navTitle: Package Api
description: "Package API Protocol — REST API endpoint schemas for package lifecycle management."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/package-lifecycle.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Package Lifecycle
title: Package Lifecycle — API Protocol reference
navTitle: Package Lifecycle
description: "Response payloads for the dispatcher-served packages.* lifecycle routes — the ADR-0067 commit timeline, the ADR-0033 draft batch doors."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/plugin-rest-api.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Plugin Rest Api
title: Plugin Rest Api — API Protocol reference
navTitle: Plugin Rest Api
description: "Defines the schema for REST API plugins that register Discovery, Metadata, Data CRUD, Batch, and Permission routes with the HTTP Dispatcher."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/protocol.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Protocol
title: Protocol schema — API Protocol reference
navTitle: Protocol
description: "Protocol schemas of the ObjectStack API Protocol: AiAgentCapabilities and 133 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/query-adapter.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Query Adapter
title: Query Adapter schema — API Protocol reference
navTitle: Query Adapter
description: "Defines mapping rules between the internal unified query DSL (defined in data/query.zod.ts) and external API protocol formats: REST and OData."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/realtime-shared.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Realtime Shared
title: Realtime Shared — API Protocol reference
navTitle: Realtime Shared
description: "Realtime Shared Protocol — Shared schemas and types for real-time communication protocols."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/realtime.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Realtime
title: Realtime schema — API Protocol reference
navTitle: Realtime
description: "Realtime schemas of the ObjectStack API Protocol: RealtimeConfig, RealtimeEvent and 5 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/rest-server.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Rest Server
title: Rest Server schema — API Protocol reference
navTitle: Rest Server
description: "Defines the REST API server configuration for automatically generating RESTful CRUD endpoints, metadata endpoints, and batch operations."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/router.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Router
title: Router schema — API Protocol reference
navTitle: Router
description: "Router schemas of the ObjectStack API Protocol: ConflictResolutionStrategy and 4 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/sortability.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Sortability
title: Sortability schema — API Protocol reference
navTitle: Sortability
description: "The per-column SORTABILITY projection served with object metadata — the one signal a grid reads to decide whether a column header offers a sort click."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/storage.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Storage
title: Storage schema — API Protocol reference
navTitle: Storage
description: "Storage Service Protocol — Defines the API contract for client-side file operations."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/versioning.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Versioning
title: Versioning schema — API Protocol reference
navTitle: Versioning
description: "Defines how API versions are negotiated between client and server. Supports multiple versioning strategies and deprecation lifecycle management."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/api/websocket.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Websocket
title: Websocket schema — API Protocol reference
navTitle: Websocket
description: "Defines the schema for WebSocket-based real-time communication in ObjectStack."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/automation/approval.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Approval
title: Approval — Automation Protocol reference
navTitle: Approval
description: "Approval schemas of the ObjectStack Automation Protocol: ApprovalDecision and 5 more — each property with its type, default and a TypeScript example."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/automation/bpmn-interop.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Bpmn Interop
title: Bpmn Interop — Automation Protocol reference
navTitle: Bpmn Interop
description: "Defines the specification for importing and exporting BPMN 2.0 XML process definitions."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/automation/builtin-node-config.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Builtin Node Config
title: Builtin Node Config — Automation Protocol
navTitle: Builtin Node Config
description: "Config contracts for the remaining flat builtins — the CRUD quartet (get_record / create_record / update_record / delete_record), screen, map."
---

Expand Down
3 changes: 2 additions & 1 deletion content/docs/references/automation/control-flow.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Control Flow
title: Control Flow — Automation Protocol reference
navTitle: Control Flow
description: "Structured control-flow constructs — the native + AI-authored flow model: a loop container, a parallel block, and structured try/catch/retry."
---

Expand Down
Loading
Loading