Add note about how the body is referenced (#33935)

elastic · Jan 22, 2019 · 35b3e69 · 35b3e69
1 parent d6c73f4
commit 35b3e69
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc b/rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc
@@ -316,6 +316,8 @@ Supports also regular expressions with flag X for more readability (accepts whit
                    \d+    \s+  \d{2}:\d{2}:\d{2}  \s+  \d+    \s+  \n  $/
 ....
 
+**Note:** `$body` is used to refer to the last obtained response body as a string, while `''` refers to the parsed representation (parsed into a Map by the Java runner for instance). Having the raw string response is for example useful when testing cat APIs.
+
 === `lt` and `gt`
 
 Compares two numeric values, eg: