a620906209
0cd1047b10
Run Tests / test (pull_request) Successful in 30s
repo 內 35/38 份既有 spec 都是舊版歸檔流程留下的原始 delta 內容（`## ADDED Requirements`，缺標題與 Purpose），openspec CLI 現版本嚴格驗證 （--strict）會報錯或警告。逐一補上： - 缺標題/Purpose 的 30 份：加上 `# <name> Specification` 標題 + 依內容 撰寫的 Purpose 段落，`## ADDED Requirements` 改回 `## Requirements` - compose-cloud-baseline、scheduler-container：已有標題與 Requirements，只補 Purpose 包裝 - provider-verification：已有標題與 Purpose，只需把 `## ADDED Requirements` 改回 `## Requirements` - admin-user-management、notification-email：各有一條 requirement 缺 SHALL/MUST 關鍵字（純敘述句或表格），補上規範用語，內容不變 `openspec validate --specs --strict`：38/38 全過（原本 4/38）。純文件 補齊，未變更任何 requirement 的實質內容或行為描述。 Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011LpcY9b7y9x4fusHBTXciQ
50 lines
1.9 KiB
Markdown
50 lines
1.9 KiB
Markdown
# swagger-provider-api Specification
|
||
|
||
## Purpose
|
||
|
||
定義 Provider 端點的 Swagger API 文件涵蓋範圍，包含課程 CRUD、圖片管理、開課時段與預約處理端點。
|
||
|
||
## Requirements
|
||
|
||
### Requirement: Provider 端點 Swagger 文件
|
||
|
||
`app/Docs/ProviderApiDoc.php` SHALL 文件化所有需要 Provider Bearer token 的端點（offers CRUD、圖片、schedules、bookings）。
|
||
|
||
#### Scenario: Provider offers CRUD 端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件，標示 `security: bearerAuth`：
|
||
- `GET /provider/offers`（分頁 response）
|
||
- `POST /provider/offers`（request: title、location、spot?、price、region、tag?、badges?、description?）
|
||
- `GET /provider/offers/{id}`（403 非本人）
|
||
- `PUT /provider/offers/{id}`（request 同上，所有欄位 nullable）
|
||
- `DELETE /provider/offers/{id}`
|
||
|
||
#### Scenario: Provider 圖片管理端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件：
|
||
- `POST /provider/offers/{id}/cover`（multipart/form-data: image；response: cover_image_url）
|
||
- `DELETE /provider/offers/{id}/cover`
|
||
- `POST /provider/offers/{id}/images`（multipart/form-data: images[]；最多 10 張）
|
||
- `DELETE /provider/images/{id}`
|
||
|
||
#### Scenario: Provider schedules 端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件：
|
||
- `GET /provider/schedules`（query: offer_id?；response: CourseSchedule 陣列）
|
||
- `POST /provider/schedules`（request: diving_offer_id、date、period、capacity）
|
||
- `PUT /provider/schedules/{id}`
|
||
- `DELETE /provider/schedules/{id}`
|
||
|
||
#### Scenario: Provider bookings 端點文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 以下端點均有文件：
|
||
- `GET /provider/bookings`（response: Booking 陣列，含 member 資訊）
|
||
- `PUT /provider/bookings/{id}/confirm`
|
||
- `PUT /provider/bookings/{id}/reject`
|
||
- `PUT /provider/bookings/{id}/complete`
|
||
- `PUT /provider/bookings/{id}/cancel`
|