integer-format-defined
Requires every resolved integer schema to use int32, int64, or bigint format.
| Attribute | Value |
|---|---|
| Category | Schema |
| Maturity | Gold |
| OpenAPI | Swagger 2.0; OpenAPI 3.0, 3.1, 3.2 |
| Starter | Off |
| Lenient–Strict | Warning |
| Complete | Error |
Intent
Integer format tells consumers the expected storage range and helps generators choose a suitable native type.
Flags
An integer schema with no format or a format outside int32, int64, and bigint. Non-integer schemas are ignored.
See it fail
count:
type: integer
Diagnostic: Integer schemas should define format \int32`, `int64` or `bigint`.`
Fix it
count:
type: integer
format: int32
Configure
profiles:
default:
rules:
extends: [recommended]
override:
integer-format-defined: error
Nearby: number-format-defined, integer-bounds-required.