aip-dev / google.aip.dev

API Improvement Proposals. https://aip.dev/
Other
1.08k stars 495 forks source link

feat(AIP-217)!: change unreahcable pagination guidance #1392

Closed noahdietz closed 2 months ago

noahdietz commented 2 months ago

The paginated response guidance for unreachable population is changed significantly. Services must populate unreachable resources on a per-page basis i.e. as they are encountered while preparing a specific page fetch RPC response. As such, unreachable resources will be populated alongside results within a page. This is opposite of the previous guidance to populate unreachable only at the end of all paged content and being mutually exclusive from results. Services may continue to use the previous guidance within an API version for backwards compatibility purposes. Furthermore, unreachable must be an unordered list, and annotated as such.

Internal bug for doc(s) and details: http://b/350781494

Note: For observers, the reviewers of this PR are not the only reviewers of this change, they are simply the GitHub reviewers for the changes already approved by a broader set of reviewers.