Skip to main content

required-data-structure-property-name

Overview

This rule belongs to the api-blueprint-validation ruleset and states that:

A data structure that defines an object must specify a non-empty name for each property which is part of the object. Properties with missing name will be ignored automatically when importing/transforming the document in APIMatic.

PropertyValue
EnabledYes
Maximum SeverityError
MessageObject data structure contains a property with a missing name.
CodeAPIBLUEPRINT_V300
TypeValidation
Rule SystemSemantic
Broad CategoryData Structures
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsapi blueprint api elements api semantic validation name property object

Suggested Fixes

  • Make sure that the property name is specified and it is not empty or missing.
  • Ensure that the property definition is correctly nested in the object definition.

For More Information