Skip to content

Commit f8ef82d

Browse files
Added comments to highlight EventClient api missmatches
1 parent a191720 commit f8ef82d

4 files changed

Lines changed: 16 additions & 0 deletions

File tree

src/conductor/asyncio_client/event/event_client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,8 @@ async def add_event_handler_tag(self, name: str, tags: List[TagAdapter]) -> None
9494
await event_client.add_event_handler_tag("workflow_trigger", tags)
9595
```
9696
"""
97+
# Note: Async API uses (name=name, tag=tags) keyword args to match the server signature.
98+
# Sync API uses (tags, name) positional args due to swagger-codegen parameter ordering.
9799
return await self.client.put_tag_for_event_handler(name=name, tag=tags)
98100

99101
async def remove_event_handler_tag(self, name: str, tags: List[TagAdapter]) -> None:
@@ -122,4 +124,6 @@ async def remove_event_handler_tag(self, name: str, tags: List[TagAdapter]) -> N
122124
await event_client.remove_event_handler_tag("workflow_trigger", tags_to_remove)
123125
```
124126
"""
127+
# Note: Async API uses (name=name, tag=tags) keyword args to match the server signature.
128+
# Sync API uses (tags, name) positional args due to swagger-codegen parameter ordering.
125129
return await self.client.delete_tag_for_event_handler(name=name, tag=tags)

src/conductor/asyncio_client/orkes/orkes_event_client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -233,6 +233,8 @@ async def add_event_handler_tag(
233233
await event_client.add_event_handler_tag("workflow_trigger", tags)
234234
```
235235
"""
236+
# Note: Async API uses (name=name, tag=tags) keyword args to match the server signature.
237+
# Sync API uses (tags, name) positional args due to swagger-codegen parameter ordering.
236238
return await self.event_api.put_tag_for_event_handler(name=name, tag=tags)
237239

238240
async def remove_event_handler_tag(
@@ -263,6 +265,8 @@ async def remove_event_handler_tag(
263265
await event_client.remove_event_handler_tag("workflow_trigger", tags_to_remove)
264266
```
265267
"""
268+
# Note: Async API uses (name=name, tag=tags) keyword args to match the server signature.
269+
# Sync API uses (tags, name) positional args due to swagger-codegen parameter ordering.
266270
return await self.event_api.delete_tag_for_event_handler(name=name, tag=tags)
267271

268272
# Queue Configuration Operations

src/conductor/client/event/event_client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,8 @@ def add_event_handler_tag(self, name: str, tags: List[TagAdapter]) -> None:
9090
event_client.add_event_handler_tag("workflow_trigger", tags)
9191
```
9292
"""
93+
# Note: Sync API uses (tags, name) parameter order due to swagger-codegen placing
94+
# body params before path params. Async API uses (name=name, tag=tags) instead.
9395
return self.client.put_tag_for_event_handler(tags, name)
9496

9597
def remove_event_handler_tag(self, name: str, tags: List[TagAdapter]) -> None:
@@ -118,4 +120,6 @@ def remove_event_handler_tag(self, name: str, tags: List[TagAdapter]) -> None:
118120
event_client.remove_event_handler_tag("workflow_trigger", tags_to_remove)
119121
```
120122
"""
123+
# Note: Sync API uses (tags, name) parameter order due to swagger-codegen placing
124+
# body params before path params. Async API uses (name=name, tag=tags) instead.
121125
return self.client.delete_tag_for_event_handler(tags, name)

src/conductor/client/orkes/orkes_event_client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -234,6 +234,8 @@ def add_event_handler_tag(
234234
event_client.add_event_handler_tag("workflow_trigger", tags)
235235
```
236236
"""
237+
# Note: Sync API uses (tags, name) parameter order due to swagger-codegen placing
238+
# body params before path params. Async API uses (name=name, tag=tags) instead.
237239
return self.eventResourceApi.put_tag_for_event_handler(tags, name)
238240

239241
def remove_event_handler_tag(
@@ -264,6 +266,8 @@ def remove_event_handler_tag(
264266
event_client.remove_event_handler_tag("workflow_trigger", tags_to_remove)
265267
```
266268
"""
269+
# Note: Sync API uses (tags, name) parameter order due to swagger-codegen placing
270+
# body params before path params. Async API uses (name=name, tag=tags) instead.
267271
return self.eventResourceApi.delete_tag_for_event_handler(tags, name)
268272

269273
# Queue Configuration Operations

0 commit comments

Comments
 (0)