Skip to content

Clarify Java pageable maxPageSize guidance for TypeSpec samples #50434

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −0
Draft

Clarify Java pageable maxPageSize guidance for TypeSpec samples #50434

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81075f1
Initial plan
Copilot Sep 14, 2026
49ea141
Document pageable page size usage
Copilot Sep 14, 2026
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
6 changes: 6 additions & 0 deletions docs/contributor/typespec-quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,12 @@ See [TypeSpec Java Customization](https://github.com/Azure/azure-sdk-for-java/bl

- Edit `ReadmeSamples.java` between `// BEGIN: ...` / `// END: ...` markers.
- Build the project → the codesnippet plugin auto-injects them into `README.md`.
- For pageable operations, Java convenience methods don't take `maxPageSize` as a direct method
argument. Set the preferred page size on the returned pageable result instead:
`PagedIterable.iterableByPage(int preferredPageSize)` for sync clients or
`PagedFlux.byPage(int preferredPageSize)` for async clients. Generated samples or tests that pass
`maxpagesize` or `maxPageSize` directly to the client method are incorrect and should be adjusted
to use the returned `PagedIterable` or `PagedFlux` page-iteration API.

See [JavaDoc and Code Snippets](https://github.com/Azure/azure-sdk-for-java/blob/main/docs/contributor/javadocs.md).

Expand Down