spectral:arazzo hint on by default

arazzo-step-operationPath

It is recommended to use "operationId" rather than "operationPath".

Applies to
operationPath
Selects
$.workflows[*].steps[*]
Function
falsy
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-operationPath: hint   # or off, or another severity

Definition

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

arazzo-step-operationPath:
  description: It is recommended to use "operationId" rather than "operationPath".
  severity: hint
  given: '$.workflows[*].steps[*]'
  then:
    field: operationPath
    function: falsy

About this rule

It is recommended to use operationId rather than operationPath within a step to reference an API operation.

Sources