request-body-encoding-allow-reserved-only-for-form-url-encoded-media-type
Overview
This rule belongs to the openapi-v3-standards-validation ruleset and states that:
In an OpenAPI v3.0.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. If allowReserved is defined for a different request body media type, it will be ignored.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | Property allowReserved in the Encoding Object is not applicable for current request body media type. |
| Code | OPENAPI3STANDARDS_V153 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Encoding |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic validation allow reserved encoding request body url encoded media type |
Suggested Fixes
- Remove property
allowReservedfrom the Encoding Object. - Ensure that the Encoding Object is defined inside a media type definition that supports configuration of
allowReserved.
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.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://docs.apimatic.io/rulesets/overview/