Skip to main content

non-conflicting-parameter-names

Overview

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

If conflicts are observed in parameter's display names, they may be renamed to avoid code generation issues.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageThe parameter's display name has been updated to prevent code generation conflicts. To specify an appropriate display name, use the parameter-level x-unique-name extension.
CodeAPIMATICPOSTPROCESSCODEGEN_V006
TypeValidation
Rule SystemSemantic
Broad CategoryEndpoints
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic postprocessing code generation validation name parameter x-unique-name

Suggested Fixes

  • Use parameter-level x-unique-name extension to define appropriate unique display name.
  • Names are compared in a case-insensitive manner to prevent code generation issues.
  • Uniquely name your parameters to avoid this issue.

For More Information