diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7002839 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# v1.0.7 + +- Started this changelog diff --git a/Makefile b/Makefile index 13e5f01..a0524e3 100644 --- a/Makefile +++ b/Makefile @@ -3,8 +3,8 @@ all: protocol.html diagrams -protocol.html: protocol.md style.css pandoc_template.html - cat protocol.md | pandoc \ +protocol.html: protocol.md style.css pandoc_template.html CHANGELOG.md + ( cat protocol.md | sed -e s/VERSIONTAG/$$(changer current-version)/ ; echo '# Changes' ; echo ''; cat CHANGELOG.md | sed -e s/#/##/g ) | pandoc \ -s -c style.css \ --metadata title="SimpleFIN Protocol" \ --toc --toc-depth=2 \ diff --git a/changes/README.md b/changes/README.md new file mode 100644 index 0000000..dfb5be8 --- /dev/null +++ b/changes/README.md @@ -0,0 +1,36 @@ +`changer` makes it easy to manage a `CHANGELOG.md` file. It works in Nim projects and other languages, too. + +# Installation + +``` +nimble install changer +``` + +# Configuration + +You can configure how `changer` behaves by editing the `changes/config.toml` file. + +# Usage + +Start a changelog in a project by running: + + changer init + +Every time you want to add something to the changelog, make a new Markdown file in `./changes/` named like this: + + - `fix-NAME.md` + - `new-NAME.md` + - `break-NAME.md` + - `other-NAME.md` + +Use the tool to add a changelog entry: + + changer add + +When you're ready to release a new version, preview the new changelog with: + + changer bump -n + +Then make the new changelog (and update the version of any `.nimble` file): + + changer bump diff --git a/changes/config.toml b/changes/config.toml new file mode 100644 index 0000000..3f940ca --- /dev/null +++ b/changes/config.toml @@ -0,0 +1,30 @@ +update_nimble = true +update_package_json = true + +# Replacements are string substitutions using +# https://nitely.github.io/nim-regex/regex.html#replace%2Cstring%2CRegex%2Cstring%2Cint +# They run on each snippet in the order defined, before the snippet is +# added to the CHANGELOG.md file. +# +# For example, uncomment the following lines to replace issue numbers with +# links to your GitHub project. + +# [[replacement]] +# pattern = '#(\d+)' +# replace = "[#$1](https://github.com/YOURNAME/YOURPROJECT/issues/$1)" + + +# Duplications are directories that you want to duplicate +# changelog entries to. +# +# For example, uncomment the following and then any time +# you add a change with `changer add`, it will create a +# change snippet in these directories: +# ./changes +# ./changes/../../componentB/changes +# ./changes/../../componentC/changes + +# [[duplicate]] +# dst = '../../componentB/changes' +# [[duplicate]] +# dst = '../../componentC/changes' diff --git a/changes/new-Added-GET-accountsaccount-20241016-221658.md b/changes/new-Added-GET-accountsaccount-20241016-221658.md new file mode 100644 index 0000000..4efd2c5 --- /dev/null +++ b/changes/new-Added-GET-accountsaccount-20241016-221658.md @@ -0,0 +1 @@ +Added `GET /accounts?account=` parameter for filtering which accounts are returned. diff --git a/changes/new-Added-GET-accountsbalances-only1-20241016-221726.md b/changes/new-Added-GET-accountsbalances-only1-20241016-221726.md new file mode 100644 index 0000000..62dd10f --- /dev/null +++ b/changes/new-Added-GET-accountsbalances-only1-20241016-221726.md @@ -0,0 +1 @@ +Added `GET /accounts?balances-only=1` parameter to skip fetching account transaction data. diff --git a/protocol.md b/protocol.md index 969d590..d9b51e0 100644 --- a/protocol.md +++ b/protocol.md @@ -1,8 +1,7 @@ SimpleFIN Protocol -- Version: 1.0-draft.7 -- Last modified: 05 Jun 2024 +- Version: VERSIONTAG # Introduction @@ -632,6 +631,8 @@ Retrieve account and transaction data. | start-date | optional | If given, transactions will be restricted to those on or after this Unix epoch timestamp. | | end-date | optional | If given, transactions will be restricted to those before (**but not on**) this Unix epoch timestamp. | | pending | optional | If `pending=1` is provided, pending transactions will be included (if supported). By default, pending transaction are **NOT** included. | +| account | optional | If given, only return information related to the given account id. May be specified multiple times. | +| balances-only | optional | If `balances-only=1` is provided, no transaction data is returned. | ### Authentication