Spaces:
Running
Running
File size: 16,746 Bytes
9eafd9f |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 |
openapi: 3.0.3
info:
title: Phase II Todo Web App - API Reference
description: |
Complete API reference for the Full-Stack Todo Web Application.
This document references existing endpoints from Specs 1 (Task CRUD) and 2 (Authentication & API Security).
**Base URL**: http://localhost:8000
**Authentication**: All task endpoints require JWT Bearer token in Authorization header.
**Note**: This is a reference document for integration purposes. No new endpoints are introduced in Spec 002.
version: 1.0.0
contact:
name: Phase II Todo Web App
servers:
- url: http://localhost:8000
description: Local development server
tags:
- name: Authentication
description: User signup, signin, and profile endpoints (Spec 2)
- name: Tasks
description: Task CRUD operations (Spec 1)
security:
- BearerAuth: []
paths:
/api/auth/signup:
post:
tags:
- Authentication
summary: Register new user account
description: Creates a new user account with email, password, and name. Password is hashed with bcrypt before storage.
operationId: signup
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SignupRequest'
example:
email: user@example.com
password: SecurePass123
name: John Doe
responses:
'201':
description: User created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/SignupResponse'
example:
id: 1
email: user@example.com
name: John Doe
created_at: "2026-01-09T10:00:00Z"
'400':
description: Validation error (invalid email, weak password)
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Password must be at least 8 characters with uppercase, lowercase, and number
error_code: VALIDATION_ERROR
'409':
description: Email already registered
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Email already registered
error_code: EMAIL_EXISTS
/api/auth/signin:
post:
tags:
- Authentication
summary: Authenticate user and issue JWT token
description: Verifies email and password, returns JWT token with 7-day expiration.
operationId: signin
security: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SigninRequest'
example:
email: user@example.com
password: SecurePass123
responses:
'200':
description: Authentication successful
content:
application/json:
schema:
$ref: '#/components/schemas/TokenResponse'
example:
access_token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
token_type: bearer
expires_in: 604800
user:
id: 1
email: user@example.com
name: John Doe
created_at: "2026-01-09T10:00:00Z"
'401':
description: Invalid credentials
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Invalid email or password
error_code: INVALID_CREDENTIALS
/api/auth/me:
get:
tags:
- Authentication
summary: Get current user profile
description: Returns profile information for the authenticated user.
operationId: getCurrentUser
responses:
'200':
description: User profile retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/UserProfile'
example:
id: 1
email: user@example.com
name: John Doe
created_at: "2026-01-09T10:00:00Z"
'401':
description: Not authenticated or invalid token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Not authenticated
error_code: TOKEN_MISSING
/api/tasks:
get:
tags:
- Tasks
summary: List user's tasks with filtering and sorting
description: Returns all tasks for the authenticated user. Supports filtering by completion status and sorting.
operationId: getTasks
parameters:
- name: completed
in: query
description: Filter by completion status (true/false/null for all)
required: false
schema:
type: boolean
nullable: true
- name: sort
in: query
description: Sort field
required: false
schema:
type: string
enum: [created_at, updated_at]
default: created_at
- name: order
in: query
description: Sort order
required: false
schema:
type: string
enum: [asc, desc]
default: desc
- name: limit
in: query
description: Maximum number of results
required: false
schema:
type: integer
minimum: 1
maximum: 100
default: 50
- name: offset
in: query
description: Number of results to skip
required: false
schema:
type: integer
minimum: 0
default: 0
responses:
'200':
description: Tasks retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/TaskListResponse'
example:
tasks:
- id: 1
user_id: 1
title: Buy groceries
description: Milk, eggs, bread
completed: false
created_at: "2026-01-09T10:00:00Z"
updated_at: "2026-01-09T10:00:00Z"
- id: 2
user_id: 1
title: Finish project
description: null
completed: true
created_at: "2026-01-08T15:30:00Z"
updated_at: "2026-01-09T09:00:00Z"
total: 2
limit: 50
offset: 0
'401':
$ref: '#/components/responses/UnauthorizedError'
post:
tags:
- Tasks
summary: Create new task
description: Creates a new task for the authenticated user.
operationId: createTask
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCreate'
example:
title: Buy groceries
description: Milk, eggs, bread
responses:
'201':
description: Task created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
example:
id: 1
user_id: 1
title: Buy groceries
description: Milk, eggs, bread
completed: false
created_at: "2026-01-09T10:00:00Z"
updated_at: "2026-01-09T10:00:00Z"
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Title is required
error_code: VALIDATION_ERROR
'401':
$ref: '#/components/responses/UnauthorizedError'
/api/tasks/{task_id}:
get:
tags:
- Tasks
summary: Get single task
description: Returns a specific task if it belongs to the authenticated user.
operationId: getTask
parameters:
- name: task_id
in: path
required: true
schema:
type: integer
responses:
'200':
description: Task retrieved successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
description: Task not found or doesn't belong to user
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Task not found
error_code: NOT_FOUND
put:
tags:
- Tasks
summary: Update task (replace all fields)
description: Replaces all task fields. All fields are required.
operationId: updateTask
parameters:
- name: task_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TaskUpdate'
example:
title: Buy groceries (updated)
description: Milk, eggs, bread, cheese
completed: false
responses:
'200':
description: Task updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
patch:
tags:
- Tasks
summary: Partially update task
description: Updates only the provided fields. Other fields remain unchanged.
operationId: patchTask
parameters:
- name: task_id
in: path
required: true
schema:
type: integer
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TaskPatch'
example:
completed: true
responses:
'200':
description: Task updated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Task'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
delete:
tags:
- Tasks
summary: Delete task
description: Permanently deletes a task if it belongs to the authenticated user.
operationId: deleteTask
parameters:
- name: task_id
in: path
required: true
schema:
type: integer
responses:
'204':
description: Task deleted successfully
'401':
$ref: '#/components/responses/UnauthorizedError'
'404':
$ref: '#/components/responses/NotFoundError'
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT token obtained from /api/auth/signin
schemas:
SignupRequest:
type: object
required:
- email
- password
- name
properties:
email:
type: string
format: email
description: Valid email address (RFC 5322)
password:
type: string
minLength: 8
maxLength: 100
description: Min 8 chars with uppercase, lowercase, and number
name:
type: string
minLength: 1
maxLength: 100
description: User's display name
SignupResponse:
type: object
properties:
id:
type: integer
email:
type: string
name:
type: string
created_at:
type: string
format: date-time
SigninRequest:
type: object
required:
- email
- password
properties:
email:
type: string
format: email
password:
type: string
TokenResponse:
type: object
properties:
access_token:
type: string
description: JWT token
token_type:
type: string
enum: [bearer]
expires_in:
type: integer
description: Token expiration in seconds (604800 = 7 days)
user:
$ref: '#/components/schemas/UserProfile'
UserProfile:
type: object
properties:
id:
type: integer
email:
type: string
name:
type: string
created_at:
type: string
format: date-time
Task:
type: object
properties:
id:
type: integer
user_id:
type: integer
title:
type: string
maxLength: 200
description:
type: string
maxLength: 1000
nullable: true
completed:
type: boolean
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
TaskCreate:
type: object
required:
- title
properties:
title:
type: string
minLength: 1
maxLength: 200
description:
type: string
maxLength: 1000
nullable: true
TaskUpdate:
type: object
required:
- title
- completed
properties:
title:
type: string
minLength: 1
maxLength: 200
description:
type: string
maxLength: 1000
nullable: true
completed:
type: boolean
TaskPatch:
type: object
properties:
title:
type: string
minLength: 1
maxLength: 200
description:
type: string
maxLength: 1000
nullable: true
completed:
type: boolean
TaskListResponse:
type: object
properties:
tasks:
type: array
items:
$ref: '#/components/schemas/Task'
total:
type: integer
limit:
type: integer
offset:
type: integer
ErrorResponse:
type: object
properties:
detail:
type: string
description: Human-readable error message
error_code:
type: string
description: Machine-readable error code
enum:
- VALIDATION_ERROR
- EMAIL_EXISTS
- INVALID_CREDENTIALS
- TOKEN_MISSING
- TOKEN_EXPIRED
- TOKEN_INVALID
- NOT_FOUND
field_errors:
type: object
additionalProperties:
type: array
items:
type: string
description: Field-specific validation errors
responses:
UnauthorizedError:
description: Not authenticated or invalid token
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Not authenticated
error_code: TOKEN_MISSING
NotFoundError:
description: Resource not found or doesn't belong to user
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
detail: Task not found
error_code: NOT_FOUND
|