operation-summary-or-description-exists

Overview

This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:

The Operation Object must specify details about the operation using either the summary or the description property. The value of the summary/description must be non-null and non-empty.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Both summary and description are missing from operation object.
Code	OPENAPI3DOCSGEN_L300
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Operations
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic summary operation description

Suggested Fixes

• Ensure that the Operation Object contains the summary property.
• Ensure that the Operation Object contains the description property.
• Ensure that Operation Object summary/description value is not null or empty.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/