Skip to content

Commit b732de4

Browse files
committed
Rename scenario methods to reflect action group terminology and update docstrings
1 parent 56d65be commit b732de4

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pyoverkiz/client.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,7 @@ async def cancel_execution(self, exec_id: str) -> None:
553553

554554
@retry_on_auth_error
555555
async def get_action_groups(self) -> list[ActionGroup]:
556-
"""List the persisted action groups (scenarios)."""
556+
"""List the persisted action groups."""
557557
response = await self._get("actionGroups")
558558
return [ActionGroup(**action_group) for action_group in decamelize(response)]
559559

@@ -573,14 +573,14 @@ async def get_places(self) -> Place:
573573
return Place(**decamelize(response))
574574

575575
@retry_on_auth_error
576-
async def execute_scenario(self, oid: str) -> str:
577-
"""Execute a scenario."""
576+
async def execute_persisted_action_group(self, oid: str) -> str:
577+
"""Execute a persisted action group by its OID."""
578578
response = await self._post(f"exec/{oid}")
579579
return cast(str, response["execId"])
580580

581581
@retry_on_auth_error
582-
async def execute_scheduled_scenario(self, oid: str, timestamp: int) -> str:
583-
"""Execute a scheduled scenario."""
582+
async def schedule_persisted_action_group(self, oid: str, timestamp: int) -> str:
583+
"""Schedule a persisted action group for future execution."""
584584
response = await self._post(f"exec/schedule/{oid}/{timestamp}")
585585
return cast(str, response["triggerId"])
586586

0 commit comments

Comments
 (0)