add model documentation

octoenergy · Nov 12, 2024 · 68f15be · 68f15be
1 parent 5976ddd
commit 68f15be
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/jaffle_shop/models/staging/src_seed/_models.yml b/jaffle_shop/models/staging/src_seed/_models.yml
@@ -37,6 +37,11 @@ models:
       - name: last_name_hash
 
   - name: stg_orders
+    description: |
+      A row per order, where an order consists of:
+        - customer_id
+        - order_date
+        - status
     columns:
       - name: order_id
         description: Primary key
@@ -54,6 +59,11 @@ models:
               values: ['placed', 'shipped', 'completed', 'return_pending', 'returned']
 
   - name: stg_payments
+    description: |
+      A row per payment, where a payment consists of:
+        - order_id
+        - payment_menthod
+        - amount_aud
     columns:
       - name: payment_id
         description: Primary key