cursor-input-cursor-output-types-should-match

Overview

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

The input and output fields in a cursor-based pagination object must have matching schema types. For example, if the input field is of type string, the output field must also be of type string.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The schema types for cursor input and output fields do not match.
Code	OPENAPI3APIMATIC_L1007
Type	Linting
Rule System	Semantic
Broad Category	Pagination
Products Impacted	Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting pagination input output type response endpoint

Suggested Fixes

• Ensure the schema types of cursor input and output fields match.
• If the input cursor is of type string, the output cursor must also be of type string.

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/