fixed: document virtual columns in ving schema better #70

plainblack · Apr 4, 2024 · a11a757 · a11a757
1 parent ee31858
commit a11a757
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/docs/change-log.md b/docs/change-log.md
@@ -3,6 +3,9 @@ outline: deep
 ---
 # Change Log
 
+## 2024-04-04
+* Provided a little more documentation about virtual columns
+
 ## 2024-03-16
 * Created a function for fetching ving config in `ving/config.mjs`
 * Added a Rest versioning system for API breakages

diff --git a/docs/subsystems/ving-schema.md b/docs/subsystems/ving-schema.md
@@ -159,14 +159,14 @@ These are used to add a child relationship. They are virtual because they make n
 ```js
 {
     type: "virtual",
-    name: 'userId',
+    name: 'userId',  // the name of the column in the child table that connects it to this table
     required: false,
     view: ['public'],
     edit: [],
     relation: {
         type: 'child',
-        name: 'apikeys',
-        kind: 'APIKey',
+        name: 'apikeys', // the name of the relationship, think of it like the method name
+        kind: 'APIKey', // the class name of the child table
     },
 },
 ```