non-empty-media-type-examples-key
Overview
This rule belongs to the openapi-v3-docsgen-linting ruleset and states that:
The example name/key in media type 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 media type example key found. |
| Code | OPENAPI3DOCSGEN_L463 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Media Types |
| Products Impacted | Developer Experience Portal |
| Tags | documentation generation documentation docs openapi3 openapi semantic linting apimatic examples example key name media type |
Suggested Fixes
- Assign user friendly names to example object defined in media type examples.
For More Information
- https://www.apimatic.io/
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#media-type-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#example-object
- https://docs.apimatic.io/rulesets/overview/