non-empty-pagination-input
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The input field in the pagination object must be a valid, non-empty JSON pointer string. It should reference a field in the API request that provides the pagination input, such as an offset, page number, or cursor value.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | The input field in the pagination object is missing or empty. |
| Code | OPENAPI3APIMATIC_L1005 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Pagination |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting pagination input request endpoint |
Suggested Fixes
- Provide a valid, non-empty JSON pointer in the
inputfield. - The pointer should reference a request parameter used for pagination input (e.g., offset, page number, or cursor).