Files
CFDivePlatform/openspec/changes/swagger-api-docs-completion/specs/swagger-member-api/spec.md
T
a620906209 95bafef52d chore:新增 swagger-api-docs-completion change 規劃
proposal / design / specs / tasks 全部就緒,21 tasks 待實作

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-25 00:45:15 +08:00

34 lines
1.4 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
## ADDED Requirements
### Requirement: Member 端點 Swagger 文件
`app/Docs/MemberApiDoc.php` SHALL 文件化所有需要 Member Bearer token 的端點(bookings、reviews、helpful 投票、notifications)。
#### Scenario: Member bookings 端點文件化
- **WHEN** 開啟 Swagger UI
- **THEN** 以下端點均有文件,並標示 `security: bearerAuth`
- `POST /member/bookings`request: schedule_idresponse 201: Booking
- `GET /member/bookings`response: Booking 陣列 + 分頁 meta
- `GET /member/bookings/{id}`response: Booking 詳情)
- `DELETE /member/bookings/{id}`response 200: message
#### Scenario: Member reviews 端點文件化
- **WHEN** 開啟 Swagger UI
- **THEN** 以下端點均有文件:
- `POST /member/reviews`request: diving_offer_id、rating、comment403 資格驗證失敗;422 重複評價)
- `PUT /member/reviews/{id}`request: rating?、comment?403 非本人)
- `DELETE /member/reviews/{id}`403 非本人)
- `POST /reviews/{id}/helpful`toggleresponse: helpful_count、has_voted
#### Scenario: Member notifications 端點文件化
- **WHEN** 開啟 Swagger UI
- **THEN** 以下端點均有文件:
- `GET /notifications`response: 通知陣列 + 分頁 meta
- `GET /notifications/unread-count`response: count
- `PATCH /notifications/{id}/read`
- `PATCH /notifications/read-all`
- `DELETE /notifications/{id}`