non-empty-pagination-output

Overview

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

The output field in the cursor pagination object must be a valid, non-empty JSON pointer string. It should reference a field in the API response that provides the pagination output, such as a next cursor value.

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

Suggested Fixes

• Provide a valid, non-empty JSON pointer in the output field.
• The pointer should reference a response field that provides the next cursor value for pagination.

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/