Enrich vgi-lint metadata: docs, descriptions, examples

Author: rustyconover

crates/iso20022-worker/src/meta.rs

@@ -8,7 +8,9 @@
 //! - `vgi.keywords` (VGI126/138) — a JSON array of search terms/synonyms
 //!
 //! Per-object `vgi.source_url` is intentionally NOT emitted here: it belongs on
-//! the catalog object only (VGI139), which already points at iso20022.org.
+//! the catalog object only (VGI139), which already carries the worker's
+//! `source_url` (the project repository). The open ISO 20022 standard itself
+//! (iso20022.org) is cited in the catalog `doc_md` prose.
 
 /// Encode comma-separated keywords as the JSON array of strings that
 /// `vgi.keywords` requires (VGI138).

crates/iso20022-worker/src/table/camt053.rs

@@ -10,7 +10,8 @@ use super::common::ReadTable;
 use super::scan::finish;
 use crate::cols::*;
 
-const RESULT_MD: &str = "One row per `Stmt`: `msg_id`, `stmt_id`, `stmt_seq_nb`, `account_iban` / \
+const RESULT_MD: &str = "One row per `Stmt`: `msg_id`, `creation_dt`, `stmt_id`, `stmt_seq_nb`, \
+`account_iban` / \
 `account_other` / `account_ccy` / `account_owner`, `from_dt`/`to_dt`, signed `opening_balance` / \
 `closing_balance` / `closing_available` DECIMAL(38,9) + `ccy`, `entry_count`, `sum_credits` / \
 `sum_debits`, plus `raw` (whole document) and `path`. Pair with `camt053_entries(raw)` for the lines.";

crates/iso20022-worker/src/table/camt054.rs

@@ -27,7 +27,12 @@ pub fn table() -> ReadTable {
         doc_md: "Read camt.054 debit/credit notifications into rows (one per Ntfctn).",
         keywords: "camt.054, camt054, BkToCstmrDbtCdtNtfctn, notification, debit credit advice, \
                    iso 20022, entries, reconciliation",
-        result_columns_md: "One row per `Ntfctn`, same columns as `camt053_read`. Pair with \
-            `camt054_entries(raw)` for the individual notification lines.",
+        result_columns_md: "One row per `Ntfctn`, sharing the `camt053_read` column layout: \
+            `msg_id`, `creation_dt`, `stmt_id` (from `Ntfctn/Id`), `stmt_seq_nb`, `account_iban` / \
+            `account_other` / `account_ccy` / `account_owner`, `from_dt`/`to_dt`, signed \
+            `opening_balance` / `closing_balance` / `closing_available` DECIMAL(38,9) + `ccy` \
+            (balances are usually absent on a notification and come back NULL unless present), \
+            `entry_count`, `sum_credits` / `sum_debits`, plus `raw` (whole document) and `path`. \
+            Pair with `camt054_entries(raw)` to explode the individual notification `Ntry` lines.",
     }
 }