Skip to main content

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.

PropertyValue
EnabledYes
Maximum SeverityError
MessageThe input field in offset or page-based pagination must point to a property of type integer.
CodeOPENAPI3APIMATIC_L1010
TypeLinting
Rule SystemSemantic
Broad CategoryPagination
Products ImpactedCode Generation, Developer Experience Portal
Tagsopenapi3 openapi apimatic semantic linting pagination offset page input type request endpoint

Suggested Fixes

  • Ensure the input field references a property of type integer.
  • The input property represents the starting offset or page number for pagination.

For More Information