request-body-encoding-headers-only-for-multipart-media-type

Overview

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

The Encoding Object referenced by a Request Body Object content definition must define headers only if the content has a multipart media type e.g. multipart/form-data. If headers are defined for a different request body media type, their definition will be ignored.

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

Suggested Fixes

• Remove property headers from the Encoding Object.
• Ensure that the Encoding Object is defined inside a media type definition that supports encoding headers.

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#encoding-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#request-body-object
• 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#openapi-specification
• https://docs.apimatic.io/rulesets/overview/