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

Documentation for Blob.update() and Storage.update() methods is confusing/incorrect. #252

Closed
dmitry-fa opened this issue Apr 15, 2020 · 1 comment · Fixed by #261
Closed
Assignees
Labels
api: storage Issues related to the googleapis/java-storage API. documentation Improvements or additions to documentation priority: p2 Moderately-important priority. Fix may not be included in next release.

Comments

@dmitry-fa
Copy link
Contributor

Documentation for Blob.update(Options...) doesn't include example of usage, the provided examples demonstrate how to use Storage.update(blobInfo). The doc also mentions non existing parameter blobInfo: Original metadata are merged with metadata in the provided blobInfo.
Taking into account the fact that Objects of this class are immutable. this method seems useless.
The documentation should be updated to clarify usage.

Documentation for Storage.update() methods is better but still confusing. The important aspects are not covered:

  • The term metadata could be read as blob's information or as blob's user provided metadata
  • It's not clarify if blob's generation is updated
  • What happens if the preconditions specified by the options fail

Documentation should be aligned with the new Blob/BlobInfo API Doc introduced by #176

@product-auto-label product-auto-label bot added the api: storage Issues related to the googleapis/java-storage API. label Apr 15, 2020
@dmitry-fa dmitry-fa self-assigned this Apr 15, 2020
@frankyn frankyn added documentation Improvements or additions to documentation priority: p2 Moderately-important priority. Fix may not be included in next release. labels Apr 15, 2020
@frankyn
Copy link
Member

frankyn commented Apr 15, 2020

This sounds like a good plan, thanks @dmitry-fa

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/java-storage API. documentation Improvements or additions to documentation priority: p2 Moderately-important priority. Fix may not be included in next release.
Projects
None yet
2 participants