Skip to main content

schema-max-items-only-for-arrays

Overview​

This rule belongs to the openapi-v3-standards-linting ruleset and states that:

The property maxItems can only be used for Schema Objects when the type is either unspecified (implying any type) or set as array. This property is not applicable for any other types.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageProperty maxItems is not applicable for the current Schema Object type.
CodeOPENAPI3STANDARDS_L161
TypeLinting
Rule SystemSemantic
Broad CategorySchemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting max items items array schema

Suggested Fixes​

  • Ensure that the value of type in the Schema Object is not set to a value other than array.
  • Type names are compared in a case-sensitive manner.
  • If you use the maxItems keyword, ensure that the data instance you intend to validate can be an array.
  • If the type of the instance can vary i.e. it can be an array or some other type, consider removing the type keyword to allow any types. If you use the oneOf/anyOf constructs instead, consider moving the maxItems to the oneOf/anyOf schema that has the type set as array.

For More Information​