Skip to content

Commit 3d591d0

Browse files
Kowserclaude
andcommitted
S6: docs — AgentScheduleClient removal (no backward compatibility)
CHANGELOG Deprecated → Removed (breaking, with migration); drop the deprecated-shim paragraphs from the agents docs; AgentClient.schedules and runtime.schedules_client() documented as returning SchedulerClient. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 9d128f5 commit 3d591d0

3 files changed

Lines changed: 5 additions & 10 deletions

File tree

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2121
- **Breaking (scoped):** schedule client objects no longer expose the mapped `get`/`save`/`list_for_agent` wrappers — `SchedulerClient`'s native methods are the source of truth: `get(wire)``get_schedule(wire)`, `save(schedule, agent)``save_schedule(SaveScheduleRequest)`, `list_for_agent(agent)``get_all_schedules(workflow_name=agent)`. The module-level `schedules.list/get/save` functions (and their `ScheduleInfo` returns) are unchanged
2222
- `get_schedule` returns a typed `WorkflowSchedule` (or `None` for missing schedules) instead of a raw camelCase dict, matching its declared annotation and [docs/SCHEDULE.md](docs/SCHEDULE.md); dict-consumers should switch to attribute access or `to_dict()`
2323

24-
### Deprecated
24+
### Removed
2525

26-
- `AgentScheduleClient`/`ScheduleClient` and `OrkesClients.get_agent_schedule_client()` — fully functional delegation shims over `SchedulerClient`; use `get_scheduler_client()`. Removal planned for the next major release
26+
- **Breaking:** `AgentScheduleClient` (alias `ScheduleClient`) and `OrkesClients.get_agent_schedule_client()` are removed with no compatibility shim — `SchedulerClient` (via `OrkesClients.get_scheduler_client()`) is the one schedule client and carries the full lifecycle itself. Replace `AgentScheduleClient(scheduler_client, workflow_client)` constructions with `get_scheduler_client()`; `runtime.schedules_client()` and `AgentClient.schedules` now return that `SchedulerClient` directly (same methods, same shared instance)
2727

2828
### Fixed
2929

docs/agents/advanced.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,7 @@ which add local-worker management on top of this client.
134134
The raw `/agent/*` HTTP transport behind this client is
135135
`conductor.client.ai.AgentApiClient` — also reachable without the agents layer via
136136
`OrkesClients.get_agent_client()` (and `get_scheduler_client()` for the cron
137-
lifecycle; `get_agent_schedule_client()` is deprecated). `AgentClient` composes that
138-
transport and adds the agent-level surface.
137+
lifecycle). `AgentClient` composes that transport and adds the agent-level surface.
139138

140139
## Structured output
141140

docs/agents/api-reference.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Context manager (sync and async: `with` / `async with`).
4646
| `signal` | `(execution_id, message) -> None` | Inject persistent context |
4747
| `shutdown` | `() -> None` | Stop all workers |
4848
| `client` (property) | `-> AgentClient` | Control-plane client |
49-
| `schedules_client` | `() -> SchedulerClient` | Shared schedule client (a deprecated `AgentScheduleClient` shim) |
49+
| `schedules_client` | `() -> SchedulerClient` | Shared schedule client |
5050

5151
Async variants exist for status/respond/approve/reject/send/stop/shutdown
5252
(`*_async`). Module-level wrappers using a singleton runtime: `run`, `run_async`,
@@ -207,10 +207,6 @@ WorkflowSchedule | None`, `save_schedule(SaveScheduleRequest)`,
207207
`get_all_schedules(workflow_name=...) -> list[WorkflowSchedule]`. The mapped
208208
`ScheduleInfo` view is returned by the module-level `schedules.list/get`.
209209

210-
`AgentScheduleClient` (alias `ScheduleClient`; `conductor.client.ai`) and
211-
`OrkesClients.get_agent_schedule_client()` are **deprecated** delegation shims,
212-
kept for backward compatibility and planned for removal in the next major release.
213-
214210
Errors: `ScheduleError`, `ScheduleNameConflict`, `ScheduleNotFound`,
215211
`InvalidCronExpression`.
216212

@@ -288,7 +284,7 @@ The control-plane client (formerly `AgentHttpClient`, alias kept). Reach it via
288284
| `stop` | `(execution_id) -> None` | |
289285
| `signal` | `(execution_id, message) -> None` | |
290286
| `stream_sse` | `(execution_id) -> AsyncIterator[dict]` | |
291-
| `schedules` (property) | `-> AgentScheduleClient` | |
287+
| `schedules` (property) | `-> SchedulerClient` | |
292288
| `close` | `() -> None` (async) | |
293289

294290
Lower-level endpoint methods (`start_agent`, `deploy_agent`, `compile_agent`) are also

0 commit comments

Comments
 (0)