File tree Expand file tree Collapse file tree 16 files changed +186
-96
lines changed
Expand file tree Collapse file tree 16 files changed +186
-96
lines changed Original file line number Diff line number Diff line change @@ -12,8 +12,8 @@ description: Object Schema Reference
1212| ** pluralLabel** | ` string ` | optional | Plural Label (e.g. "Accounts") |
1313| ** description** | ` string ` | optional | Internal description |
1414| ** icon** | ` string ` | optional | Lucide icon name |
15- | ** datasource** | ` string ` | optional | Datasource name |
16- | ** tableName** | ` string ` | optional | Physical DB table override |
15+ | ** datasource** | ` string ` | optional | Target Datasource ID (e.g. "postgres", "salesforce"). references sys_datasource. |
16+ | ** tableName** | ` string ` | optional | Physical table/collection name in the target datasource |
1717| ** isSystem** | ` boolean ` | optional | Is system object (protected) |
1818| ** fields** | ` Record<string, object> ` | ✅ | Map of field definitions |
1919| ** indexes** | ` object[] ` | optional | Database indexes definition |
Original file line number Diff line number Diff line change 1+ ---
2+ title : MenuItem
3+ description : MenuItem Schema Reference
4+ ---
5+
6+ ## Properties
7+
8+ | Property | Type | Required | Description |
9+ | :--- | :--- | :--- | :--- |
10+ | ** label** | ` string ` | ✅ | Display label for the menu item |
11+ | ** path** | ` string ` | ✅ | Navigation path (route) for the menu item |
12+ | ** icon** | ` string ` | optional | Optional icon identifier for the menu item |
Original file line number Diff line number Diff line change 1+ ---
2+ title : DriverDefinition
3+ description : DriverDefinition Schema Reference
4+ ---
5+
6+ ## Properties
7+
8+ | Property | Type | Required | Description |
9+ | :--- | :--- | :--- | :--- |
10+ | ** id** | ` string ` | ✅ | Unique driver identifier (e.g. "postgres") |
11+ | ** label** | ` string ` | ✅ | Display label (e.g. "PostgreSQL") |
12+ | ** description** | ` string ` | optional | |
13+ | ** icon** | ` string ` | optional | |
14+ | ** configSchema** | ` Record<string, any> ` | ✅ | JSON Schema for connection configuration |
15+ | ** capabilities** | ` object ` | optional | |
Original file line number Diff line number Diff line change @@ -14,5 +14,6 @@ description: Manifest Schema Reference
1414| ** description** | ` string ` | optional | Package description |
1515| ** permissions** | ` string[] ` | optional | Array of required permission strings |
1616| ** objects** | ` string[] ` | optional | Glob patterns for ObjectQL schemas files |
17- | ** contributes** | ` object ` | optional | Platform contributions (e.g. kinds) |
17+ | ** datasources** | ` string[] ` | optional | Glob patterns for Datasource definitions |
18+ | ** contributes** | ` object ` | optional | Platform contributions |
1819| ** extensions** | ` Record<string, any> ` | optional | Extension points and contributions |
Original file line number Diff line number Diff line change @@ -9,7 +9,7 @@ description: Datasource Schema Reference
99| :--- | :--- | :--- | :--- |
1010| ** name** | ` string ` | ✅ | Unique datasource identifier |
1111| ** label** | ` string ` | optional | Display label |
12- | ** driver** | ` Enum<'postgres' \| 'mysql' \| 'sqlserver' \| 'oracle' \| 'sqlite' \| 'mongo' \| 'redis' \| 'excel' \| 'csv' \| 'airtable' \| 'rest_api' \| 'graphql' \| 'odata' \| 'salesforce' \| 'sap' \| 'workday'> ` | ✅ | Underlying driver type |
12+ | ** driver** | ` string ` | ✅ | Underlying driver type |
1313| ** config** | ` Record<string, any> ` | ✅ | Driver specific configuration |
1414| ** capabilities** | ` object ` | optional | Capability overrides |
1515| ** description** | ` string ` | optional | Internal description |
Original file line number Diff line number Diff line change 11---
22title : DriverType
3- description : DriverType Schema Reference
3+ description : Underlying driver identifier
44---
55
6- ## Allowed Values
6+ Underlying driver identifier
77
8- * ` postgres `
9- * ` mysql `
10- * ` sqlserver `
11- * ` oracle `
12- * ` sqlite `
13- * ` mongo `
14- * ` redis `
15- * ` excel `
16- * ` csv `
17- * ` airtable `
18- * ` rest_api `
19- * ` graphql `
20- * ` odata `
21- * ` salesforce `
22- * ` sap `
23- * ` workday `
Original file line number Diff line number Diff line change @@ -16,7 +16,6 @@ description: App Schema Reference
1616| ** active** | ` boolean ` | optional | Whether the app is enabled |
1717| ** isDefault** | ` boolean ` | optional | Is default app |
1818| ** navigation** | ` object \| object \| object \| object \| object[] ` | optional | Structured navigation menu tree |
19- | ** menus** | ` any[] ` | optional | Deprecated: Use navigation instead |
2019| ** homePageId** | ` string ` | optional | ID of the navigation item to serve as landing page |
2120| ** requiredPermissions** | ` string[] ` | optional | Permissions required to access this app |
2221| ** objects** | ` any[] ` | optional | Objects belonging to this app |
Original file line number Diff line number Diff line change 266266 },
267267 "description" : " Structured navigation menu tree"
268268 },
269- "menus" : {
270- "type" : " array" ,
271- "description" : " Deprecated: Use navigation instead"
272- },
273269 "homePageId" : {
274270 "type" : " string" ,
275271 "description" : " ID of the navigation item to serve as landing page"
Original file line number Diff line number Diff line change 1515 },
1616 "driver" : {
1717 "type" : " string" ,
18- "enum" : [
19- " postgres" ,
20- " mysql" ,
21- " sqlserver" ,
22- " oracle" ,
23- " sqlite" ,
24- " mongo" ,
25- " redis" ,
26- " excel" ,
27- " csv" ,
28- " airtable" ,
29- " rest_api" ,
30- " graphql" ,
31- " odata" ,
32- " salesforce" ,
33- " sap" ,
34- " workday"
35- ],
3618 "description" : " Underlying driver type"
3719 },
3820 "config" : {
Original file line number Diff line number Diff line change 1+ {
2+ "$ref" : " #/definitions/DriverDefinition" ,
3+ "definitions" : {
4+ "DriverDefinition" : {
5+ "type" : " object" ,
6+ "properties" : {
7+ "id" : {
8+ "type" : " string" ,
9+ "description" : " Unique driver identifier (e.g. \" postgres\" )"
10+ },
11+ "label" : {
12+ "type" : " string" ,
13+ "description" : " Display label (e.g. \" PostgreSQL\" )"
14+ },
15+ "description" : {
16+ "type" : " string"
17+ },
18+ "icon" : {
19+ "type" : " string"
20+ },
21+ "configSchema" : {
22+ "type" : " object" ,
23+ "additionalProperties" : {},
24+ "description" : " JSON Schema for connection configuration"
25+ },
26+ "capabilities" : {
27+ "type" : " object" ,
28+ "properties" : {
29+ "joins" : {
30+ "type" : " boolean" ,
31+ "default" : false
32+ },
33+ "transactions" : {
34+ "type" : " boolean" ,
35+ "default" : false
36+ },
37+ "fullTextSearch" : {
38+ "type" : " boolean" ,
39+ "default" : false
40+ },
41+ "aggregation" : {
42+ "type" : " boolean" ,
43+ "default" : false
44+ },
45+ "dynamicSchema" : {
46+ "type" : " boolean" ,
47+ "default" : false
48+ },
49+ "readOnly" : {
50+ "type" : " boolean" ,
51+ "default" : false
52+ }
53+ },
54+ "additionalProperties" : false
55+ }
56+ },
57+ "required" : [
58+ " id" ,
59+ " label" ,
60+ " configSchema"
61+ ],
62+ "additionalProperties" : false
63+ }
64+ },
65+ "$schema" : " http://json-schema.org/draft-07/schema#"
66+ }
You can’t perform that action at this time.
0 commit comments