Skip to content
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.

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

fix(pebble)!: change select=all to users=all for pebble get_notices #1146

Merged
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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: 4 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 2.12.0

* Updated Pebble Notices `get_notices` parameter name to `users=all` (previously `select=all`).

# 2.11.0

* `StopEvent`, `RemoveEvent`, and all `LifeCycleEvent`s are no longer deferrable, and will raise a `RuntimeError` if `defer()` is called on the event object.
Expand Down
6 changes: 3 additions & 3 deletions ops/pebble.py
Original file line number Diff line number Diff line change
Expand Up @@ -1317,10 +1317,10 @@ class NoticeType(enum.Enum):


class NoticesUsers(enum.Enum):
IronCore864 marked this conversation as resolved.
Show resolved Hide resolved
"""Enum of :meth:`Client.get_notices` ``select`` values."""
"""Enum of :meth:`Client.get_notices` ``users`` values."""

ALL = 'all'
"""Select notices from all users (any user ID, including public notices).
"""Return notices from all users (any user ID, including public notices).

This only works for Pebble admins (for example, root).
"""
Expand Down Expand Up @@ -2824,7 +2824,7 @@ def get_notices(
type has nanosecond precision).

Args:
users: Select which notices to return (instead of returning
users: Filter which users' notices to return (instead of returning
benhoyt marked this conversation as resolved.
Show resolved Hide resolved
notices for the current user).
user_id: Filter for notices for the specified user, including
public notices (only works for Pebble admins).
Expand Down
Loading