non-empty-parameter-examples-key

Overview

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

The example name/key in the parameter level examples object is used to uniquely define an example value. Therefore, it should not be empty.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Empty parameter example key found.
Code	OPENAPI3DOCSGEN_L385
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Parameters
Products Impacted	Developer Experience Portal
Tags	documentation generation documentation docs openapi3 openapi semantic linting apimatic examples example key name parameter

Suggested Fixes

• Assign user friendly names to example objects defined in parameter examples.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#parameter-object
• 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/