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.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Warning |
| Message | The format int32 is not applicable to the given schema type. |
| Code | OPENAPI3APIMATIC_L666 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI Schemas |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting int32 schema type format integer |
Suggested Fixes
- Ensure that the schema type is set to
integerfor compatibility with theint32format. - If the schema represents a different data type, consider using a compatible format or removing the
int32format. - Ensure that the format used aligns with the schema's type and represents the desired data representation (e.g., int64 for larger integer values).