Skip to main content

schema-max-length-only-for-strings

Overview​

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

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

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

Suggested Fixes​

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

For More Information​