docs: document the SDK's upstream/downstream assumptions

freedomofpress · Sep 9, 2024 · 5d44ae0 · 5d44ae0
1 parent 1650dbd
commit 5d44ae0
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/client/securedrop_client/sdk/README.md b/client/securedrop_client/sdk/README.md
@@ -0,0 +1,10 @@
+# SecureDrop SDK
+
+This SDK provides a Pythonic interface to the [SecureDrop Journalist Interface
+API](https://developers.securedrop.org/en/latest/journalist_api.html).
+
+* It SHOULD provide types and methods for all resources and endpoints provided
+  by the v1 API downstream.  (It MAY assume no breaking downstream changes.)
+
+* It MAY make breaking changes upstream to the SecureDrop Client, as its only
+  consumer.