Skip to content

Remove SDK discovery wrappers and document direct discovery#1453

Draft
guibeira wants to merge 13 commits intomainfrom
remove-wrappers-from-sdks
Draft

Remove SDK discovery wrappers and document direct discovery#1453
guibeira wants to merge 13 commits intomainfrom
remove-wrappers-from-sdks

Conversation

@guibeira
Copy link
Copy Markdown
Contributor

Summary

  • finish the wrapper-removal follow-through by cleaning up remaining SDK caller, example, and website references
  • add a dedicated discovery migration guide and move the API-reference guide link into the docs generator so regenerated pages keep it
  • align the branch with active CI lint gates, including stable Rust formatting, the Rust SDK doctest clippy fix, and lockfile syncs

Why

  • the SDK wrapper methods were removed, but some examples, tests, and docs still used the old wrapper-shaped naming or referenced generated docs manually
  • the API reference pages are generated artifacts, so manual edits there would have been overwritten on the next docs generation run
  • after rebasing onto main, the active CI format/lint checks still needed local cleanup to pass cleanly

Impact

  • discovery examples and consumer-facing docs now consistently show direct trigger() / register_trigger() usage
  • generated SDK API references no longer expose the removed wrapper methods and now point readers at the new migration guide
  • the branch passes the active local CI lint/type/format checks before review

Validation

  • cargo +stable fmt --all -- --check
  • cargo +stable fmt -p iii-sdk -- --check
  • cargo +stable clippy -p iii-sdk --all-targets --all-features -- -D warnings
  • cd sdk/packages/python/iii && uv run ruff check src && uv run mypy src
  • cd frameworks/motia/motia-py/packages/motia && uv run ruff check src && uv run mypy src
  • pnpm --filter console-frontend lint
  • bash scripts/generate-api-docs.sh
  • pnpm --filter iii-browser-sdk docs:json && pnpm tsx docs/scripts/generate-api-docs.mts

Note

  • Rust API doc regeneration is still partially blocked in this environment because the rustdoc JSON step did not produce target/doc/iii_sdk.json, so the Rust API reference callout was synced manually to match the generated pages.

guibeira added 11 commits April 10, 2026 15:43
Deletes five wrapper methods from the Node SDK. Developers should now
call iii.trigger() directly against the engine system functions
(engine::functions::list, engine::workers::list, engine::triggers::list,
engine::trigger-types::list) or compose register_function +
register_trigger on type engine::functions-available for subscriptions.

Also re-exports EngineFunctions, EngineTriggers, FunctionInfo, and
WorkerInfo from the package root so consumers have type-safe identifiers
and result types after the wrappers are gone.
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 10, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
iii 🟢 Ready View Preview Apr 10, 2026, 7:13 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@vercel
Copy link
Copy Markdown
Contributor

vercel bot commented Apr 10, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
iii-website Ready Ready Preview, Comment Apr 10, 2026 7:55pm
motia-docs Ready Ready Preview, Comment Apr 10, 2026 7:55pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 10, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: c6fd68de-aba6-482d-a433-0b3b9dd020f2

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch remove-wrappers-from-sdks

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@guibeira guibeira changed the title [codex] remove SDK discovery wrappers and document direct discovery Remove SDK discovery wrappers and document direct discovery Apr 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant