weaselab/weaseldb
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add the rest of the endpoints to design.md

Browse Source
This commit is contained in:
Andrew Noyes
2025-08-19 14:03:49 -04:00
parent 30d22f7a18
commit c95aecfe8c
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
design.md
View File

@@ -185,12 +185,17 @@ This design assumes request/response pairs (HTTP-like protocols) but works for a
### API Design
The system implements a RESTful API with three core endpoints:
The system implements a RESTful API with the following core endpoints:
1. **GET /v1/version**: Retrieve current committed version and leader
2. **POST /v1/commit**: Submit transactional operations
3. **GET /v1/subscribe**: Stream committed transactions (implied)
4. **GET /v1/status**: Check commit status by request_id (implied)
3. **GET /v1/subscribe**: Stream committed transactions
4. **GET /v1/status**: Check commit status by request_id
5. **PUT /v1/retention/<policy_id>**: Creates or updates a retention policy
6. **GET /v1/retention/<policy_id>**: Retrieves a retention policy by ID
7. **GET /v1/retention/**: Retrieves all retention policies
8. **DELETE /v1/retention/<policy_id>**: Removes a retention policy
9. **GET /metrics**: Retrieves server metrics for monitoring
### Performance Characteristics