valid-pagination-json-pointer

Overview

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

The JSON pointer must reference a valid location within the request or response. Examples of valid pointers include: $response.body, $response.body#/data/prop, and $request.query#/offset.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	Invalid JSON pointer provided.
Code	OPENAPI3APIMATIC_L1003
Type	Linting
Rule System	Semantic
Broad Category	Pagination
Products Impacted	Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting pagination pointer response endpoint

Suggested Fixes

• Ensure the JSON pointer follows a valid format such as $response.body#/path/to/field or $request.query#/paramName.
• Verify that the pointer references a valid location within the request or response.

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/