Files
CFDivePlatform/openspec/specs/swagger-member-api/spec.md
T
a620906209 0cd1047b10
Run Tests / test (pull_request) Successful in 30s
docs(openspec): 補齊所有 spec 缺少的 Purpose section 與規格標頭
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
2026-08-03 04:11:06 +08:00

1.6 KiB
Raw Blame History

swagger-member-api Specification

Purpose

定義 Member 端點的 Swagger API 文件涵蓋範圍,包含預約、評價、投票與站內通知端點。

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/bookingsrequest: schedule_idresponse 201: Booking
    • GET /member/bookingsresponse: Booking 陣列 + 分頁 meta
    • GET /member/bookings/{id}response: Booking 詳情)
    • DELETE /member/bookings/{id}response 200: message

Scenario: Member reviews 端點文件化

  • WHEN 開啟 Swagger UI
  • THEN 以下端點均有文件:
    • POST /member/reviewsrequest: diving_offer_id、rating、comment403 資格驗證失敗;422 重複評價)
    • PUT /member/reviews/{id}request: rating?、comment?403 非本人)
    • DELETE /member/reviews/{id}403 非本人)
    • POST /reviews/{id}/helpfultoggleresponse: helpful_count、has_voted

Scenario: Member notifications 端點文件化

  • WHEN 開啟 Swagger UI
  • THEN 以下端點均有文件:
    • GET /notificationsresponse: 通知陣列 + 分頁 meta
    • GET /notifications/unread-countresponse: count
    • PATCH /notifications/{id}/read
    • PATCH /notifications/read-all
    • DELETE /notifications/{id}