Skip to main content

request-body-encoding-allow-reserved-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 allowReserved only if the content media type is set as application/x-www-form-urlencoded or multipart/form-data. If allowReserved is defined for a different request body media type, it will be ignored.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageProperty allowReserved in the Encoding Object is not applicable for current request body media type.
CodeOPENAPI3STANDARDS_V161
TypeValidation
Rule SystemSemantic
Broad CategoryEncoding
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation allow reserved encoding request body url encoded multipart media type

Suggested Fixes​

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

For More Information​