Skip to content

Commit 10356cb

Browse files
authored
docs: start public API documentation (#429)
1 parent 976ce92 commit 10356cb

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,3 +89,13 @@ Please check the [releases page](https://github.com/envelope-zero/backend/releas
8989
## Contributing
9090

9191
Please see [the contribution guidelines](CONTRIBUTING.md).
92+
93+
## Versioning
94+
95+
This project is versioned using [Semantic Versioning 2.0.0](https://semver.org/spec/v2.0.0.html).
96+
97+
The public API is defined as:
98+
99+
- The API endpoints, meaning the routes, parameters, HTTP respone codes and response body format (for a function, we'd just say “the function signature“)
100+
- The behavior of the API endpoints no matter the signature of the endpoint is
101+
- Planned: ~~Public functions and methods of the code - this enables anybody wrapping the backend (e.g. the standalone version) to rely on the version numbers.~~ This will be added to the definition once all methods and functions intended to be private are private. Track [#423](https://github.com/envelope-zero/backend/issues/423) if you're interested in this.

0 commit comments

Comments
 (0)