Skip to main content

int32-schema-format-with-integer-type

Overview

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

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

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageThe format int32 is not applicable to the given schema type.
CodeOPENAPI3APIMATIC_L666
TypeLinting
Rule SystemSemantic
Broad CategoryOpenAPI Schemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi apimatic semantic linting int32 schema type format integer

Suggested Fixes

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

For More Information