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
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
# swagger-public-api Specification
|
||
|
||
## Purpose
|
||
|
||
定義無需認證的公開端點與全域共用 Schema 的 Swagger API 文件涵蓋範圍，包含課程列表、詳情、評價與時段查詢。
|
||
|
||
## Requirements
|
||
|
||
### Requirement: 公開端點 Swagger 文件及共用 Schema
|
||
|
||
`app/Docs/PublicApiDoc.php` SHALL 文件化所有無需認證的公開端點，並定義全域共用 Schema。
|
||
|
||
#### Scenario: 共用 Schema 定義完整
|
||
|
||
- **WHEN** 執行 `php artisan l5-swagger:generate`
|
||
- **THEN** 以下 Schema 出現在產生的 JSON：`DivingOffer`、`Review`、`CourseSchedule`、`PaginationMeta`、`ApiErrorResponse`
|
||
|
||
#### Scenario: GET /api/diving-offers 文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** `GET /diving-offers` 端點顯示 query parameters（`q`、`region`、`tag`、`per_page`、`page`）及包含分頁 meta 的 response schema
|
||
|
||
#### Scenario: GET /api/diving-offers/{id} 文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** `GET /diving-offers/{id}` 端點顯示 path parameter `id` 及包含 `cover_image_url`、`images` 陣列的 response schema；404 response 亦有定義
|
||
|
||
#### Scenario: GET /api/diving-offers/{id}/reviews 文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 端點顯示 `sort`（helpful/rating/newest）、`page`、`per_page` 參數；response 包含 `summary`（average、total、distribution）與分頁 `meta`
|
||
|
||
#### Scenario: GET /api/diving-offers/{id}/schedules 文件化
|
||
|
||
- **WHEN** 開啟 Swagger UI
|
||
- **THEN** 端點顯示 response 包含 `CourseSchedule` 陣列（id、date、period、capacity、booked_count、status）
|