Skip to main content

valid-property-value-type

Overview

This rule belongs to the openapi-v3-syntax-validation ruleset and states that:

Value of an OpenAPI standard property must be in accordance with the type set by the standard for that property.

PropertyValue
EnabledYes
Maximum SeverityError
MessageProperty value does not conform to the expected property type.
CodeOPENAPI3SYNTAX_V222
TypeValidation
Rule SystemSyntax
Broad CategoryMiscellaneous
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi syntax validation type property value property

Suggested Fixes

  • If an array is expected, ensure that your value is surrounded by square brackets [ and ].
  • If an array is not expected, ensure that your value contains a single item only and is not surrounded by square brackets [ and ].
  • If a numeric value is expected, ensure that your value is a valid number and it is not surrounded by single or double quotes.
  • If a string value is expected, ensure that it is escaped properly and surrounded by quotes if necessary.
  • If an object is expected, ensure that your value is a key-value map.

For More Information