Skip to main content

required-media-type-schema-for-multipart-request-body

Overview​

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

The request body multipart media type definition must contain a schema property to define the input parameters to the operation.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired schema definition for multipart request body media type is missing.
CodeOPENAPI3STANDARDS_V130
TypeValidation
Rule SystemSemantic
Broad CategoryMedia Types
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation schema multipart media type body request

Suggested Fixes​

  • Your request body definition would consist of a content property with multipart media type e.g. multipart/form-data. Ensure the Media Type Object defined in this content media type contains the property schema.
  • Ensure that the schema property provides a valid Schema Object definition.
  • The schema must define an object with properties. Here, each property will represent a multipart input parameter that needs to be sent in the request.

For More Information​