Skip to content

Add YAML spec docs about matching errors #89370

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

Merged
merged 3 commits into from
Aug 18, 2022
Merged

Add YAML spec docs about matching errors #89370

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5cf81c5
Add YAML spec docs about matching errors
DaveCTurner Aug 16, 2022
82eb4e4
Merge branch 'main' into 2022-08-16-rest-api-spec-match-errors
DaveCTurner Aug 18, 2022
ae64ef1
Assertions are optional
DaveCTurner Aug 18, 2022
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
7 changes: 6 additions & 1 deletion rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/README.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -320,8 +320,13 @@ be caught and tested. For instance:
catch: missing
get:
index: test
type: test
type: test
id: 1

Copy link
Member

Choose a reason for hiding this comment

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

Maybe,

# And, optionally, you can assert on the contents of the precise contents of the error message.

- match: { error.type: "illegal_argument_exception" }
- match: { error.reason: "The request contained an illegal argument" }
- match: { error.caused_by.reason: "The argument was illegal because ..." }
- match: { error.root_cause.0.type: "illegal_argument_exception" }
....

The argument to `catch` can be any of:
Expand Down