updated

Author: github-actions[bot]

changelog.markdown

@@ -9,6 +9,27 @@ title: Codeception Changelog
 
 
 
+### module-rest 3.4.0: 3.4.0
+
+Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16) TavoNiievez](https://github.com/TavoNiievez) on 2024/07/12 06:34:39 / [Repository](https://github.com/Codeception/module-rest)   / [Releases](https://github.com/Codeception/module-rest/releases)
+
+
+
+## What's Changed
+* Use FQN for public methods by **[erickskrauch](https://github.com/erickskrauch)** in https://github.com/Codeception/module-rest/pull/97
+* Changing double quotes to single quotes in the docs by **[ThomasLandauer](https://github.com/ThomasLandauer)** in https://github.com/Codeception/module-rest/pull/102
+* Allow softcreatr/jsonpath v0.9 + justinrainbow/json-schema v5.3 by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-rest/pull/99
+* Test against PHP 8.2 + 8.3 by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-rest/pull/101
+* Relax parameter types to allow filters like "array:empty" in JsonType by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-rest/pull/107
+* Add unsetHttpHeader() + deprecate deleteHeader() by **[W0rma](https://github.com/W0rma)** in https://github.com/Codeception/module-rest/pull/106
+
+## New Contributors
+* **[erickskrauch](https://github.com/erickskrauch)** made their first contribution in https://github.com/Codeception/module-rest/pull/97
+* **[W0rma](https://github.com/W0rma)** made their first contribution in https://github.com/Codeception/module-rest/pull/99
+
+**Full Changelog**: https://github.com/Codeception/module-rest/compare/3.3.2...3.4.0
+
+
 ### module-symfony 3.4.0: 3.4.0
 
 Released by [![](https://avatars.githubusercontent.com/u/64917965?v=4&s=16) TavoNiievez](https://github.com/TavoNiievez) on 2024/06/09 13:34:44 / [Repository](https://github.com/Codeception/module-symfony)   / [Releases](https://github.com/Codeception/module-symfony/releases)

docs/modules/REST.md

@@ -86,7 +86,7 @@ Conflicts with SOAP module
 #### amAWSAuthenticated
 
 * `param array` $additionalAWSConfig
-* `throws ConfigurationException`
+* `throws \Codeception\Exception\ConfigurationException`
 * `return void`
 
 Allows to send REST request using AWS Authorization
@@ -152,7 +152,7 @@ Adds HTTP authentication via username/password.
 * `part` xml
 * `param string` $username
 * `param string` $password
-* `throws ModuleException`
+* `throws \Codeception\Exception\ModuleException`
 * `return void`
 
 Adds NTLM authentication via username/password.
@@ -171,26 +171,10 @@ $I->amNTLMAuthenticated('jon_snow', 'targaryen');
 
 #### deleteHeader
 
-* `part` json
-* `part` xml
-* `param string` $name the name of the header to delete.
+@deprecated
+* `param string` $name
 * `return void`
 
-Deletes a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
-so that subsequent requests will not send it anymore.
-
-Example:
-{% highlight php %}
-
-<?php
-$I->haveHttpHeader('X-Requested-With', 'Codeception');
-$I->sendGet('test-headers.php');
-// ...
-$I->deleteHeader('X-Requested-With');
-$I->sendPost('some-other-page.php');
-
-{% endhighlight %}
-
 
 #### dontSeeBinaryResponseEquals
 
@@ -205,7 +189,7 @@ Checks if the hash of a binary response is not the same as provided.
 {% highlight php %}
 
 <?php
-$I->dontSeeBinaryResponseEquals("8c90748342f19b195b9c6b4eff742ded");
+$I->dontSeeBinaryResponseEquals('8c90748342f19b195b9c6b4eff742ded');
 
 {% endhighlight %}
 Opposite to `seeBinaryResponseEquals`
@@ -360,7 +344,7 @@ Element is matched by either CSS or XPath
 
 * `part` json
 * `param string` $jsonPath
-* `throws Exception`
+* `throws \Exception`
 * `return array` Array of matching items
 
 See [#jsonpath](#jsonpath) for general info on JSONPath.
@@ -427,7 +411,7 @@ Element is matched by either CSS or XPath
 * `param string` $value
 * `return void`
 
-Sets a HTTP header to be used for all subsequent requests. Use [`deleteHeader`](#deleteHeader) to unset it.
+Sets a HTTP header to be used for all subsequent requests. Use [`unsetHttpHeader`](#unsetHttpHeader) to unset it.
 
 {% highlight php %}
 
@@ -471,7 +455,7 @@ Example: Using sha1 hash key
 {% highlight php %}
 
 <?php
-$I->seeBinaryResponseEquals("df589122eac0f6a7bd8795436e692e3675cadc3b");
+$I->seeBinaryResponseEquals('df589122eac0f6a7bd8795436e692e3675cadc3b');
 
 {% endhighlight %}
 
@@ -480,7 +464,7 @@ Example: Using sha1 for a file contents
 {% highlight php %}
 
 <?php
-$fileData = file_get_contents("test_file.jpg");
+$fileData = file_get_contents('test_file.jpg');
 $I->seeBinaryResponseEquals(md5($fileData));
 
 {% endhighlight %}
@@ -490,7 +474,7 @@ Example: Using sha256 hash
 
 <?php
 $fileData = '/9j/2wBDAAMCAgICAgMCAgIDAwMDBAYEBAQEBAgGBgUGCQgKCgkICQkKDA8MCgsOCwkJDRENDg8QEBEQCgwSExIQEw8QEBD/yQALCAABAAEBAREA/8wABgAQEAX/2gAIAQEAAD8A0s8g/9k='; // very small jpeg
-$I->seeBinaryResponseEquals(hash("sha256", base64_decode($fileData)), 'sha256');
+$I->seeBinaryResponseEquals(hash('sha256', base64_decode($fileData)), 'sha256');
 
 {% endhighlight %}
 
@@ -672,10 +656,10 @@ $I->seeResponseIsValidOnJsonSchemaString('{"type": "object"}');
 
 // response {"name": "john", "age": 20}
 $schema = [
- "properties" => [
-     "age" => [
-         "type" => "integer",
-         "minimum" => 18
+ 'properties' => [
+     'age' => [
+         'type' => 'integer',
+         'minimum' => 18
      ]
  ]
 ];
@@ -897,6 +881,7 @@ or after another filter if you need more than one.
 
 Here is the list of possible filters:
 
+* `array:empty` - check that value is an empty array
 * `integer:>{val}` - checks that integer is greater than {val} (works with float and string types too).
 * `integer:<{val}` - checks that integer is lower than {val} (works with float and string types too).
 * `string:url` - checks that value is valid url.
@@ -955,7 +940,7 @@ Example:
 {% highlight php %}
 
 <?php
-$I->seeXmlResponseIncludes("<result>1</result>");
+$I->seeXmlResponseIncludes('<result>1</result>');
 
 {% endhighlight %}
 
@@ -982,7 +967,7 @@ $I->seeXmlResponseMatchesXpath('//root/user[@id=1]');
 * `part` xml
 * `param string` $method
 * `param string` $url
-* `param array|string|JsonSerializable` $params
+* `param array|string|\JsonSerializable` $params
 * `param array` $files
 
 Sends a HTTP request.
@@ -1065,7 +1050,7 @@ Sends an OPTIONS request to given uri.
 * `part` json
 * `part` xml
 * `param string` $url
-* `param array|string|JsonSerializable` $params
+* `param array|string|\JsonSerializable` $params
 * `param array` $files
 
 Sends PATCH request to given uri.
@@ -1085,7 +1070,7 @@ $response = $I->sendPatch('/message/1', ['subject' => 'Read this!']);
 * `see` https://php.net/manual/en/features.file-upload.post-method.php
 * `see` codecept_data_dir()
 * `param string` $url
-* `param array|string|JsonSerializable` $params
+* `param array|string|\JsonSerializable` $params
 * `param array` $files A list of filenames or "mocks" of $_FILES (each entry being an array with the following
                     keys: name, type, error, size, tmp_name (pointing to the real file path). Each key works
                     as the "name" attribute of a file input field.
@@ -1125,7 +1110,7 @@ $I->sendPost('/add-task', ['form' => [
 * `part` json
 * `part` xml
 * `param string` $url
-* `param array|string|JsonSerializable` $params
+* `param array|string|\JsonSerializable` $params
 * `param array` $files
 
 Sends PUT request to given uri.
@@ -1198,4 +1183,27 @@ $I->stopFollowingRedirects();
 
 {% endhighlight %}
 
+
+#### unsetHttpHeader
+
+* `part` json
+* `part` xml
+* `param string` $name the name of the header to unset.
+* `return void`
+
+Unsets a HTTP header (that was originally added by [haveHttpHeader()](#haveHttpHeader)),
+so that subsequent requests will not send it anymore.
+
+Example:
+{% highlight php %}
+
+<?php
+$I->haveHttpHeader('X-Requested-With', 'Codeception');
+$I->sendGet('test-headers.php');
+// ...
+$I->unsetHttpHeader('X-Requested-With');
+$I->sendPost('some-other-page.php');
+
+{% endhighlight %}
+
 <p>&nbsp;</p><div class="alert alert-warning">Module reference is taken from the source code. <a href="https://github.com/Codeception/module-rest/tree/master/src/Codeception/Module/REST.php">Help us to improve documentation. Edit module reference</a></div>

docs/reference/JsonType.md

@@ -18,10 +18,11 @@ Usage example:
 {% highlight php %}
 
 <?php
-$jsonType = new JsonType(['name' => 'davert', 'id' => 1]);
+$jsonType = new JsonType(['name' => 'davert', 'id' => 1, 'data' => []]);
 $jsonType->matches([
   'name' => 'string:!empty',
   'id' => 'integer:>0|string:>0',
+  'data' => 'array:empty',
 ]); // => true
 
 $jsonType->matches([
@@ -46,7 +47,7 @@ Pass an array or `\Codeception\Util\JsonArray` with data.
 
 If non-associative array is passed - the very first element of it will be used for matching.
 
-[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L47)
+[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L48)
 
 #### addCustomFilter()
 
@@ -80,7 +81,7 @@ JsonType::addCustomFilter('/len\((.*?)\)/', function($value, $len) {
 
 {% endhighlight %}
 
-[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L77)
+[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L78)
 
 #### cleanCustomFilters()
 
@@ -91,7 +92,7 @@ JsonType::addCustomFilter('/len\((.*?)\)/', function($value, $len) {
 
 Removes all custom filters
 
-[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L85)
+[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L86)
 
 #### matches()
 
@@ -106,6 +107,6 @@ Checks data against passed JsonType.
 If matching fails function returns a string with a message describing failure.
 On success returns `true`.
 
-[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L95)
+[See source](https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php#L96)
 
 <p>&nbsp;</p><div class="alert alert-warning">Reference is taken from the source code. <a href="https://github.com/Codeception/module-rest/blob/master/src/Codeception/Util/JsonType.php">Help us to improve documentation. Edit module reference</a></div>