B2 SDK docs: add Event Notifications usage and API documentation

Đang mở
  • Có gì không ổn?
#596 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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: master at f3ab7b71
  • OS: Any
Ngôn ngữ chính
Python
Star
214
Fork
68
Merge trung bình
51 phút
Pull request đã merge (30 ngày)
6

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Backblaze/b2-sdk-python

Tất cả issue của Backblaze/b2-sdk-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.