From 704e14209cb66df7f3f8744d25d793e9a269b35c Mon Sep 17 00:00:00 2001 From: Yusuke Tsutsumi Date: Wed, 19 Mar 2025 20:57:47 -0700 Subject: [PATCH] feat(158): add guidance on page token validity Currently, the AEPs do not include guidance on a complex nuance of page tokens, when they may not be able to properly continue a request. Documenting that guidance is helpful. Fixes #189 --- aep/general/0158/aep.md.j2 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/aep/general/0158/aep.md.j2 b/aep/general/0158/aep.md.j2 index 335e7a5e..b646fca2 100644 --- a/aep/general/0158/aep.md.j2 +++ b/aep/general/0158/aep.md.j2 @@ -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.