spell-check

spell-check

This rule runs a spell checker through all strings to be read by humans, such as summaries and descriptions.

Rule Details

The spell-check rule is designed to ensure that all human-readable strings in a schema, such as summaries and descriptions, are free from spelling errors.

NOTE: This rule uses Hunspell behind the scenes. Due to license limitations I cannot ship dictionaries alongside the binary, you need to download them by yourselves.

Configuration

The configuration block is an object with two required properties, dictionary and affix. The former should be a path to Hunspell-compatible dictionary, the latter must be a path to affix dictionary.

Configuration Example

lint:
  spell-check:
    - warn
    - dictionary: path/to/hunspell.dict
      affix: path/to/hunspell.affix

Examples

Good.

paths:
  /users:
    get:
      summary: Retrieve a list of users
      description: This operation retrieves a list of users from the system.

Bad.

paths:
  /users:
    get:
      summary: Retrive a list of users
      description: This operation retrives a list of users from the system.

When Not to Use It

We recommend to always enable this rule.

Compatibility

This rule is compatible with all OpenAPI 3.x versions.

← Back to Index