OpenLint Ruleset Specification warn on by default

operation-summary

Every operation needs a summary.

Applies to
summary
Selects
$.paths[*]['get','put','post','delete','options','head','patch','trace']
Function
truthy
Specs
OpenAPI 3.0OpenAPI 3.1OpenAPI 3.2

Use it

This rule isn't built in. Copy it into your ruleset:

aliases:
  Operation:
    - '$.paths[*][''get'',''put'',''post'',''delete'']'
rules:
  operation-summary:
    description: Every operation needs a summary.
    severity: warn
    given: '$.paths[*][''get'',''put'',''post'',''delete'',''options'',''head'',''patch'',''trace'']'
    then:
      field: summary
      function: truthy

About this rule

From the specification’s running example, where it is defined in a shared base ruleset (acme-base.yaml) and raised to error for files under legacy/ with an override.

Sources