Skip to content
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.

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

encrypt/decrypt/stream API docs are missing new commitment_policy parameter #302

Open
mattsb42-aws opened this issue Sep 28, 2020 · 2 comments

Comments

@mattsb42-aws
Copy link
Member

I was talking with @seebees about this and noticed that the changes to the encrypt/decrypt/stream API parameters was not documented in the docstrings (and thus the rendered API docs).

@farleyb-amazon
Copy link
Contributor

Thanks @mattsb42-aws . To elaborate, we actually don't intend for callers to directly pass commitment_policy to the encrypt/decrypt/stream APIs; instead, they should be configuring the EncryptionSDKClient with the appropriate commitment policy. We wanted to minimize the number of different places you could configure this option in order to reduce confusion.

However, this does raise another issue, which is that callers currently can pass a commitment policy to these APIs without receiving an error, but the commitment policy will be overridden by the policy in the client. This could definitely be confusing. So I think the fix we should make here is to prevent callers from passing this parameter to the APIs.

@mattsb42-aws
Copy link
Member Author

So I think the fix we should make here is to prevent callers from passing this parameter to the APIs.

++

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants