Skip to main content

pre-defined-model

Overview

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

A model referenced by any component must be pre-defined in the global custom types. If that is not the case, then for components that support "Object" or "Dynamic" primitive types, the component referencing the undefined model will fall back to one of these types.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageEntity referenced an undefined model and has been reverted to a default type.
CodeAPIMATICPOSTPROCESS_V353
TypeValidation
Rule SystemSemantic
Broad CategoryTypes
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagsapimatic postprocessing validation type model complex model custom type

Suggested Fixes

  • Make sure your API specification does not reference any models for which corresponding definition does not exist.
  • Make sure that the type/model name matches exactly with the name assigned to the model definition. Names are compared in a case sensitive manner.

For More Information