Skip to content

Page size and token no longer optional in pagination Params #45

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

Merged
merged 1 commit into from
Nov 19, 2024
Merged

Page size and token no longer optional in pagination Params #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

## Summary

<!-- Here goes a general summary of what this release is about -->
Update of the Pagination `Params` data class.

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
* Pagination `Params` has been changed such that the `page_size` and `page_token` fields are now no longer optional.

## New Features

Expand Down
4 changes: 2 additions & 2 deletions src/frequenz/client/common/pagination/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@
class Params:
"""Parameters for paginating list requests."""

page_size: int | None = None
page_size: int
"""The maximum number of results to be returned per request."""

page_token: str | None = None
page_token: str
"""The token identifying a specific page of the list results."""

@classmethod
Expand Down
Loading