006 plan ready
This commit is contained in:
56
specs/006-configurable-belief-logs/contracts/api.md
Normal file
56
specs/006-configurable-belief-logs/contracts/api.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# API Contract: Settings Update
|
||||
|
||||
## PATCH /api/settings/global
|
||||
|
||||
Updates the global application settings, including the new logging configuration.
|
||||
|
||||
### Request Body
|
||||
|
||||
**Content-Type**: `application/json`
|
||||
|
||||
```json
|
||||
{
|
||||
"backup_path": "string",
|
||||
"default_environment_id": "string (optional)",
|
||||
"logging": {
|
||||
"level": "string (DEBUG, INFO, WARNING, ERROR, CRITICAL)",
|
||||
"file_path": "string (optional)",
|
||||
"max_bytes": "integer (default: 10485760)",
|
||||
"backup_count": "integer (default: 5)",
|
||||
"enable_belief_state": "boolean (default: true)"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Response
|
||||
|
||||
**Status**: `200 OK`
|
||||
**Content-Type**: `application/json`
|
||||
|
||||
```json
|
||||
{
|
||||
"backup_path": "string",
|
||||
"default_environment_id": "string (optional)",
|
||||
"logging": {
|
||||
"level": "string",
|
||||
"file_path": "string",
|
||||
"max_bytes": "integer",
|
||||
"backup_count": "integer",
|
||||
"enable_belief_state": "boolean"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
**Request**
|
||||
|
||||
```json
|
||||
{
|
||||
"backup_path": "backups",
|
||||
"logging": {
|
||||
"level": "DEBUG",
|
||||
"file_path": "logs/app.log",
|
||||
"enable_belief_state": true
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user