Skip to content

Updating docs to new default algo sha1 #66

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
TavoNiievez merged 1 commit into from
Dec 20, 2021
Merged

Updating docs to new default algo sha1 #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions src/Codeception/Module/REST.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1557,17 +1557,17 @@ public function dontSeeXmlResponseIncludes($xml): void

/**
* Checks if the hash of a binary response is exactly the same as provided.
* Parameter can be passed as any hash string supported by hash(), with an
* optional second parameter to specify the hash type, which defaults to md5.
* Parameter can be passed as any hash string supported by `hash()`, with an
* optional second parameter to specify the hash type, which defaults to sha1.
*
* Example: Using md5 hash key
* Example: Using sha1 hash key
*
* ```php
* <?php
* $I->seeBinaryResponseEquals("8c90748342f19b195b9c6b4eff742ded");
* $I->seeBinaryResponseEquals("df589122eac0f6a7bd8795436e692e3675cadc3b");
* ```
*
* Example: Using md5 for a file contents
* Example: Using sha1 for a file contents
*
* ```php
* <?php
Expand All @@ -1583,7 +1583,7 @@ public function dontSeeXmlResponseIncludes($xml): void
* ```
*
* @param string $hash the hashed data response expected
* @param string $algo the hash algorithm to use. Default md5.
* @param string $algo the hash algorithm to use. Default sha1.
* @part json
* @part xml
*/
Expand Down