request-body-encoding-explode-only-for-form-media-types

Overview

This rule belongs to the openapi-v3-standards-validation ruleset and states that:

In an OpenAPI v3.1.x document, the Encoding Object referenced by a Request Body Object content definition must configure explode only if the content media type is set as application/x-www-form-urlencoded or multipart/form-data. If explode is defined for a different request body media type, it will be ignored.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	Property explode in the Encoding Object is not applicable for current request body media type.
Code	OPENAPI3STANDARDS_V160
Type	Validation
Rule System	Semantic
Broad Category	Encoding
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic validation explode encoding request body url encoded multipart media type

Suggested Fixes

• Remove property explode from the Encoding Object.
• Ensure that the Encoding Object is defined inside a media type definition that supports configuration of explode.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#encoding-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#request-body-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#media-type-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
• https://docs.apimatic.io/rulesets/overview/