spectral:arazzo warn on by default

arazzo-step-description

Step "description" should be present and non-empty string.

Applies to
description
Selects
$.workflows[*].steps[*]
Function
truthy
Specs
Arazzo 1.0

Use it

This rule ships with OpenLint in spectral:arazzo. Extending the ruleset turns it on:

extends: spectral:arazzo
rules:
  arazzo-step-description: warn   # or off, or another severity

Definition

As defined in @openlint/openlint-rulesets. Functions show by name.

arazzo-step-description:
  description: Step "description" should be present and non-empty string.
  severity: warn
  given: '$.workflows[*].steps[*]'
  then:
    field: description
    function: truthy

About this rule

In order to improve consumer experience, Step description should be present and a non-empty string.

Recommend: Yes

Sources