Description
The v3 interface exports ReplicationConfiguration, ReplicationRule, ReplicationSetupHelper, ReplicationMonitor, ReplicationStatus, ReplicationScanResult, and ReplicationReport. Replication implementation and tests exist under b2sdk/_internal/replication and test/unit/replication, but the Sphinx documentation has no replication guide or dedicated public API-reference section. A user can discover the feature through autocomplete but cannot discover the intended end-to-end workflow from the docs.
Steps to reproduce
from b2sdk.v3 import ReplicationConfiguration, ReplicationMonitor, ReplicationRule
Search doc/source for these classes and observe that they are not documented in a replication workflow.
Expected behavior
Users should be able to configure source and destination buckets, create and update replication rules, understand required application-key capabilities, inspect replication status, and use the monitoring/reporting helpers. The task-oriented guide should explain failure and partial-status cases and link every intentionally public replication class to API reference documentation.
Actual behavior
Replication is exposed by the SDK but is effectively undiscoverable from the published documentation. There is no supported-path example, permissions checklist, conceptual explanation, or API-reference entry in the public documentation tree.
Environment
- Python version: Any supported version
- b2sdk version:
master at f3ab7b71
- OS: Any
Description
The v3 interface exports
ReplicationConfiguration,ReplicationRule,ReplicationSetupHelper,ReplicationMonitor,ReplicationStatus,ReplicationScanResult, andReplicationReport. Replication implementation and tests exist underb2sdk/_internal/replicationandtest/unit/replication, but the Sphinx documentation has no replication guide or dedicated public API-reference section. A user can discover the feature through autocomplete but cannot discover the intended end-to-end workflow from the docs.Steps to reproduce
Search
doc/sourcefor these classes and observe that they are not documented in a replication workflow.Expected behavior
Users should be able to configure source and destination buckets, create and update replication rules, understand required application-key capabilities, inspect replication status, and use the monitoring/reporting helpers. The task-oriented guide should explain failure and partial-status cases and link every intentionally public replication class to API reference documentation.
Actual behavior
Replication is exposed by the SDK but is effectively undiscoverable from the published documentation. There is no supported-path example, permissions checklist, conceptual explanation, or API-reference entry in the public documentation tree.
Environment
masteratf3ab7b71