no-content-type-with-encoding-explode
Overview
This rule belongs to the openapi-v3-standards-validation ruleset and states that:
If the encoding explode value is explicitly defined using the Encoding Object's explode property, then the value of property contentType (implicit or explicit) will be ignored.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Encoding explode is defined, therefore, the value of contentType will be ignored. |
| Code | OPENAPI3STANDARDS_V155 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Encoding |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic validation content type explode serialization property encoding |
Suggested Fixes
- Remove the
contentTypeproperty from the Encoding Object. - If you want the
contentTypeinformation to be effective, remove theexplodeinformation from the Encoding Object instead.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#encodingContentType
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#encodingExplode
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#encoding-object
- https://docs.apimatic.io/rulesets/overview/