Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/api/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The server exposes three routes:
taskito scaler --app myapp:queue --port 9091 --target-queue-depth 5
```

See the [KEDA Integration guide](../guide/keda.md) for Kubernetes deploy templates.
See the [KEDA Integration guide](../guide/operations/keda.md) for Kubernetes deploy templates.

## Error Messages

Expand Down
13 changes: 13 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# API Reference

Complete Python API reference for all public classes and methods.

| Class | Description |
|-------|-------------|
| [Queue](queue/index.md) | Central orchestrator — task registration, enqueue, workers, and all queue operations |
| [TaskWrapper](task.md) | Handle returned by `@queue.task()` — `delay()`, `apply_async()`, `map()`, signatures |
| [JobResult](result.md) | Handle for an enqueued job — status polling, result retrieval, dependencies |
| [JobContext](context.md) | Runtime context inside a running task — job ID, retry count, progress updates |
| [Canvas](canvas.md) | Workflow primitives — `Signature`, `chain`, `group`, `chord` |
| [Testing](testing.md) | Test mode, `TestResult`, `MockResource` for unit testing tasks |
| [CLI](cli.md) | `taskito` command-line interface — `worker`, `info`, `scaler` |
Loading
Loading