example-value-or-external-value-present

Overview

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

Example Value represents the actual example value, while External Value is used to reference an external file or URL containing the example. Each example object should include either an Example Value or an External Value.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Example Value and External Value are missing from the example object.
Code	OPENAPI3DOCSGEN_L592
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 value extenal value

Suggested Fixes

• Check each example object and ensure that it includes either an Example Value or an External Value.
• Ensure that the Example Value or External Value accurately reflect the expected data format and content.

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/