Skip to content

Commit b498e54

Browse files
committed
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 673771c commit b498e54

6 files changed

Lines changed: 11 additions & 23 deletions

File tree

content/docs/references/api/contract.mdx

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -102,26 +102,6 @@ const result = ApiError.parse(data);
102102

103103
## ExportRequest
104104

105-
### Properties
106-
107-
| Property | Type | Required | Description |
108-
| :--- | :--- | :--- | :--- |
109-
| **object** | `string` || Object name (e.g. account) |
110-
| **fields** | `string \| Object[]` | optional | Fields to retrieve |
111-
| **where** | `any` | optional | Filtering criteria (WHERE) |
112-
| **search** | `Object` | optional | Full-text search configuration ($search parameter) |
113-
| **orderBy** | `Object[]` | optional | Sorting instructions (ORDER BY) |
114-
| **limit** | `number` | optional | Max records to return (LIMIT) |
115-
| **offset** | `number` | optional | Records to skip (OFFSET) |
116-
| **cursor** | `Record<string, any>` | optional | Cursor for keyset pagination |
117-
| **joins** | `Object[]` | optional | Explicit Table Joins |
118-
| **aggregations** | `Object[]` | optional | Aggregation functions |
119-
| **groupBy** | `string[]` | optional | GROUP BY fields |
120-
| **having** | `any` | optional | HAVING clause for aggregation filtering |
121-
| **windowFunctions** | `Object[]` | optional | Window functions with OVER clause |
122-
| **distinct** | `boolean` | optional | SELECT DISTINCT flag |
123-
| **format** | `Enum<'csv' \| 'json' \| 'xlsx'>` | optional | |
124-
125105

126106
---
127107

content/docs/references/api/discovery.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ const result = ApiCapabilities.parse(data);
4747
| :--- | :--- | :--- | :--- |
4848
| **data** | `string` || e.g. /api/data |
4949
| **metadata** | `string` || e.g. /api/meta |
50+
| **ui** | `string` | optional | e.g. /api/ui |
5051
| **auth** | `string` || e.g. /api/auth |
5152
| **automation** | `string` | optional | e.g. /api/automation |
5253
| **storage** | `string` | optional | e.g. /api/storage |

content/docs/references/api/rest-server.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,7 @@ const result = BatchEndpointsConfig.parse(data);
156156
| **apiPath** | `string` | optional | Full API path (defaults to `{basePath}`/`{version}`) |
157157
| **enableCrud** | `boolean` | optional | Enable automatic CRUD endpoint generation |
158158
| **enableMetadata** | `boolean` | optional | Enable metadata API endpoints |
159+
| **enableUi** | `boolean` | optional | Enable UI API endpoints (Views, Menus, Layouts) |
159160
| **enableBatch** | `boolean` | optional | Enable batch operation endpoints |
160161
| **enableDiscovery** | `boolean` | optional | Enable API discovery endpoint |
161162
| **documentation** | `Object` | optional | OpenAPI/Swagger documentation config |

content/docs/references/data/query.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,13 +152,15 @@ Type: `string`
152152
| **orderBy** | `Object[]` | optional | Sorting instructions (ORDER BY) |
153153
| **limit** | `number` | optional | Max records to return (LIMIT) |
154154
| **offset** | `number` | optional | Records to skip (OFFSET) |
155+
| **top** | `number` | optional | Alias for limit (OData compatibility) |
155156
| **cursor** | `Record<string, any>` | optional | Cursor for keyset pagination |
156157
| **joins** | `Object[]` | optional | Explicit Table Joins |
157158
| **aggregations** | `Object[]` | optional | Aggregation functions |
158159
| **groupBy** | `string[]` | optional | GROUP BY fields |
159160
| **having** | `any` | optional | HAVING clause for aggregation filtering |
160161
| **windowFunctions** | `Object[]` | optional | Window functions with OVER clause |
161162
| **distinct** | `boolean` | optional | SELECT DISTINCT flag |
163+
| **expand** | `Record<string, any>` | optional | Recursive relation loading (nested queries) |
162164

163165

164166
---

content/docs/references/kernel/manifest.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ const result = Manifest.parse(data);
5959
| :--- | :--- | :--- | :--- |
6060
| **id** | `string` | ✅ | Unique package identifier (reverse domain style) |
6161
| **version** | `string` | ✅ | Package version (semantic versioning) |
62-
| **type** | `Enum<'app' \| 'plugin' \| 'driver' \| 'module' \| 'objectql' \| 'gateway' \| 'adapter'>` | ✅ | Type of package |
62+
| **type** | `Enum<'plugin' \| 'ui' \| 'driver' \| 'server' \| 'app' \| 'theme' \| 'agent' \| 'objectql' \| 'module' \| 'gateway' \| 'adapter'>` | ✅ | Type of package |
6363
| **name** | `string` | ✅ | Human-readable package name |
6464
| **description** | `string` | optional | Package description |
6565
| **permissions** | `string[]` | optional | Array of required permission strings |

content/docs/references/kernel/plugin.mdx

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ title: Plugin
33
description: Plugin protocol schemas
44
---
55

6-
Define an ObjectStack Plugin
6+
Shared Plugin Types
77

8-
Helper function for creating type-safe plugin definitions
8+
These are the specialized plugin types common between Manifest (Package) and Plugin (Runtime).
99

1010
<Callout type="info">
1111
**Source:** `packages/spec/src/kernel/plugin.zod.ts`
@@ -30,6 +30,10 @@ const result = Plugin.parse(data);
3030
| Property | Type | Required | Description |
3131
| :--- | :--- | :--- | :--- |
3232
| **id** | `string` | optional | Unique Plugin ID (e.g. com.example.crm) |
33+
| **type** | `Enum<'standard' \| 'ui' \| 'driver' \| 'server' \| 'app' \| 'theme' \| 'agent' \| 'objectql'>` | optional | Plugin Type categorization for runtime behavior |
34+
| **staticPath** | `string` | optional | Absolute path to static assets (Required for type="ui-plugin") |
35+
| **slug** | `string` | optional | URL path segment (Required for type="ui-plugin") |
36+
| **default** | `boolean` | optional | Serve at root path (Only one "ui-plugin" can be default) |
3337
| **version** | `string` | optional | Semantic Version |
3438
| **description** | `string` | optional | |
3539
| **author** | `string` | optional | |

0 commit comments

Comments
 (0)