Skip to main content

non-conflicting-model-and-endpoint-group-names

Overview

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

If controller and model postfixing is disabled, similar model names and endpoint group names can cause conflicts in code generation, therefore, the names of both entities must be kept unique overall.

PropertyValue
EnabledYes
Maximum SeverityError
MessageModel name conflicts with an endpoint group name.
CodeAPIMATICCODEGEN_V133
TypeValidation
Rule SystemSemantic
Broad CategoryGlobal Types/Models
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic name model postfixing endpoint type complex model custom type

Suggested Fixes

  • Make sure the endpoint group names do not conflict with names of models.
  • Names are compared in a case-insensitive manner so ensure that names are kept unique accordingly.
  • Enable controller or model postfixing in the code generation settings to avoid this issue.

For More Information