|
1 | | -# Metadata Specifications |
| 1 | +# ObjectQL 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 | | -## Core Data Layer |
| 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 |
8 | 38 |
|
9 | | -* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation rules |
| 39 | +### Core Data Layer |
| 40 | +* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation |
10 | 41 | * [**Query Language (JSON-DSL)**](./query-language.md) - Unified query protocol for database-agnostic data access |
11 | 42 | * [**Validation Rules**](./validation.md) - Data quality and business rule enforcement |
12 | 43 |
|
13 | | -## Business Logic Layer |
14 | | - |
| 44 | +### Business Logic Layer |
15 | 45 | * [**Hooks (Triggers)**](./hook.md) - Event-driven logic attached to data operations |
16 | 46 | * [**Actions (RPC)**](./action.md) - Custom server-side functions and APIs |
17 | 47 | * [**Workflows & Processes**](./workflow.md) - Automated business processes and approval chains |
18 | 48 |
|
19 | | -## Presentation Layer |
20 | | - |
21 | | -* [**Views & Layouts**](./view.md) - Data presentation configurations (list, grid, kanban, calendar) |
| 49 | +### Presentation Layer |
| 50 | +* [**Views & Layouts**](./view.md) - Data presentation configurations |
22 | 51 | * [**Forms**](./form.md) - Data entry and editing interfaces |
23 | | -* [**Reports & Dashboards**](./report.md) - Analytics, visualizations, and business intelligence |
24 | | -* [**Applications & Navigation**](./application.md) - Application structure and menu hierarchy |
25 | | - |
26 | | -## Security & Access Control |
| 52 | +* [**Reports & Dashboards**](./report.md) - Analytics and BI |
| 53 | +* [**Applications & Navigation**](./application.md) - App identity, navigation structure, and context |
27 | 54 |
|
28 | | -* [**Permissions**](./permission.md) - Role-based access control, field-level security, and record-level rules |
| 55 | +### Security & Access Control |
| 56 | +* [**Permissions**](./permission.md) - Role-based access control and security rules |
29 | 57 |
|
30 | 58 | ## Design Philosophy |
31 | 59 |
|
|
0 commit comments