Trim down design.md more
This commit is contained in:
22
design.md
22
design.md
@@ -235,17 +235,7 @@ This design enables the async handler pattern where connections can be safely mo
|
|||||||
|
|
||||||
### API Endpoints
|
### API Endpoints
|
||||||
|
|
||||||
The system implements a RESTful API:
|
The system implements a RESTful API. See [api.md](api.md) for comprehensive API documentation including request/response formats, examples, and error codes.
|
||||||
|
|
||||||
- **GET /v1/version** - Retrieve current committed version and leader
|
|
||||||
- **POST /v1/commit** - Submit transactional operations
|
|
||||||
- **GET /v1/subscribe** - Stream committed transactions
|
|
||||||
- **GET /v1/status** - Check commit status by request_id
|
|
||||||
- **PUT /v1/retention/<policy_id>** - Creates or updates a retention policy
|
|
||||||
- **GET /v1/retention/<policy_id>** - Retrieves a retention policy by ID
|
|
||||||
- **GET /v1/retention/** - Retrieves all retention policies
|
|
||||||
- **DELETE /v1/retention/<policy_id>** - Removes a retention policy
|
|
||||||
- **GET /metrics** - Retrieves server metrics for monitoring
|
|
||||||
|
|
||||||
### Design Principles
|
### Design Principles
|
||||||
|
|
||||||
@@ -257,14 +247,6 @@ The system implements a RESTful API:
|
|||||||
6. **Type safety** - Compile-time validation where possible
|
6. **Type safety** - Compile-time validation where possible
|
||||||
7. **Resource management** - RAII and move semantics throughout
|
7. **Resource management** - RAII and move semantics throughout
|
||||||
|
|
||||||
### Future Integration Points
|
|
||||||
|
|
||||||
This write-side component is designed to integrate with:
|
|
||||||
- **Leader election** systems for distributed consensus
|
|
||||||
- **Replication** mechanisms for fault tolerance
|
|
||||||
- **Read-side systems** that consume the transaction stream
|
|
||||||
- **Monitoring** systems for operational visibility
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Development Guidelines
|
## Development Guidelines
|
||||||
@@ -531,4 +513,4 @@ ParseResult parse_commit_request(const char* json, CommitRequest& out);
|
|||||||
|
|
||||||
### Build Notes
|
### Build Notes
|
||||||
|
|
||||||
See [style.md](style.md) for comprehensive build configuration and CMake integration details.
|
See [style.md](style.md) for comprehensive build configuration and CMake integration details.
|
||||||
|
|||||||
Reference in New Issue
Block a user