diff options
| author | Joe Carstairs <jcarstairs@scottlogic.com> | 2025-07-16 16:29:57 +0100 |
|---|---|---|
| committer | Joe Carstairs <jcarstairs@scottlogic.com> | 2025-07-16 16:29:57 +0100 |
| commit | 588c74956010ab9ab68efd53974f36840b17325b (patch) | |
| tree | 1da556d88e7813be91918eb1cd7efad3242aab72 | |
| parent | 15396ad47e734c01d974f9b5de64b3fbdab2b7ea (diff) | |
edit req-017, dml-bucket
| -rw-r--r-- | requirements/catalogue/req-017.md | 7 | ||||
| -rw-r--r-- | requirements/data_models/dml-bucket.md | 12 |
2 files changed, 11 insertions, 8 deletions
diff --git a/requirements/catalogue/req-017.md b/requirements/catalogue/req-017.md index a9c771f..1bbdf4b 100644 --- a/requirements/catalogue/req-017.md +++ b/requirements/catalogue/req-017.md @@ -5,10 +5,13 @@ As a user, I want: - Buckets to represent real categories of spending, like beer and holidays; - Pipes to represent how much I want to come in and out of each bucket; - Each real transaction I make to be associated with at most one bucket; -- Buckets to have a balance, which is the difference between the amount of money - which has flowed in from a pipe less the amount taken out by my transactions; +- Buckets to have a balance, which represents the amount of money I intend to + be free to spend in the real category of spending which that bucket + represents; so that I can have buckets and pipes which express how I want to distribute, and have previously distributed, my incomings and outgoings. Source: req-002 + +Satisfied by: dml-bucket, dml-pipe, dml-transaction diff --git a/requirements/data_models/dml-bucket.md b/requirements/data_models/dml-bucket.md index 3e33028..f8fd1da 100644 --- a/requirements/data_models/dml-bucket.md +++ b/requirements/data_models/dml-bucket.md @@ -2,11 +2,11 @@ A bucket represents a real category of spending, like beer or holidays. -| Field | Type | Description | -| ----------------- | ------ | ----------------------------------------------------- | -| name | string | A short description of the real category of spending. | -| balance | number | The amount of money currently in the bucket. | -| balance_cache_key | string | A cache key for the balance. See notes. | +| Field | Type | Description | +| ----------------- | ------ | --------------------------------------------------------- | +| name | string | A short description of the real category of spending. | +| balance | number | The amount of money the user intends to be free to spend. | +| balance_cache_key | string | A cache key for the balance. See notes. | Constraints: @@ -14,6 +14,6 @@ Constraints: Notes: -- `balance_cache_key` must be of the format: `<drip_id>:<transaction_id>`. +- `balance_cache_key` must be of the format: `<drip_id>:<transaction_id>`. Sources: req-027, req-028, req-030 |