Update README with message endpoints documentation
This commit is contained in:
parent
27380260b4
commit
e9a6c04a9b
21
README.md
21
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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user