non-empty-pagination-result

Overview

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

The result field within the pagination object must be a valid, non-empty JSON pointer string. It should point to an array field in the API response that contains the paginated results.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The result field in the pagination object is missing or empty.
Code	OPENAPI3APIMATIC_L1001
Type	Linting
Rule System	Semantic
Broad Category	Pagination
Products Impacted	Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting pagination result response endpoint

Suggested Fixes

• Provide a valid, non-empty JSON pointer in the result field.
• The pointer should reference an array field in the API response containing the paginated data.

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/