Skip to content

feat(158): add guidance on page token validity #286

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(158): add guidance on page token validity #286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions aep/general/0158/aep.md.j2
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,16 @@ used. It is not necessary to document this behavior.
**Note:** While a reasonable time may vary between APIs, a good rule of thumb
is three days.

### Page Token Validity

Sometimes, page tokens may only be valid in a particular context. An example is
continuing a list request that has filtered to down to a field that only exists
in a newer version of a resource.

The server **should** verify that the page token is valid in the context of the
request in which it passed, and return a INVALID_ARGUMENT / 400 if the
verification fails.

### Backwards compatibility

Adding pagination to an existing method is a backwards-incompatible change.
Expand Down