Update README with message endpoints documentation

This commit is contained in:
Automated Action 2025-06-05 07:49:58 +00:00
parent 27380260b4
commit e9a6c04a9b

View File

@ -75,6 +75,27 @@ Apply migrations:
alembic upgrade head 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 ## Environment Variables
None required for basic setup, as SQLite database path is configured internally. None required for basic setup, as SQLite database path is configured internally.