example-summary-or-description-exists

Overview

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

Example Object must have a non-null and non-empty description or summary.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Example object summary and description are missing.
Code	OPENAPI3DOCSGEN_L590
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Examples
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic example examples summary description

Suggested Fixes

• Add a user-friendly description for the example object.

For More Information

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