From 5d44ae016922b18513d9650930572f430e7c75c9 Mon Sep 17 00:00:00 2001 From: Cory Francis Myers Date: Mon, 9 Sep 2024 15:56:14 -0700 Subject: [PATCH 1/2] docs: document the SDK's upstream/downstream assumptions --- client/securedrop_client/sdk/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 client/securedrop_client/sdk/README.md diff --git a/client/securedrop_client/sdk/README.md b/client/securedrop_client/sdk/README.md new file mode 100644 index 000000000..f366a21d9 --- /dev/null +++ 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. \ No newline at end of file From 28c4f51c2f5a42a2bfdaed3b3a264ae89765d4f0 Mon Sep 17 00:00:00 2001 From: Cory Francis Myers Date: Tue, 10 Sep 2024 14:28:59 -0700 Subject: [PATCH 2/2] docs: don't rule out downstream breaking changes Co-authored-by: Kunal Mehta --- client/securedrop_client/sdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/client/securedrop_client/sdk/README.md b/client/securedrop_client/sdk/README.md index f366a21d9..a14c57bde 100644 --- a/client/securedrop_client/sdk/README.md +++ b/client/securedrop_client/sdk/README.md @@ -4,7 +4,7 @@ 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.) + by the v1 API downstream. (Any downstream breaking changes MUST be coordinated.) * It MAY make breaking changes upstream to the SecureDrop Client, as its only consumer. \ No newline at end of file