Skip to content

Commit 372c35b

Browse files
authored
Update README.md
1 parent 3093e2f commit 372c35b

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ You can additionally create tests that make API calls and verify that the actual
1111
```json
1212
{
1313
"test_name": {
14-
"test_host": "url", (optional, if omitted then default server for API will be used.
15-
"skip_example": true | false, (optional, defaults to false)
16-
"ignore_missing_parameter_warnings": true | false, (optional, defaults to false)
14+
"test_host": "url",
15+
"skip_example": false,
16+
"ignore_missing_parameter_warnings": false,
1717
"parameters": {
1818
"path_param_name": "value",
19-
"header_param_name": "value" (must be a string, even if the parameter type is Int or other)
19+
"header_param_name": "value"
2020
},
2121
"query_parameters": [
2222
{
@@ -26,7 +26,13 @@ You can additionally create tests that make API calls and verify that the actual
2626
]
2727
}
2828
}
29-
```
29+
```
30+
31+
Parameters:
32+
- `test_host`: optional, if omitted then default server for API will be used.
33+
- `skip_example`: optional, defaults to false.
34+
- `ignore_missing_parameter_warnings`: optional, defaults to false.
35+
- `parameters` values: Must be strings, even if the parameter type is Int or other.
3036

3137
### The Commandline Tool
3238
#### Against a URL

0 commit comments

Comments
 (0)