Repository navigation
feat(openapi): describe nextPage and previousPage as page paths - #27
Merged
Merged
Conversation
List responses return `page.nextPage` and `page.previousPage` as the path of the adjacent page, relative to the server URL, so a client can request it directly. The path keeps the query parameters of the request and carries the cursor in `after` or `before`, which the API still accepts. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
![redocly[bot]](https://avatars.githubusercontent.com/in/348054?s=60&v=4){kind=small}
There was a problem hiding this comment.
AI Review: 🟢 Completed
Redocly Agent has reviewed your changes and found 1 potential issue(s).
Note
Low Risk
Documentation-only update to the OpenAPI specification and changelog aligning contract definitions with pagination behavior changes; no application runtime code is modified.
Overview
- Updates
Pageschema (Page.yaml) to definenextPageandpreviousPageas relative URI paths (format: uri-reference) with preserved query parameters and illustrative examples. - Clarifies
AfterandBeforeparameter descriptions to note that cursors are embedded in adjacent page paths. - Bumps API specification version to
1.1.0incafe.yamland adds release notes toCHANGELOG.md.
Changed pages
kamil1094
marked this pull request as ready for review
October 14, 2026 12:51
DmitryAnansky
approved these changes
Oct 14, 2026
vadyvas
reviewed
Oct 15, 2026
vadyvas
left a comment
vadyvas
left a comment
Contributor
There was a problem hiding this comment.
can you also update changelog ?
…xt-and-previous-page
…for page paths `example` is deprecated on a Schema Object in OpenAPI 3.2, so the page path examples use the JSON Schema `examples` list. The changed meaning of `nextPage` and `previousPage` is listed under 1.1.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
vadyvas
approved these changes
Oct 15, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
List responses (
GET /menu,GET /orders) now returnpage.nextPageandpage.previousPageas the path of the adjacent page instead of a bare cursor:This PR updates the description to match:
Page.yaml: the values are paths relative to the server URL (format: uri-reference), with examples. A path keeps the query parameters of the request and setsafter(next) orbefore(previous);nullstill means there is no adjacent page.After.yamlandBefore.yaml: the cursor is theafter/beforequery parameter of that path, so a client can request the path directly. Both parameters are still accepted.The server URL is just the host (
https://api.cafe.redocly.com), soserverUrl + nextPageandnew URL(nextPage, serverUrl)give the same URL.Merge order
Merge this after the API change is deployed to
api.cafe.redocly.com, so the description never describes paths while the API still returns cursors.🤖 Generated with Claude Code