B2 SDK docs: add Event Notifications usage and API documentation
維護者通常 1 天內回覆
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 45/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 冷清
- 技術堆疊
- python
研究方向
Start in doc/source/index.rst, where the Event Notifications preview is only announced, and check how the existing API docs are organised. Read the b2sdk.v3 exports NotificationRule, NotificationRuleResponse and EVENT_TYPE, then the notification operations in the API and bucket layers. Done means a guide with a minimal create/list/update/delete example, the event types and rule fields, preview and permission notes, and links to the API references.
由索引模型根據 Issue 內容生成。
描述
Description
doc/source/index.rst only announces that Event Notifications are in Private Preview. Meanwhile, b2sdk.v3 exports NotificationRule, NotificationRuleResponse, EVENT_TYPE, and conversion helpers, and the API and bucket layers expose notification operations. There is no SDK guide explaining how preview access affects availability, which operations are supported, what a rule contains, or how response objects should be interpreted.
Steps to reproduce
from b2sdk.v3 import NotificationRule, NotificationRuleResponse
Search doc/source for an Event Notifications guide or API page.
Expected behavior
The feature should have documentation appropriate to its release status. It should state the preview-access requirement and stability expectations, document the required permissions, show a minimal create/list/update/delete workflow, explain event types and rule fields, cover common errors, and link the intended public types and methods to API references.
Actual behavior
Users see a preview announcement and an external blog link but cannot learn how the Python SDK exposes the feature. This makes exported functionality look unsupported or forces users to infer usage from implementation code and tests.
Environment
- Python version: Any supported version
- b2sdk version:
masteratf3ab7b71 - OS: Any
- 主要語言
- Python
- 星號
- 214
- 分支
- 68
- 平均合併
- 51 分鐘
- 30 天內合併 PR
- 6
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
Backblaze/b2-sdk-python 的其他 Issue
-
Download and copy sync actions print remote file names without escape_control_chars可能已有人在做 @dreyfus92 於 15 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 72/100
Backblaze/b2-sdk-python#631 ·
維護者通常 1 天內回覆
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checked可能已有人在做 @nazarli-shabnam 於 9 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 75/100
Backblaze/b2-sdk-python#629 ·
維護者通常 1 天內回覆
-
Adopt the AI-native SDLC and repository policies可能已有人在做 @goanpeca 於 18 天前認領。 未關閉enhancement
難度 5/5 一週以上 新手友好度 20/100
Backblaze/b2-sdk-python#634 ·
維護者通常 1 天內回覆
-
難度 4/5 3-5 天 新手友好度 50/100
Backblaze/b2-sdk-python#630 ·
維護者通常 1 天內回覆
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)可能重新可做 @ffumero2003 於 37 天前認領，目前沒有進行中的 PR。 未關閉bug testing
Backblaze/b2-sdk-python#627 · 2 則留言 · 已指派 1 人 ·
維護者通常 1 天內回覆
查看 Backblaze/b2-sdk-python 的全部 Issue
相似的 Issue
-
難度 1/5 1 小時以內 新手友好度 72/100
btclib-org/btclib-node#2505 · 1 則留言 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 78/100
open-webui/open-webui#34462 · 1 則留言 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
gorakhargosh/watchdog#1462 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 85/100
openwisp/openwisp-monitoring#889 ·
維護者通常 2 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
IETF-Hackathon/pqc-certificates#351 ·
維護者通常 2 天內回覆