Skip to main content

valid-name-conventions

Overview

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

For successful Code Generation, the name must only use letters, numbers, underscores and dashes. It must not contain any leading/trailing white-space characters. Names are often used for naming the files generated as part of the code generation process, so, any forbidden file name characters are not allowed.

PropertyValue
EnabledYes
Maximum SeverityError
MessageSpecified name is invalid.
CodeAPIMATICCODEGEN_V001
TypeValidation
Rule SystemSemantic
Broad CategoryName Conventions
Products ImpactedCode Generation, Developer Experience Portal
Tagsapimatic code generation codegen sdks portal docs validation apimatic name

Suggested Fixes

  • Make sure the name component does not contain any forbidden characters.
  • Use only letters, numbers, underscores and dashes.
  • Remove any trailing/leading white-space characters, if present.
  • If the name of the component cannot be changed, remove the component definition and its references (if any), to avoid issues.

For More Information