non-empty-pagination-next
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The next field in a link-based pagination object must be a valid, non-empty JSON pointer string. It should reference a field in the API response that provides the URL to the next page of results.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The next pointer in the link pagination object is missing or empty. |
| Code | OPENAPI3APIMATIC_L1008 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Pagination |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting pagination next link response endpoint |
Suggested Fixes
- Provide a valid, non-empty JSON pointer in the
nextfield. - The pointer should reference a response field that contains the URL to the next page.