Skip to main content

required-entity-type

Overview

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

A valid type (primitive or a custom type) must be specified in the entity definition.

PropertyValue
EnabledYes
Maximum SeverityError
MessageEntity does not have a type defined.
CodeAPIMATICPRE_V401
TypeValidation
Rule SystemSemantic
Broad CategoryTypes
Products ImpactedCode Generation, Developer Experience Portal, API Transformer
Tagspreliminary checks validation apimatic type primitve type scalar type custom type model complex model

Suggested Fixes

  • Specify a type name in the Type property of the entity.
  • Make sure that the type name you specify is a valid primitive type or name of a pre-defined custom type/model.
  • Make sure the type name is not misspelled. Names are compared in a case sensitive manner.
  • If the type is a primitive one, make sure it is supported in the respective specification format.

For More Information