summaryrefslogtreecommitdiff
path: root/requirements/data_models/dml-pipe.md
diff options
context:
space:
mode:
authorJoe Carstairs <me@joeac.net>2025-07-15 22:23:18 +0100
committerJoe Carstairs <me@joeac.net>2025-07-15 22:23:18 +0100
commitd8945831d2cebeec98691a39ec19dac13cf0d66f (patch)
treeab0f9179598bbdaac9170848aeddb0ec0934d205 /requirements/data_models/dml-pipe.md
parent4b4621a18ff301708f98c8a6d89cb78e184ac795 (diff)
parent376e5623ef0a202c391908a7a3093df4d804a052 (diff)
Merge branch 'main' of https://git.joeac.net/joeac/schist
Diffstat (limited to 'requirements/data_models/dml-pipe.md')
-rw-r--r--requirements/data_models/dml-pipe.md21
1 files changed, 15 insertions, 6 deletions
diff --git a/requirements/data_models/dml-pipe.md b/requirements/data_models/dml-pipe.md
index a7d2e8a..d889b0a 100644
--- a/requirements/data_models/dml-pipe.md
+++ b/requirements/data_models/dml-pipe.md
@@ -3,10 +3,19 @@
A pipe represents how much money the user wants to come in or go out of a
bucket. In other words, it represents a flow of money from the tank to a bucket.
-| Field | Type | Description |
-| ------ | ------ | -------------------------------------------------------- |
-| id | string | |
-| amount | number | The amount of money flowing through the pipe. |
-| period | string | How long it takes for `amount` to flow through the pipe. |
+| Field | Type | Description |
+| --------- | ------ | -------------------------------------------------------- |
+| id | string | |
+| amount | number | The amount of money flowing through the pipe. |
+| period | string | How long it takes for `amount` to flow through the pipe. |
+| bucket_id | string | The ID of the bucket to which this pipe corresponds. |
-Source: req-017
+Constraints:
+
+- `period` must be one of these options:
+ - `day`
+ - `week`
+ - `month`
+ - `year`
+
+Sources: req-017, req-037