fix ws dosctrings

Author: tmunzer-AIDE

src/mistapi/websockets/__ws_client.py

@@ -48,25 +48,6 @@ def filter(self, record: logging.LogRecord) -> bool:
     from mistapi import APISession
 
 
-#: Shared parameter documentation for all WebSocket channel subclasses.
-_COMMON_WS_PARAMS_DOC = """\
-    ping_interval : int, default 30
-        Interval in seconds to send WebSocket ping frames (keep-alive).
-    ping_timeout : int, default 10
-        Time in seconds to wait for a ping response before considering the connection dead.
-    auto_reconnect : bool, default False
-        Automatically reconnect on unexpected disconnections using exponential backoff.
-    max_reconnect_attempts : int, default 5
-        Maximum number of reconnect attempts before giving up.
-    reconnect_backoff : float, default 2.0
-        Base backoff delay in seconds. Doubles after each failed attempt.
-    queue_maxsize : int, default 0
-        Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set,
-        incoming messages are dropped with a warning when the queue is
-        full, preventing memory growth on high-frequency streams."""
-
-
 class _MistWebsocket:
     """
     Base class for Mist API WebSocket channels.

src/mistapi/websockets/location.py

@@ -41,7 +41,7 @@ class BleAssetsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -121,7 +121,7 @@ class ConnectedClientsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -201,7 +201,7 @@ class SdkClientsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -281,7 +281,7 @@ class UnconnectedClientsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -363,7 +363,7 @@ class DiscoveredBleAssetsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 

src/mistapi/websockets/orgs.py

@@ -12,11 +12,11 @@
 """
 
 from mistapi import APISession
-from mistapi.websockets.__ws_client import _COMMON_WS_PARAMS_DOC, _MistWebsocket
+from mistapi.websockets.__ws_client import _MistWebsocket
 
 
 class InsightsEvents(_MistWebsocket):
-    f"""WebSocket stream for organization insights events.
+    """WebSocket stream for organization insights events.
 
     Subscribes to the ``orgs/{org_id}/insights/summary`` channel and delivers
     real-time insights events for the given organization.
@@ -27,7 +27,21 @@ class InsightsEvents(_MistWebsocket):
         Authenticated API session.
     org_id : str
         UUID of the organization to stream events from.
-{_COMMON_WS_PARAMS_DOC}
+    ping_interval : int, default 30
+        Interval in seconds to send WebSocket ping frames (keep-alive).
+    ping_timeout : int, default 10
+        Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on unexpected disconnections using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
+    queue_maxsize : int, default 0
+        Maximum number of messages buffered in the internal queue for the
+        ``receive()`` generator. ``0`` means unbounded. When set,
+        incoming messages are dropped with a warning when the queue is
+        full, preventing memory growth on high-frequency streams.
 
     EXAMPLE
     -----------
@@ -78,7 +92,7 @@ def __init__(
 
 
 class MxEdgesStatsEvents(_MistWebsocket):
-    f"""WebSocket stream for organization MX edges stats events.
+    """WebSocket stream for organization MX edges stats events.
 
     Subscribes to the ``orgs/{org_id}/stats/mxedges`` channel and delivers
     real-time MX edges stats events for the given organization.
@@ -89,7 +103,21 @@ class MxEdgesStatsEvents(_MistWebsocket):
         Authenticated API session.
     org_id : str
         UUID of the organization to stream events from.
-{_COMMON_WS_PARAMS_DOC}
+    ping_interval : int, default 30
+        Interval in seconds to send WebSocket ping frames (keep-alive).
+    ping_timeout : int, default 10
+        Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on unexpected disconnections using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
+    queue_maxsize : int, default 0
+        Maximum number of messages buffered in the internal queue for the
+        ``receive()`` generator. ``0`` means unbounded. When set,
+        incoming messages are dropped with a warning when the queue is
+        full, preventing memory growth on high-frequency streams.
 
     EXAMPLE
     -----------
@@ -140,7 +168,7 @@ def __init__(
 
 
 class MxEdgesEvents(_MistWebsocket):
-    f"""WebSocket stream for org MX edges events.
+    """WebSocket stream for org MX edges events.
 
     Subscribes to the ``orgs/{org_id}/mxedges`` channel and delivers
     real-time MX edges events for the given org.
@@ -151,7 +179,21 @@ class MxEdgesEvents(_MistWebsocket):
         Authenticated API session.
     org_id : str
         UUID of the org to stream events from.
-{_COMMON_WS_PARAMS_DOC}
+    ping_interval : int, default 30
+        Interval in seconds to send WebSocket ping frames (keep-alive).
+    ping_timeout : int, default 10
+        Time in seconds to wait for a ping response before considering the connection dead.
+    auto_reconnect : bool, default False
+        Automatically reconnect on unexpected disconnections using exponential backoff.
+    max_reconnect_attempts : int, default 5
+        Maximum number of reconnect attempts before giving up.
+    reconnect_backoff : float, default 2.0
+        Base backoff delay in seconds. Doubles after each failed attempt.
+    queue_maxsize : int, default 0
+        Maximum number of messages buffered in the internal queue for the
+        ``receive()`` generator. ``0`` means unbounded. When set,
+        incoming messages are dropped with a warning when the queue is
+        full, preventing memory growth on high-frequency streams.
 
     EXAMPLE
     -----------

src/mistapi/websockets/session.py

@@ -48,7 +48,7 @@ class SessionWithUrl(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 

src/mistapi/websockets/sites.py

@@ -39,7 +39,7 @@ class ClientsStatsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -124,7 +124,7 @@ class DeviceCmdEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -204,7 +204,7 @@ class DeviceStatsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -281,7 +281,7 @@ class DeviceEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -358,7 +358,7 @@ class MxEdgesStatsEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -435,7 +435,7 @@ class MxEdgesEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.
 
@@ -512,7 +512,7 @@ class PcapEvents(_MistWebsocket):
         Base backoff delay in seconds. Doubles after each failed attempt.
     queue_maxsize : int, default 0
         Maximum number of messages buffered in the internal queue for the
-        ``receive()`` generator. ``0`` means unbounded. When set, the
+        ``receive()`` generator. ``0`` means unbounded. When set,
         incoming messages are dropped with a warning when the queue is
         full, preventing memory growth on high-frequency streams.