no-binary-schema-for-json-request-body-content

Overview

This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:

The binary format cannot be used with schemas that are being used with JSON request body content.

Property	Value
Enabled	No
Maximum Severity	Error
Message	The format binary is not applicable to schemas associated with JSON request body content.
Code	OPENAPI3APIMATIC_L673
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Schemas
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting binary schema request body content json

Suggested Fixes

• Ensure that the format of the schema is not set to binary for any schemas used within JSON request body content.
• Consider using another compatible format instead of binary for JSON request body content.
• Try adding the binary type property schema in form parameters.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/