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

Document is misleading for the zip_file option of Aws::Lambda::Client#update_function_code #942

Closed
ShikChen opened this issue Oct 1, 2015 · 2 comments
Labels
documentation This is a problem with documentation.

Comments

@ShikChen
Copy link

ShikChen commented Oct 1, 2015

The document says:

:zip_file (IO, String) — Based64-encoded .zip file containing your packaged source code.

But in fact you should not encode your zip file in Base64. The raw string of zip file just works.

@pchaganti
Copy link

You do not need to encode to base64. We are using

IO.read(path_to_zip)  

@trevorrowe
Copy link
Member

Thank you for reporting this issue. Currently we generate our API documentation from the same source as the service API reference. This means that sometimes HTTP wire-level documentation sneaks into the SDK documentation. The SDK will automatically base64 encode data that is to be treated as a binary blob.

I'll see what we can do about improving the SDK documentation to not mention the encoding.

@trevorrowe trevorrowe added Version 2 documentation This is a problem with documentation. labels Oct 13, 2015
awood45 added a commit that referenced this issue Oct 22, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

3 participants