pagination-type-required

Overview

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

Every pagination extension must specify a type field indicating the pagination strategy. Supported values are "offset", "page", "cursor", and "link". Without a type, the pagination configuration cannot be validated or applied.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The pagination type is missing or null in the pagination extension.
Code	OPENAPI3APIMATIC_L1011
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

Suggested Fixes

• Specify a type field in the pagination extension.
• Supported pagination types are: "offset", "page", "cursor", and "link".

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/