required-gavel-request

Overview

This rule belongs to the apimatic-gavel-validation ruleset and states that:

When defining a test case, you must define the input test data for your request using the root level request property. This property must not be missing or set to null.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Required property request is missing from the root Gavel object.
Code	APIMATICGAVEL_V001
Type	Validation
Rule System	Semantic
Broad Category	Gavel Request
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	gavel apimatic semantic validation request

Suggested Fixes

• Ensure that the request property exists in the root object.
• Ensure that the request property is not set as null.
• Ensure that the request property name does not have any typos.

For More Information

• https://docs.apimatic.io/specification-extensions/swagger-test-cases-extensions/#gavel-specification
• https://docs.apimatic.io/specification-extensions/swagger-test-cases-extensions/#specifying-test-cases-using-gavel-specification
• https://docs.apimatic.io/rulesets/overview/