initial work to support x-ms-pageable for generated specs #742
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
added 3 commits
May 4, 2022 10:48
API endpoints that define x-ms-pageable supports generating a `Pageable` stream (via `into_stream`) instead of an `into_future` builder. At the moment, the generator does not support endpoints that use the HTTP header `x-ms-continuation` (seen as not providing a next_link_name in the x-ms-pageable spec).
cataggar
approved these changes
May 5, 2022
This was referenced Jun 6, 2022
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.
API endpoints that define x-ms-pageable supports generating a
Pageablestream (viainto_stream) instead of aninto_futurebuilder.At the moment, the generator does not support endpoints that use the HTTP header
x-ms-continuation(seen as not providing a next_link_name in the x-ms-pageable spec). For functions that this does not work, there is now a doc comment added such that users are informed that the generated API does not page.In order to fully flesh this out, we need to support including header values in the response object due to how Pageable works. See #446 for more information.
As this is similar to LRO support, endpoints that would typically be polled but do not yet poll, a doc comment is also added such that the users are informed that the polling does not occur.
Adding support for this is tracked as #741.