Skip to content

Commit f85b896

Browse files
authored
Merge pull request #13 from igorsantos07/patch-1
[docs] Adds null to seeResponseMatchesJsonType + wording
2 parents 863bc0b + 74540e9 commit f85b896

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

src/Codeception/Module/REST.php

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,9 +1129,9 @@ public function dontSeeResponseContainsJson($json = [])
11291129
}
11301130

11311131
/**
1132-
* Checks that Json matches provided types.
1132+
* Checks that JSON matches provided types.
11331133
* In case you don't know the actual values of JSON data returned you can match them by type.
1134-
* Starts check with a root element. If JSON data is array it will check the first element of an array.
1134+
* It starts the check with a root element. If JSON data is an array it will check all elements of it.
11351135
* You can specify the path in the json which should be checked with JsonPath
11361136
*
11371137
* Basic example:
@@ -1151,16 +1151,17 @@ public function dontSeeResponseContainsJson($json = [])
11511151
* ?>
11521152
* ```
11531153
*
1154-
* In this case you can match that record contains fields with data types you expected.
1154+
* You can check if the record contains fields with the data types you expect.
11551155
* The list of possible data types:
11561156
*
11571157
* * string
11581158
* * integer
11591159
* * float
11601160
* * array (json object is array as well)
11611161
* * boolean
1162+
* * null
11621163
*
1163-
* You can also use nested data type structures:
1164+
* You can also use nested data type structures, and define multiple types for the same field:
11641165
*
11651166
* ```php
11661167
* <?php
@@ -1172,7 +1173,8 @@ public function dontSeeResponseContainsJson($json = [])
11721173
* ?>
11731174
* ```
11741175
*
1175-
* You can also apply filters to check values. Filter can be applied with `:` char after the type declaration.
1176+
* You can also apply filters to check values. Filter can be applied with a `:` char after the type declaration,
1177+
* or after another filter if you need more than one.
11761178
*
11771179
* Here is the list of possible filters:
11781180
*
@@ -1200,12 +1202,13 @@ public function dontSeeResponseContainsJson($json = [])
12001202
* ?>
12011203
* ```
12021204
*
1203-
* You can also add custom filters y accessing `JsonType::addCustomFilter` method.
1205+
* You can also add custom filters by using `{@link JsonType::addCustomFilter()}`.
12041206
* See [JsonType reference](http://codeception.com/docs/reference/JsonType).
12051207
*
12061208
* @part json
12071209
* @param array $jsonType
12081210
* @param string $jsonPath
1211+
* @see JsonType
12091212
* @version 2.1.3
12101213
*/
12111214
public function seeResponseMatchesJsonType(array $jsonType, $jsonPath = null)

0 commit comments

Comments
 (0)