feat(AIP-217)!: change unreahcable pagination guidance #1392
Conversation
This file contains 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
jskeet
approved these changes
Jul 30, 2024
| - Populate results that were previously considered unreachable on a following | ||
| page if their availability is restored and the paging parameters allow for | ||
| their inclusion. | ||
| - For example, if region `projects/example/locations/us-west1` was unavailable |
There was a problem hiding this comment.
It may be worth documenting that the ordering could be implicit here - if the service is documented to return resources in resource name order when the client doesn't specify anything, that's sufficient to prevent the newly-available resources from being returned.
There was a problem hiding this comment.
I understand the scenario you are describing, but not sure what the suggestion is. I've included a bullet above this example to bring "documented default ordering" into scope of inclusion evaluation: 696b95d
Is that what you mean?
itsStrobe
reviewed
Jul 30, 2024
jskeet
approved these changes
Aug 2, 2024
itsStrobe
approved these changes
Aug 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The paginated response guidance for
unreachablepopulation 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.