required-gavel-expected-response
Overview
This rule belongs to the apimatic-gavel-validation ruleset and states that:
When defining a test case, you must define the response you expect when the specified request will be executed. This is done using the root level expectedResponse property which must not be missing or set to null.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Required property expectedResponse is missing from the root Gavel object. |
| Code | APIMATICGAVEL_V300 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Gavel Expected Response |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | gavel apimatic semantic validation response |
Suggested Fixes
- Ensure that the
expectedResponseproperty exists in the root object. - Ensure that the
expectedResponseproperty is not set as null. - Ensure that the
expectedResponseproperty name does not have any typos.