allowed-test-case-body-match-mode

Overview

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

The body match mode specified in the test case (if not set to None) must be valid and applicable to the type(s) of the response(s) indicated by the expected status.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Body match mode specified in the test case is not allowed for the response indicated by the expected status.
Code	APIMATICCODEGEN_V168
Type	Validation
Rule System	Semantic
Broad Category	Test Cases
Products Impacted	Code Generation, Developer Experience Portal
Tags	apimatic code generation codegen sdks portal docs validation apimatic response body test case endpoint

Suggested Fixes

• Change body match mode in accordance with the type definition of the response linked in the test case.
• For cases where a range is used in the expected status of the test case, the body match mode must be valid for all response types that fall under that range.
• Set match mode to "None".
• Disable the test case by turning off the Enabled flag.

For More Information

• https://www.apimatic.io/continuous-code-generation
• https://docs.apimatic.io/testing/defining-your-first-test-case/#body-match-mode
• https://docs.apimatic.io/testing/defining-test-case/#step-2-describe-test-case
• https://docs.apimatic.io/rulesets/overview/