From 95c34e7099a5faa02788ef5ae7e0d21a770b3f0c Mon Sep 17 00:00:00 2001 From: mattsb42-aws Date: Tue, 5 Feb 2019 12:06:14 -0800 Subject: [PATCH 1/3] add explicit public API definition --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index de86ea4e5..2c7e0e081 100644 --- a/README.md +++ b/README.md @@ -138,6 +138,13 @@ public class StringExample { You can find more examples in the [examples directory][examples]. +## Public API + +The public API that we will maintain within the constraints of our [versioning policy](./VERSIONING.rst) +consists of all public classes in the `com.amazonaws.encryptionsdk` package unless otherwise and specifically documented. + +The `com.amazonaws.encryptionsdk.internal` package is not included in this public API. + ## FAQ See the [Frequently Asked Questions](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/faq.html) page in the official documentation. From 070d2f809342ab0762a043735e9acf208b2bd63c Mon Sep 17 00:00:00 2001 From: mattsb42-aws Date: Tue, 5 Feb 2019 12:30:30 -0800 Subject: [PATCH 2/3] copyedit --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2c7e0e081..5fb3fe24f 100644 --- a/README.md +++ b/README.md @@ -140,8 +140,8 @@ You can find more examples in the [examples directory][examples]. ## Public API -The public API that we will maintain within the constraints of our [versioning policy](./VERSIONING.rst) -consists of all public classes in the `com.amazonaws.encryptionsdk` package unless otherwise and specifically documented. +The public API that we maintain includes all public classes in the in the `com.amazonaws.encryptionsdk` +package unless otherwise documented. Our [versioning policy](./VERSIONING.rst) applies to this public API. The `com.amazonaws.encryptionsdk.internal` package is not included in this public API. From 114f8feaa7018ca0648fb0e6bd6099de2e3cdc01 Mon Sep 17 00:00:00 2001 From: mattsb42-aws Date: Tue, 8 Oct 2019 17:10:48 -0700 Subject: [PATCH 3/3] tweak public API definition --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5fb3fe24f..84300ec0f 100644 --- a/README.md +++ b/README.md @@ -140,8 +140,8 @@ You can find more examples in the [examples directory][examples]. ## Public API -The public API that we maintain includes all public classes in the in the `com.amazonaws.encryptionsdk` -package unless otherwise documented. Our [versioning policy](./VERSIONING.rst) applies to this public API. +Our [versioning policy](./VERSIONING.rst) applies to all public and protected classes/methods/fields +in the `com.amazonaws.encryptionsdk` package unless otherwise documented. The `com.amazonaws.encryptionsdk.internal` package is not included in this public API.