Skip to content

Sync generated WS files with backend AsyncAPI spec #191

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
martinkersner merged 2 commits into from
Jul 6, 2026
Merged

Sync generated WS files with backend AsyncAPI spec #191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7df78c2
chore: sync generated WS files with backend AsyncAPI spec
martinkersner Jul 6, 2026
df74393
fix(ws): drop announcement_internal accessor (channel spec-excluded)
martinkersner Jul 6, 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
1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,7 +572,6 @@ you can also read the expected shape at runtime via `ws.<channel>.param_format`.
| `ws.liquidation` | `subscribe(*p)` | `SYMBOL@exchange` | Basic |
| `ws.liquidation_feed` | `stream()` | — (firehose, no params) | Basic |
| `ws.announcement` | `subscribe()` | — (no params) | Pro+ |
| `ws.announcement_internal` | `subscribe()` | — (no params) | Pro+ |

### Multiplexing and filtering

Expand Down
8 changes: 0 additions & 8 deletions datamaxi/_ws_endpoints.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,6 @@
"subscribe": True,
"unsubscribe": True,
},
"/announcement/listing/internal": {
"plan": "pro_plus",
"market": None,
"message": "InternalListingMessage",
"param": None,
"subscribe": True,
"unsubscribe": True,
},
"/forex": {
"plan": "basic",
"market": None,
Expand Down
15 changes: 0 additions & 15 deletions datamaxi/_ws_models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,21 +62,6 @@
)


# source: asyncapi:payload
InternalListingMessage = TypedDict(
"InternalListingMessage",
{
"b": str,
"d": int,
"e": str,
"s": str,
"t": str,
"u": str,
},
total=False,
)


# source: asyncapi:payload
LiquidationMessage = TypedDict(
"LiquidationMessage",
Expand Down
7 changes: 2 additions & 5 deletions datamaxi/aio/ws.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
Channels (accessors driven by the generated ``WS_CHANNELS`` registry):
``ticker`` (market-keyed), ``forex``, ``premium``, ``funding_rate``,
``open_interest``, ``liquidation`` (subscribe), ``liquidation_feed``
(firehose, no params), ``announcement`` / ``announcement_internal`` (Pro+).
(firehose, no params), ``announcement`` (Pro+).

Consumes the **generated** WS surface — ``WS_CHANNELS`` / ``WS_BASE_PATH`` /
``WS_AUTH_HEADER`` from ``datamaxi._ws_endpoints`` and the per-channel message
Expand Down Expand Up @@ -419,7 +419,7 @@ class AsyncDatamaxiWS:
Accessors are driven by the generated ``WS_CHANNELS`` registry:
``ticker`` (market-keyed), ``forex``, ``premium``, ``funding_rate``,
``open_interest``, ``liquidation`` (subscribe), ``liquidation_feed``
(firehose), ``announcement`` / ``announcement_internal`` (Pro+).
(firehose), ``announcement`` (Pro+).

Use as an async context manager so open connections are closed, or call
:meth:`aclose` explicitly.
Expand Down Expand Up @@ -449,9 +449,6 @@ def __init__(
self.liquidation = Subscription(self, "/liquidation")
self.liquidation_feed = Feed(self, "/liquidation/feed")
self.announcement = Subscription(self, "/announcement/listing")
self.announcement_internal = Subscription(
self, "/announcement/listing/internal"
)

async def _conn(self, path: str) -> AsyncWSConnection:
conn = self._conns.get(path)
Expand Down
1 change: 0 additions & 1 deletion docs/websocket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ strings shown below; you can also inspect the expected format at runtime via
| `ws.liquidation` | `subscribe(*p)` | `SYMBOL@exchange` | Basic |
| `ws.liquidation_feed` | `stream()` | — (firehose, no params) | Basic |
| `ws.announcement` | `subscribe()` | — (no params) | Pro+ |
| `ws.announcement_internal` | `subscribe()` | — (no params) | Pro+ |

`ticker` is market-keyed — pass `market="spot"` (default) or `market="futures"`.
The announcement channels require a **Pro+** plan.
Expand Down
1 change: 0 additions & 1 deletion tests/test_ws.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,6 @@ def test_ws_every_channel_has_a_generated_model_and_accessor():
"liquidation",
"liquidation_feed",
"announcement",
"announcement_internal",
):
assert hasattr(ws, name), f"client missing ws.{name}"

Expand Down
Loading