link-pagination-next-must-be-string

Overview

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

In link-based pagination, the next field must be a string containing the URL to the next page of results. Any other type is considered invalid.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The next field in link-based pagination must be of type string.
Code	OPENAPI3APIMATIC_L1009
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

• Ensure the next field references a property of type string.
• The field must contain a URL string pointing to the next page of results.

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/