diff options
| author | xengineering <me@xengineering.eu> | 2026-05-24 11:41:14 +0200 |
|---|---|---|
| committer | xengineering <me@xengineering.eu> | 2026-05-24 11:41:14 +0200 |
| commit | fc6315be199305d21e4fb1b1a18917bec4147f3e (patch) | |
| tree | f4fe401d56e1ddbd671f7e52f5bef6758b9b86d4 /README.md | |
| parent | 1d0f96aaacd7d8853a1aa970b01560c92c4da86b (diff) | |
| download | finserv-fc6315be199305d21e4fb1b1a18917bec4147f3e.tar finserv-fc6315be199305d21e4fb1b1a18917bec4147f3e.tar.zst finserv-fc6315be199305d21e4fb1b1a18917bec4147f3e.zip | |
README.md: Add public API declaration
This is required to properly use Semantic Versioning.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 11 |
1 files changed, 11 insertions, 0 deletions
@@ -37,5 +37,16 @@ URL to access it is printed to the console. ./build/finserv-linux-amd64 ``` +## Public API declaration + +The following elements are declared as the public API of this project as +required by Semantic Versioning [3]: + +- command line arguments of the server executable +- HTTP API under the `/api` URL + +Everything else is not part of the public API. + [1]: https://git-scm.com/ [2]: https://mesonbuild.com/ +[3]: https://semver.org/spec/v2.0.0.html |