float-schema-format-with-number-type

Overview

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

The float format is only applicable to schemas with the type set to number. It seems that the float format has been used with an incompatible schema type.

Property	Value
Enabled	Yes
Maximum Severity	Warning
Message	The format float is not applicable to the given schema type.
Code	OPENAPI3APIMATIC_L668
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Schemas
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting float schema type format number

Suggested Fixes

• Ensure that the schema type is set to number for compatibility with the float format.
• If the schema represents a different data type, consider using a compatible format or removing the float format.
• Ensure that the format used aligns with the schema's type and represents the desired data representation (e.g., double for larger number).

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/