Skip to content
Last updated

required-string-property-missing-min-length

Requires that every required property in the API description with type string has a minLength.

OASCompatibility
2.0✅
3.0✅
3.1✅
3.2✅

API design principles

The minLength keyword constrains string values. When a property of type string is required, defining the minLength helps prevent common mistakes, such as empty strings. Use the minLength property as a best practice to ensure data integrity and enhances the overall quality of the API.

Configuration

To configure the rule, add it to the rules object in your configuration file. Set the desired severity for the rule.

rules:
  required-string-property-missing-min-length:
    severity: error
OptionTypeDescription
severitystringPossible values: off, warn, error. Default off (in recommended configuration).

An example configuration:

rules:
  required-string-property-missing-min-length: error

Examples

Given this configuration:

rules:
  required-string-property-missing-min-length: error

Example of an incorrect schema:

schemas:
  User:
    type: object
    required:
        - name
    properties:
      name:
        description: User name
        type: string

Example of a correct schema:

schemas:
  User:
    type: object
    required:
        - name
    properties:
      name:
        description: User name
        type: string
        minLength: 2

Resources

 
Next page