Skip to content

Commit f7e49e1

Browse files
committed
fix: doc
1 parent 9be7611 commit f7e49e1

1 file changed

Lines changed: 16 additions & 13 deletions

File tree

README.md

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -71,21 +71,24 @@
7171
## � What's New in v2.8.0
7272

7373
### 🔧 Critical Bug Fixes
74+
7475
- **Fixed Timestamp Overflow** - Resolved negative timestamp issue (`ts: -1477412146`) by converting milliseconds to seconds for SQLite compatibility
7576
- **Memory Leak Prevention** - Fixed timer cleanup issues in task management with proper AbortController signal propagation
7677
- **UUID Consistency** - Corrected data retrieval inconsistency in task system by fixing object merging precedence
7778

7879
### 🚀 New Features
80+
7981
- **Task Management System** - Complete task orchestration with CRUD operations, retry logic, and queue execution
8082
- **Queue API** - Background task processing with real-time trace subscription and status monitoring
8183
- **Enhanced API Documentation** - Updated OpenAPI specification with comprehensive task management endpoint documentation
8284

8385
### ✅ Quality Improvements
86+
8487
- **Comprehensive Testing** - Added 15+ new integration tests covering task API operations, validation, and error handling
8588
- **Enhanced Admin API Tests** - Extended test coverage for host-frontend functionality and authorization scenarios
8689
- **117 Passing Tests** - Complete test suite coverage ensuring system reliability and performance
8790

88-
## 🏗️ Architecture Overview
91+
## 🏗️ Architecture Overview
8992

9093
```mermaid
9194
graph TB
@@ -164,7 +167,7 @@ graph TB
164167

165168
2. **Start the server:**
166169
```bash
167-
deno task start
170+
deno task cli start
168171
```
169172

170173
The server will automatically:
@@ -237,16 +240,16 @@ export JWT_TOKEN="your-admin-jwt-token"
237240

238241
#### Task Management
239242

240-
| Endpoint | Method | Description | Example |
241-
| ----------------------------- | ------ | ------------------------ | ----------------------------------------------------------------------------------------------------------------- |
242-
| `/admin-api/v2/tasks` | GET | List all tasks | `curl -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks` |
243-
| `/admin-api/v2/tasks` | POST | Create new task | See [Task Creation](#-task-creation) |
244-
| `/admin-api/v2/tasks/{id}` | GET | Get specific task | `curl -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks/task-uuid` |
245-
| `/admin-api/v2/tasks/{id}` | PUT | Update task | See [Task Updates](#-task-updates) |
246-
| `/admin-api/v2/tasks/{id}` | DELETE | Delete task | `curl -X DELETE -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks/task-uuid` |
247-
| `/admin-api/v2/tasks?name=X` | GET | Filter tasks by name | `curl -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks?name=my-task` |
248-
| `/queue/v2/enqueue` | POST | Enqueue task for execution | `curl -X POST -H "Content-Type: application/json" -d '{"taskId":"task-uuid","params":{}}' http://localhost:8000/queue/v2/enqueue` |
249-
| `/queue/v2/subscribe` | POST | Subscribe to task traces | `curl -X POST -H "Content-Type: application/json" -d '{"queueId":"queue-uuid"}' http://localhost:8000/queue/v2/subscribe` |
243+
| Endpoint | Method | Description | Example |
244+
| ---------------------------- | ------ | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
245+
| `/admin-api/v2/tasks` | GET | List all tasks | `curl -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks` |
246+
| `/admin-api/v2/tasks` | POST | Create new task | See [Task Creation](#-task-creation) |
247+
| `/admin-api/v2/tasks/{id}` | GET | Get specific task | `curl -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks/task-uuid` |
248+
| `/admin-api/v2/tasks/{id}` | PUT | Update task | See [Task Updates](#-task-updates) |
249+
| `/admin-api/v2/tasks/{id}` | DELETE | Delete task | `curl -X DELETE -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks/task-uuid` |
250+
| `/admin-api/v2/tasks?name=X` | GET | Filter tasks by name | `curl -H "Authorization: Bearer $JWT_TOKEN" http://localhost:8000/admin-api/v2/tasks?name=my-task` |
251+
| `/queue/v2/enqueue` | POST | Enqueue task for execution | `curl -X POST -H "Content-Type: application/json" -d '{"taskId":"task-uuid","params":{}}' http://localhost:8000/queue/v2/enqueue` |
252+
| `/queue/v2/subscribe` | POST | Subscribe to task traces | `curl -X POST -H "Content-Type: application/json" -d '{"queueId":"queue-uuid"}' http://localhost:8000/queue/v2/subscribe` |
250253

251254
#### Configuration Management
252255

@@ -815,7 +818,7 @@ deno test --coverage=coverage --allow-all
815818

816819
```bash
817820
# Start development server
818-
deno task start
821+
deno task cli start
819822

820823
# Format code
821824
deno task fmt

0 commit comments

Comments
 (0)