Files
CFDivePlatform/openspec/specs/swagger-auth-supplement/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.1 KiB
Raw Blame History

swagger-auth-supplement Specification

Purpose

定義補全 Auth 相關端點的 Swagger 文件涵蓋範圍,包含 Google OAuth 與三角色的密碼變更端點。

Requirements

Requirement: Auth 補全端點 Swagger 文件

app/Docs/AuthSupplementDoc.php SHALL 補全未文件化的 Auth 相關端點(Google OAuth、change-password)。

Scenario: Google OAuth 端點文件化

  • WHEN 開啟 Swagger UI
  • THEN 以下端點均有文件:
    • GET /auth/google/redirectresponse: redirect_url,說明用途為取得 Google OAuth redirect URL
    • GET /auth/google/callbackresponse: token + user,說明此為 OAuth callback,通常由瀏覽器自動呼叫)

Scenario: change-password 端點文件化(三個 role

  • WHEN 開啟 Swagger UI
  • THEN 以下端點均有文件,各自標示對應 role 的 security: bearerAuth
    • PUT /member/change-passwordrequest: current_password、password、password_confirmation
    • PUT /provider/change-password(同上)
    • PUT /admin/change-password(同上)
    • 422 驗證失敗 response 亦有定義