Skip to main content

number-format-defined

Requires every resolved number schema to use float, double, or decimal format.

AttributeValue
CategorySchema
MaturityGold
OpenAPISwagger 2.0; OpenAPI 3.0, 3.1, 3.2
StarterOff
Lenient–StrictWarning
CompleteError

Intent

Number format communicates precision expectations and helps generators select a suitable native type.

Flags

A number schema with no format or a format outside float, double, and decimal. Integer schemas are handled separately.

See it fail

amount:
type: number

Diagnostic: Number schemas should define format \float`, `double` or `decimal`.`

Fix it

amount:
type: number
format: decimal

Configure

profiles:
default:
rules:
extends: [recommended]
override:
number-format-defined: error

Nearby: integer-format-defined, invalid-numeric-bounds.