Skip to content

Commit 796fc30

Browse files
authored
docs: finish public API definition (#567)
The backend is built with the goal of providing an HTTP API. This means that the go module itself does not need to be part of the public API to guarantee stable versioning for users. If other projects do start relying on it as a go module and deem a more stable approach necessary, their maintainers are welcome to open an issue to discuss adding the exported functions and methods to the public API definition for this. For now however, it will not be part of the public API.
1 parent 14646aa commit 796fc30

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,9 @@ This project is versioned using [Semantic Versioning 2.0.0](https://semver.org/s
9797

9898
The public API is defined as:
9999

100-
- 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 API endpoints, meaning the routes, parameters, HTTP respone codes and response body format (for a function, we'd just say “the function signature“) that the HTTP server built from the code in this repository provides
101101
- The behavior of the API endpoints no matter the signature of the endpoint is
102-
- 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.
102+
103+
Not part of the public API is:
104+
105+
- The go module itself, meaning that exported function signatures or behaviors can change at any point in time

0 commit comments

Comments
 (0)