test-case-expected-body-value-restrictions

Overview

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

The value provided for the expected response body in a test case must obey all restrictions placed in the corresponding response type definition(s).

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The test value provided for expected body violates type restrictions.
Code	APIMATICCODEGEN_V170
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

• Adjust the test value so that it meets all type restrictions present in the corresponding response definition(s).
• Remove the restrictions from the corresponding response type definition(s).
• Disable the test case by turning off the Enabled flag.

For More Information

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