Skip to content
This repository was archived by the owner on Mar 3, 2026. It is now read-only.

docs: add callout for crc32c checksum and md5 hash options - #1830

Merged
ddelgrosso1 merged 4 commits into
googleapis:mainfrom
ddelgrosso1:write-stream-validation-doc
Apr 1, 2022
Merged

docs: add callout for crc32c checksum and md5 hash options#1830
ddelgrosso1 merged 4 commits into
googleapis:mainfrom
ddelgrosso1:write-stream-validation-doc

Conversation

@ddelgrosso1

@ddelgrosso1 ddelgrosso1 commented Mar 29, 2022

Copy link
Copy Markdown
Contributor

Thank you for opening a Pull Request! Before submitting your PR, there are a few things you can do to make sure it goes smoothly:

  • Make sure to open an issue as a bug/issue before writing your code! That way we can discuss the change, evaluate designs, and agree on the general idea
  • Ensure the tests and linter pass
  • Code coverage does not decrease (if any source code was changed)
  • Appropriate docs were updated (if necessary)
@ddelgrosso1
ddelgrosso1 requested review from a team March 29, 2022 14:29
@product-auto-label product-auto-label Bot added the api: storage Issues related to the googleapis/nodejs-storage API. label Mar 29, 2022
@ddelgrosso1 ddelgrosso1 added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 29, 2022
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 29, 2022
@ddelgrosso1 ddelgrosso1 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 29, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 29, 2022
@ddelgrosso1 ddelgrosso1 added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 29, 2022
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 29, 2022
Comment thread src/file.ts Outdated
* completely, however this is **not recommended**.
* completely, however this is **not recommended**. If using CRC32c
* the checksum can be set in `metadata.crc32c`. For MD5 the hash can
* be set in `metadata.md5Hash`. Providing `metadata.crc32c` or

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What if we made this whole thing less wordy by saying:

In addition to specifying validation type, providing `metadata.crc32c` or `metadata.md5Hash` will cause the server to perform validation in addition to client validation.

@shaffeeullah shaffeeullah left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good to me. Let's look into #1829 further before merging.

@shaffeeullah shaffeeullah added do not merge Indicates a pull request not ready for merge, due to either quality or timing. and removed do not merge Indicates a pull request not ready for merge, due to either quality or timing. labels Mar 29, 2022
@ddelgrosso1 ddelgrosso1 added the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 31, 2022
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 31, 2022
@ddelgrosso1 ddelgrosso1 added kokoro:force-run Add this label to force Kokoro to re-run the tests. owlbot:run Add this label to trigger the Owlbot post processor. labels Mar 31, 2022
@gcf-owl-bot gcf-owl-bot Bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Mar 31, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Mar 31, 2022
@ddelgrosso1
ddelgrosso1 merged commit 53b988c into googleapis:main Apr 1, 2022
@ddelgrosso1
ddelgrosso1 deleted the write-stream-validation-doc branch April 1, 2022 17:28
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

api: storage Issues related to the googleapis/nodejs-storage API.

4 participants