[PR #178] docs: document Router modelProvider / strictMode / fallbackProvider #178

Open
opened 2026-10-31 22:05:22 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/178
Author: @deepme987
Created: 9/22/2026
Status: 🔄 Open

Base: main ← Head: deepme987/docs/router-params


📝 Commits (4)

  • 76dbf6e docs: document router model_provider / strict_mode / fallback_provider on model run
  • e29fe0a test(parity): recognize RouterRunResult as a result type in the python surface extractor
  • 27061c5 test(parity): reconcile queue-tier and root error surfaces with Python main
  • cdbe40f test(parity): document run_detailed as a deliberate TS omission

📊 Changes

4 files changed (+152 additions, -34 deletions)

View changed files

📝 README.md (+15 -1)
📝 parity/python-surface.json (+14 -3)
📝 scripts/python-surface.mjs (+66 -13)
📝 src/sdk/surface-parity.test.ts (+57 -17)

📄 Description

Documents the alternate-provider run options (modelProvider / strictMode / fallbackProvider) on comfy.models.run, added in #150 but not yet surfaced in the README. Docs-only; no code or behavior changes.

Summary by CodeRabbit

  • New Features

    • Added support for detailed model run results in the Python SDK.
    • Added clearer handling for cancelled requests, queue timeouts, and missing requests.
  • Documentation

    • Expanded guidance for selecting model providers.
    • Documented options for strict provider routing and fallback behavior.
    • Clarified the difference between translated native schemas and raw provider payloads.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-typescript-sdk/pull/178 **Author:** [@deepme987](https://github.com/deepme987) **Created:** 9/22/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `deepme987/docs/router-params` --- ### 📝 Commits (4) - [`76dbf6e`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/76dbf6edbb0dd49d41476683928ff09b0d23066e) docs: document router model_provider / strict_mode / fallback_provider on model run - [`e29fe0a`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/e29fe0aff8724d51524d5f3b841eb45b2a686a86) test(parity): recognize RouterRunResult as a result type in the python surface extractor - [`27061c5`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/27061c5a4f147d0eedeca7a89d87280970b95b6c) test(parity): reconcile queue-tier and root error surfaces with Python main - [`cdbe40f`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/cdbe40f9b7700d9cc8bf8314143c092bd3b6df07) test(parity): document run_detailed as a deliberate TS omission ### 📊 Changes **4 files changed** (+152 additions, -34 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+15 -1) 📝 `parity/python-surface.json` (+14 -3) 📝 `scripts/python-surface.mjs` (+66 -13) 📝 `src/sdk/surface-parity.test.ts` (+57 -17) </details> ### 📄 Description Documents the alternate-provider run options (`modelProvider` / `strictMode` / `fallbackProvider`) on `comfy.models.run`, added in #150 but not yet surfaced in the README. Docs-only; no code or behavior changes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added support for detailed model run results in the Python SDK. * Added clearer handling for cancelled requests, queue timeouts, and missing requests. * **Documentation** * Expanded guidance for selecting model providers. * Documented options for strict provider routing and fallback behavior. * Clarified the difference between translated native schemas and raw provider payloads. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Comfy-Org/comfy-typescript-sdk#178
No description provided.