docs: 規劃 bear apps 管理指令群介面規格(issue #5) #7

Merged
chenyunda218 merged 1 commits from docs/apps-management-spec into main 2026-09-07 22:50:24 +08:00
Member

對應 #5(拆自 #4)。伺服器端 API 依賴 alterminal/bear#28。

內容

  • 3.6 bear apps 指令群:由「P3 暫緩清單」擴充為完整規格,六個子指令:
    • apps list [--visibility] [--status] [--page] [--per-page] [--json]
    • apps show <client-id>
    • apps create(client_id、url、title、method、visibility、redirect URLs、post-logout URIs、scopes、sub、jwk-id;PKCE 需綁 --jwk-id)
    • apps update <client-id>(部分更新;清單欄位整組覆寫;client_id 不可變)
    • apps rotate-secret <client-id>(一次性顯示新 secret)
    • apps toggle <client-id>(active ↔ inactive)
  • 認證:一律 PAT Bearer(bear login --token/BEAR_TOKEN);401 → 退出碼 3;403 非 admin → 新增退出碼 8(提示需 admin 權限、不重試)。
  • Secret 處理:client_secret 只在 create/rotate-secret 成功當下一次性顯示;其餘指令回應永不含 secret。
  • 第 4 節退出碼總表補 8;第 7 節開放問題改寫(公開清單是否開放非 admin)並新增 UUID vs client_id 識別問題;第 8 節對應關係列出全部六個端點並註明依賴 bear#28。
  • README 指令總覽與 P3 里程碑同步更新。

驗收對照

  • 規格文件更新並開 PR(審核者 chenyunda218)
  • 指令、選項、行為、輸出、退出碼、錯誤處理皆有定義
  • 註明依賴 alterminal/bear#28 的 API 端點
對應 #5(拆自 #4)。伺服器端 API 依賴 alterminal/bear#28。 ## 內容 - **3.6 `bear apps` 指令群**:由「P3 暫緩清單」擴充為完整規格,六個子指令: - `apps list [--visibility] [--status] [--page] [--per-page] [--json]` - `apps show <client-id>` - `apps create`(client_id、url、title、method、visibility、redirect URLs、post-logout URIs、scopes、sub、jwk-id;PKCE 需綁 --jwk-id) - `apps update <client-id>`(部分更新;清單欄位整組覆寫;client_id 不可變) - `apps rotate-secret <client-id>`(一次性顯示新 secret) - `apps toggle <client-id>`(active ↔ inactive) - **認證**:一律 PAT Bearer(`bear login --token`/`BEAR_TOKEN`);401 → 退出碼 `3`;403 非 admin → **新增退出碼 `8`**(提示需 admin 權限、不重試)。 - **Secret 處理**:`client_secret` 只在 create/rotate-secret 成功當下一次性顯示;其餘指令回應永不含 secret。 - **第 4 節**退出碼總表補 `8`;**第 7 節**開放問題改寫(公開清單是否開放非 admin)並新增 UUID vs client_id 識別問題;**第 8 節**對應關係列出全部六個端點並註明依賴 bear#28。 - **README** 指令總覽與 P3 里程碑同步更新。 ## 驗收對照 - [x] 規格文件更新並開 PR(審核者 chenyunda218) - [x] 指令、選項、行為、輸出、退出碼、錯誤處理皆有定義 - [x] 註明依賴 alterminal/bear#28 的 API 端點
chenyunda218 was assigned by ceo 2026-09-07 22:40:45 +08:00
ceo added 1 commit 2026-09-07 22:40:45 +08:00
對應 alterminal/bear-cli#5 與伺服器端 alterminal/bear#28(App 管理 JSON API):

- 3.6 由 P3 暫緩清單擴充為完整指令群規格:list/show/create/
  update/rotate-secret/toggle,含選項、行為、輸出範例、--json 格式。
- 認證一律 PAT Bearer;401 → 退出碼 3、403(非 admin)→ 新增退出碼 8。
- client_secret 僅 create/rotate-secret 一次性顯示,其餘回應永不包含。
- 第 4 節退出碼總表補 8;第 7 節開放問題改寫並新增 UUID vs client_id;
- 第 8 節對應關係列出全部 apps 端點,註明依賴 bear#28。
- README 指令總覽與 P3 里程碑同步更新。
ceo requested review from chenyunda218 2026-09-07 22:41:51 +08:00
chenyunda218 merged commit c26420303e into main 2026-09-07 22:50:24 +08:00
chenyunda218 deleted branch docs/apps-management-spec 2026-09-07 22:50:24 +08:00
Sign in to join this conversation.
No Reviewers
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: alterminal/bear-cli#7