Skip to content
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

Add note about how the body is referenced #33935

Merged
merged 2 commits into from
Jan 22, 2019
Merged

Add note about how the body is referenced #33935

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a5b0282
Add note about how the body is referenced
delvedor Sep 21, 2018
e1e454e
Updated note
delvedor Jan 21, 2019
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
2 changes: 2 additions & 0 deletions rest-api-spec/src/main/resources/rest-api-spec/test/README.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 mainly for cat apis, to refer to the last obtained response body as a string, while `''` refers to the parsed representation of the string (parsed into a Map by the java runner for instance).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should start with the description and then provide an example instead of the other way around. How about a slightly different wording?

`$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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's fine for me :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@delvedor can you please change this in your PR? Then I'm happy to approve. :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, please don't use force-pushing as it messes up the history on the PR. Instead, squash the commits when you merge the PR eventually.


=== `lt` and `gt`

Compares two numeric values, eg:
Expand Down