You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Renamed 'Applications & Navigation' to 'Menus & Navigation' in the VitePress sidebar and updated corresponding links. The spec index was reorganized for clarity, with improved sectioning and descriptions, and removed the AI-Native Metadata Design section for conciseness.
Copy file name to clipboardExpand all lines: docs/spec/index.md
+13-37Lines changed: 13 additions & 37 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,47 +1,17 @@
1
-
# ObjectQL Metadata Specifications
1
+
# Metadata Specifications
2
2
3
3
This section contains the complete metadata specifications for the ObjectQL platform. ObjectQL is a metadata-driven standard for enterprise applications - every aspect of your application is defined through structured metadata.
4
4
5
5
📖 **[Read the Complete Metadata Standard Guide](./metadata-standard.md)** - A comprehensive overview of the entire metadata system and how all pieces fit together.
6
6
7
-
## 🤖 AI-Native Metadata Design
8
-
9
-
ObjectQL metadata is designed from the ground up to be **AI-friendly**, enabling:
10
-
11
-
-**Better Code Generation**: AI tools understand business intent, not just syntax
12
-
-**Natural Language Queries**: Convert user questions to structured queries
13
-
-**Auto-Documentation**: Generate comprehensive docs from metadata
14
-
-**Smart Validation**: AI suggests improvements and catches errors
15
-
-**Realistic Test Data**: Generate test data following proper patterns
16
-
17
-
### AI Context Blocks
18
-
19
-
All metadata types support optional `ai_context` blocks that provide semantic information:
20
-
21
-
```yaml
22
-
# Example: Object with AI context
23
-
name: project
24
-
fields:
25
-
status:
26
-
type: select
27
-
options: [planning, active, completed]
28
-
29
-
ai_context:
30
-
intent: "Track project through its lifecycle"
31
-
is_state_machine: true
32
-
transitions:
33
-
planning: [active, cancelled]
34
-
active: [completed, cancelled]
35
-
```
36
-
37
-
## 🗂️ Specification Categories
7
+
## Core Data Layer
38
8
39
-
### Core Data Layer
40
-
* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation
9
+
*[**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation rules
41
10
*[**Query Language (JSON-DSL)**](./query-language.md) - Unified query protocol for database-agnostic data access
42
11
*[**Validation Rules**](./validation.md) - Data quality and business rule enforcement
43
12
44
-
### Business Logic Layer
13
+
## Business Logic Layer
14
+
45
15
*[**Hooks (Triggers)**](./hook.md) - Event-driven logic attached to data operations
46
16
*[**Actions (RPC)**](./action.md) - Custom server-side functions and APIs
47
17
*[**Workflows & Processes**](./workflow.md) - Automated business processes and approval chains
@@ -53,8 +23,14 @@ fields:
53
23
*[**Reports & Dashboards**](./report.md) - Analytics and BI
54
24
*[**Menus & Navigation**](./menu.md) - Application structure and navigation hierarchy
55
25
56
-
### Security & Access Control
57
-
* [**Permissions**](./permission.md) - Role-based access control and security rules
0 commit comments