path-item-summary-or-description-exists

Overview

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

The OpenAPI specification requires that every Path Item object includes a summary and/or description property. These properties provide a brief overview of the operations defined by the path.

Property	Value
Enabled	No
Maximum Severity	Information
Message	Summary and description properties are missing or empty for path object.
Code	OPENAPI3DOCSGEN_L240
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Path Items
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic path summary description

Suggested Fixes

• Ensure that the Path Object contains the summary property.
• Ensure that the Path Object contains the description property.
• Ensure that Path 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#path-item-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/