pagination-input-must-point-to-integer-property
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
For both offset-based and page-based pagination strategies, the input field must point to a property of type integer. This value typically represents the starting offset or page number and must be a valid integer to ensure correct pagination behavior.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The input field in offset or page-based pagination must point to a property of type integer. |
| Code | OPENAPI3APIMATIC_L1010 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Pagination |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting pagination offset page input type request endpoint |
Suggested Fixes
- Ensure the
inputfield references a property of typeinteger. - The input property represents the starting offset or page number for pagination.