diff --git a/README.md b/README.md index 14aa2fb..3393ebf 100644 --- a/README.md +++ b/README.md @@ -75,6 +75,27 @@ Apply migrations: alembic upgrade head ``` +## API Endpoints + +### Messages API + +- **GET /api/v1/messages** + - Retrieves a list of all messages + - Supports pagination and filtering + +- **GET /api/v1/messages/{message_id}** + - Retrieves a specific message by ID + +- **POST /api/v1/messages** + - Creates a new message + - Requires message content and recipient information + +- **PUT /api/v1/messages/{message_id}/read** + - Marks a message as read + +- **DELETE /api/v1/messages/{message_id}** + - Deletes a specific message + ## Environment Variables None required for basic setup, as SQLite database path is configured internally.