Skip to content

add explicit public API definition #97

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 9, 2019
Merged

add explicit public API definition #97

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
95c34e7
add explicit public API definition
mattsb42-aws Feb 5, 2019
070d2f8
copyedit
mattsb42-aws Feb 5, 2019
114f8fe
tweak public API definition
mattsb42-aws Oct 9, 2019
efe5ffe
Merge branch 'master' into api
mattsb42-aws Oct 9, 2019
1b428bd
Merge branch 'master' into api
mattsb42-aws Oct 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,13 @@ public class StringExample {

You can find more examples in the [examples directory][examples].

## 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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The public API that we maintain includes all public classes in the in the com.amazonaws.encryptionsdk package unless otherwise documented. Our versioning policy applies to this public API.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Edit: "Our versioning policy applies to all public classes in the com.amazonaws.encryptionsdk
package unless otherwise documented."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, not to nitpick: it also applies to public constants, methods, etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... and protected methods, constants, etc.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Second try: Our versioning policy 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.

## FAQ

See the [Frequently Asked Questions](https://docs.aws.amazon.com/encryption-sdk/latest/developer-guide/faq.html) page in the official documentation.
Expand Down