Skip to content

has_description

Checks that objects in scope have a description of at least a minimum length. For the contract scope, that's description.purpose. For schema and property, it's the description string.

Options

Option Default Description
scope property contract, schema or property.
min_length 1 Minimum number of characters, after trimming whitespace.

Examples

rules:
  - type: has_description
    scope: property
    min_length: 10

[[rules]]
type = "has_description"
scope = "property"
min_length = 10

Findings

orders.odcs.yaml
  14:9  error    has_description  property `amount` has no description
  18:9  error    has_description  description of property `note` is shorter than 10 characters