B2 SDK docs: add Event Notifications usage and API documentation
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Tranquilo
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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
- Lenguaje dominante
- Python
- Estrellas
- 214
- Forks
- 68
- Merge medio
- 51 min
- PR fusionados (30 d)
- 6
Preparar el entorno
- Sin Dockerfile ni archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Backblaze/b2-sdk-python
-
Download and copy sync actions print remote file names without escape_control_charsPosiblemente ocupada @dreyfus92 la tomó hace 15 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
Backblaze/b2-sdk-python#631 ·
Los mantenedores suelen responder en 1 día
-
SqliteAccountInfo profile name validation uses "re.match", so only the first character is checkedPosiblemente ocupada @nazarli-shabnam la tomó hace 9 días. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
Backblaze/b2-sdk-python#629 ·
Los mantenedores suelen responder en 1 día
-
Adopt the AI-native SDLC and repository policiesPosiblemente ocupada @goanpeca la tomó hace 18 días. Abiertoenhancement
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
Backblaze/b2-sdk-python#634 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 4/5 3-5 días Aptitud para principiantes 50/100
Backblaze/b2-sdk-python#630 ·
Los mantenedores suelen responder en 1 día
-
ci: cli-compat fails — 4 sse/sync integration tests broken in B2_Command_Line_Tool (all environments)Quizá libre de nuevo @ffumero2003 la tomó hace 37 días y no hay ningún pull request abierto. Abiertobug testing
Backblaze/b2-sdk-python#627 · 2 comentarios · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de Backblaze/b2-sdk-python
Issues similares
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 72/100
btclib-org/btclib-node#2505 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
open-webui/open-webui#34462 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
gorakhargosh/watchdog#1462 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 85/100
openwisp/openwisp-monitoring#889 ·
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
IETF-Hackathon/pqc-certificates#351 ·
Los mantenedores suelen responder en 2 días