valid-pagination-type
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
The pagination type defined for the response must be one of the supported types: "offset", "page", "cursor", or "link". Any other value is considered invalid.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Invalid pagination type specified in the response. |
| Code | OPENAPI3APIMATIC_L1000 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | Pagination |
| Products Impacted | Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting pagination type response endpoint offset page cursor link |
Suggested Fixes
- Set the pagination type to one of the supported values: "offset", "page", "cursor", or "link".
- Remove or correct any invalid pagination type values.