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
39 changes: 39 additions & 0 deletions DOC_AUDIT_IGNORE.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,3 +197,42 @@ download: third-party calls `nltk.download(...)` / `spacy download` in docs/sear
is_function_call: LiveKit's RunResult test-framework API (`result.expect.next_event().is_function_call(...)`) shown in docs/livekit_comparison.md for contrast — external framework
next_event: LiveKit's RunResult test-framework API shown in docs/livekit_comparison.md for contrast — external framework
register_function: Pipecat's `llm.register_function()` shown in docs/pipecat_comparison.md feature-comparison table for contrast — external framework

## Tutorial series (tutorial/) — teaching apps built with third-party libs + user helpers

# The tutorial/multi_agents lessons and tutorial/fred walk a developer through
# building a full application: they call asyncio/aiohttp/asyncpg/redis APIs and
# domain helpers the *user* writes (order flow, customer DB), none of which are
# SignalWire SDK symbols. Grouped here so DOC-AUDIT stays exact on the real SDK
# surface without flagging tutorial application code.

# asyncio / aiohttp / asyncpg / redis (third-party runtime the tutorials use)
ClientSession: aiohttp.ClientSession — third-party HTTP client used in tutorial/multi_agents lessons
gather: asyncio.gather — stdlib coroutine aggregation in tutorial/multi_agents/lesson4
create_task: asyncio.create_task — stdlib task scheduling in tutorial/multi_agents lessons
acquire: asyncpg pool.acquire() connection checkout in tutorial/multi_agents/lesson5
fetch: asyncpg connection.fetch() query in tutorial/multi_agents/lesson5
create_pool: asyncpg.create_pool — third-party DB pool in tutorial/multi_agents/lesson5
create_redis_pool: aioredis pool constructor in tutorial/multi_agents/lesson5
lpop: redis LPOP command in tutorial/multi_agents/lesson5
rpush: redis RPUSH command in tutorial/multi_agents/lesson5
sub: re.sub / string helper in tutorial/multi_agents/lesson4 — not an SDK method

# user-defined application helpers the tutorials teach the reader to implement
_configure_prompt: user-defined helper shown in tutorial/multi_agents/lesson3
_expire_cache: user-defined helper shown in tutorial/multi_agents/lesson4
add_data: user-defined helper shown in tutorial/multi_agents/lesson4
add_task: user-defined helper shown in tutorial/multi_agents/lesson5
get_customer_status: user-defined helper shown in tutorial/multi_agents/lesson5
get_item_price: user-defined helper shown in tutorial/multi_agents/lesson5 (order-flow example)
get_or_create: user-defined helper shown in tutorial/multi_agents/lesson5
handle_task: user-defined helper shown in tutorial/multi_agents/lesson5
notify_customer: user-defined helper shown in tutorial/multi_agents/lesson5
process_queue: user-defined helper shown in tutorial/multi_agents/lesson5
set_persona: user-defined helper shown in tutorial/multi_agents/lesson5
submit_order: user-defined helper shown in tutorial/multi_agents/lesson5 (order-flow example)
update_order_status: user-defined helper shown in tutorial/multi_agents/lesson5

# stdlib
rstrip: str.rstrip — stdlib string method (tutorial lesson3 + skills/swml_transfer/README.md prose)
urlopen: urllib.request.urlopen — stdlib HTTP call in tutorial/fred/tutorial/appendix-docker-deployment.md
1,227 changes: 0 additions & 1,227 deletions FIXES.md

This file was deleted.

2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ from signalwire.rest import RestClient
client = RestClient(project="...", token="...", host="example.signalwire.com")

client.fabric.ai_agents.create(name="Support Bot", prompt={"text": "You are helpful."})
client.calling.play(call_id, play=[{"type": "tts", "text": "Hello!"}])
client.calling.play(call_id, play=[{"type": "tts", "params": {"text": "Hello!"}}])
client.phone_numbers.search(areacode="512")
client.datasphere.documents.search(query_string="billing policy")
```
Expand Down
20 changes: 20 additions & 0 deletions ROOT_HYGIENE_ALLOW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# ROOT_HYGIENE_ALLOW.md

Repo-root files excused from the `root_hygiene` gate. Each is a LOAD-BEARING
gate-config / allowlist file that porting-sdk audit scripts (and this port's own
`scripts/run-ci.sh`) read at the repo root by relative path. Moving them under
`eng/` would break the shared audit pipeline, which this port cannot edit.

Format: `- <path> — <reason> (<approver>, <date>)`. Paths match the reported
offender verbatim.

## Gate allowlist / config files (each read by its gate at repo root)

- ROOT_HYGIENE_ALLOW.md — this allowlist itself; the root_hygiene gate reads it at repo root (mike@signalwire.com, 2026-07-15)
- DOC_AUDIT_IGNORE.md — required audit-contract file read by porting-sdk audit_docs.py (DOC-AUDIT) at repo root (mike@signalwire.com, 2026-07-15)
- ACCESSOR_TRUTH_ALLOW.md — allowlist read by porting-sdk accessor_truth.py (ACCESSOR-TRUTH) at repo root (mike@signalwire.com, 2026-07-15)
- DOC_CLI_ALLOW.md — allowlist read by porting-sdk doc_cli.py (DOC-CLI) at repo root (mike@signalwire.com, 2026-07-15)
- EXAMPLES_RUN_ALLOW.md — allowlist read by porting-sdk examples_run.py (EXAMPLES-RUN) at repo root (mike@signalwire.com, 2026-07-15)
- REST_COVERAGE_GAPS.md — required audit-contract file read by porting-sdk rest_coverage (REST-COVERAGE) at repo root (mike@signalwire.com, 2026-07-15)
- ROUTE_COLLISION_ALLOW.md — allowlist read by porting-sdk route_collision.py (ROUTE-COLLISION) at repo root (mike@signalwire.com, 2026-07-15)
- SNIPPET_RUN_ALLOW.md — allowlist read by porting-sdk snippet_run.py (SNIPPET-RUN) at repo root (mike@signalwire.com, 2026-07-15)
File renamed without changes.
2 changes: 1 addition & 1 deletion examples/quickstart_rest.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
client = RestClient(project="...", token="...", host="example.signalwire.com")

client.fabric.ai_agents.create(name="Support Bot", prompt={"text": "You are helpful."})
client.calling.play(call_id, play=[{"type": "tts", "text": "Hello!"}])
client.calling.play(call_id, play=[{"type": "tts", "params": {"text": "Hello!"}}])
client.phone_numbers.search(areacode="512")
client.datasphere.documents.search(query_string="billing policy")
# endregion: rest
145 changes: 0 additions & 145 deletions formatted_version.md

This file was deleted.

69 changes: 0 additions & 69 deletions livewire/livewire/README.md

This file was deleted.

Loading