optional-field-parameters-test-case

Overview

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

Test case must not contain undeclared field parameters if endpoint does not allow optional field parameters.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Optional field parameters are found in the input parameters of the test case even though the endpoint does not allow them.
Code	APIMATICCODEGEN_V166
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 parameter test case endpoint setting endpoint

Suggested Fixes

• Remove optional field parameters from the test case input parameters.
• Enable optional field parameters from the endpoint settings.
• Disable the test case by turning off the Enabled flag.

For More Information

• https://docs.apimatic.io/api-editor/endpoints/#advanced-settings
• 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/