pagination-result-points-to-array

Overview

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

The result field in the pagination object must be a valid JSON pointer that references an array field in the API response. Pointers targeting non-array fields are not supported and will result in an invalid pagination configuration.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The pagination result pointer must reference an array field in the response.
Code	OPENAPI3APIMATIC_L1002
Type	Linting
Rule System	Semantic
Broad Category	Pagination
Products Impacted	Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting pagination result array response endpoint

Suggested Fixes

• Ensure the result pointer references a field of type array in the response schema.
• Verify the JSON pointer path resolves to the correct array field.

For More Information

• https://docs.apimatic.io/specification-extensions/swagger-codegen-extensions/#pagination
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/