operation-description
Operation "description" must be present and non-empty string.
- Applies to
description- Selects
#OperationObject- Function
truthy- Specs
- OpenAPI 2.0OpenAPI 3.0OpenAPI 3.1OpenAPI 3.2
Use it
This rule ships with OpenLint in spectral:oas. Extending the ruleset turns it on:
extends: spectral:oas
rules:
operation-description: warn # or off, or another severity
Definition
As defined in @openlint/openlint-rulesets. Functions show by name.
operation-description:
description: Operation "description" must be present and non-empty string.
recommended: true
given: '#OperationObject'
then:
field: description
function: truthy