Docs: inputs.id → restoreFromStateId migration guide#5779
Merged
akaKuruma merged 3 commits intoMay 12, 2026
Conversation
📝 WalkthroughWalkthroughThis PR adds multilingual documentation guiding users to migrate ChangesDocumentation Migration for inputs.id Deprecation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Comment |
akaKuruma
changed the title
inputs.id → restoreFromStateId migration guide
akaKuruma
changed the title
inputs.id → restoreFromStateId migration guideinputs.id → restoreFromStateId migration guide
vinibrsl
approved these changes
May 12, 2026
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/en/guides/flows/inputs-id-deprecation.mdx (1)
79-82: ⚡ Quick winClarify SDK vs REST naming to prevent copy/paste misuse
This sentence can mislead Python users into passing
restoreFromStateIdtoflow.kickoff(...). Please add an explicit note here that SDK usesrestore_from_state_idand REST payload usesrestoreFromStateId.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/en/guides/flows/inputs-id-deprecation.mdx` around lines 79 - 82, Clarify that the deprecation note refers to differing parameter names between SDK and REST to avoid copy/paste errors: explicitly state that the REST payload uses restoreFromStateId (camelCase) while the SDK method uses restore_from_state_id (snake_case), and warn Python users not to pass restoreFromStateId into flow.kickoff(...) but to use restore_from_state_id instead; reference the existing symbols inputs.id, `@persist`, restoreFromStateId, restore_from_state_id, and flow.kickoff(...) so the edit is placed alongside the deprecation paragraph.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/pt-BR/guides/flows/inputs-id-deprecation.mdx`:
- Line 53: Update the section heading text to read as a question by adding a
trailing question mark and ensure the inline code spans remain backticked;
specifically change the heading "## Por que estamos descontinuando `inputs.id`
para `@persist`" to "## Por que estamos descontinuando `inputs.id` para
`@persist`?" so it reads clearly as a PT-BR question.
---
Nitpick comments:
In `@docs/en/guides/flows/inputs-id-deprecation.mdx`:
- Around line 79-82: Clarify that the deprecation note refers to differing
parameter names between SDK and REST to avoid copy/paste errors: explicitly
state that the REST payload uses restoreFromStateId (camelCase) while the SDK
method uses restore_from_state_id (snake_case), and warn Python users not to
pass restoreFromStateId into flow.kickoff(...) but to use restore_from_state_id
instead; reference the existing symbols inputs.id, `@persist`, restoreFromStateId,
restore_from_state_id, and flow.kickoff(...) so the edit is placed alongside the
deprecation paragraph.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 337b3afa-a7ec-44b7-9ba2-7830bf64b660
📒 Files selected for processing (5)
docs/ar/guides/flows/inputs-id-deprecation.mdxdocs/docs.jsondocs/en/guides/flows/inputs-id-deprecation.mdxdocs/ko/guides/flows/inputs-id-deprecation.mdxdocs/pt-BR/guides/flows/inputs-id-deprecation.mdx
Add docs/en/guides/flows/inputs-id-deprecation.mdx covering the @persist inputs.id → restoreFromStateId migration for the SDK and the AMP REST kickoff payload. The page explains the dual role inputs.id plays today (hydration key + state.id), why that's the root cause of the AMP dashboard symptoms users see when inputs.id is reused (status flips, stacked OTel traces, collapsed executions list), and that restoreFromStateId is available in CrewAI v1.14.5+. Wire the page into all 13 version blocks under each of the 4 languages in docs.json. ar/ko/pt-BR translations will follow via devtools docs-check.
akaKuruma
force-pushed
the
tfreire/cor-170-inputs-id-to-restore-from-state-id-doc
branch
from
20ef1c5 to
c3d4187
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/ko/guides/flows/inputs-id-deprecation.mdx`:
- Around line 7-10: 문서 내에서 `inputs.id` 관련 문구들이 현재는 “지원되지 않음”으로 혼용되어 혼란을 주므로, 모든
해당 문구(`inputs.id`, `@persist` 흐름 하이드레이트 관련 표현)를 일관되게 “더 이상 권장되지 않음(deprecated) —
지금부터 사용 중단 권고, 향후 릴리스에서 제거 예정”으로 바꿔 통일하고 대체 옵션인 `restore_from_state_id`(CrewAI
v1.14.5+) 사용과 업그레이드 후 적용된다는 점을 명확히 표시하도록 변경하세요; 파일의 세 곳(현재 지적된 세트: 처음과 중간, 끝
부분)에 있는 모든 문장을 동일한 “deprecated” 타임라인 문구로 통일하고 예시나 주석 없이 간결한 교체 문구를 적용하면 됩니다.
In `@docs/pt-BR/guides/flows/inputs-id-deprecation.mdx`:
- Around line 43-47: Padronize o termo usado para a semântica de fork: na
descrição que menciona `restore_from_state_id=<uuid>` substitua “dividir” por
“criar um fork” (ou vice‑versa se preferir outro termo PT‑BR consistente) e
ajuste a frase “criar um fork” mais abaixo para usar exatamente o mesmo termo,
garantindo consistência entre ambas as ocorrências.
🪄 Autofix (Beta)
❌ Autofix failed (check again to retry)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 78dfdc03-4bf5-4dc0-9ff5-17e4494d6362
📒 Files selected for processing (5)
docs/ar/guides/flows/inputs-id-deprecation.mdxdocs/docs.jsondocs/en/guides/flows/inputs-id-deprecation.mdxdocs/ko/guides/flows/inputs-id-deprecation.mdxdocs/pt-BR/guides/flows/inputs-id-deprecation.mdx
✅ Files skipped from review due to trivial changes (1)
- docs/docs.json
|
Note Autofix is a beta feature. Expect some limitations and changes as we gather feedback and continue to improve it. Autofix skipped. No unresolved CodeRabbit review comments with fix instructions found. |
akaKuruma
deleted the
tfreire/cor-170-inputs-id-to-restore-from-state-id-doc
branch
This was referenced May 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/en/guides/flows/inputs-id-deprecation.mdxthat explains the deprecation ofinputs.idas a@persisthydration mechanism and walks users through migrating torestoreFromStateId(available in CrewAI v1.14.5 and later).docs.jsonnext tomastering-flow-statein all 13 version blocks across all 4 languages (52 nav inserts).ar,ko,pt-BRNote
Low Risk
Low risk docs-only change that adds new guide pages and updates navigation; no runtime or API behavior is modified.
Overview
Adds a new Flows migration guide explaining the deprecation of
inputs.idhydration for@persistflows and how to switch torestore_from_state_id/ AMPrestoreFromStateId(v1.14.5+), including the resume-vs-fork semantics and AMP dashboard implications.Wires the new page into
docs.jsonnavigation across all language/version blocks, and ships translated copies inar,ko, andpt-BRalongside the English source.Reviewed by Cursor Bugbot for commit c3d4187. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit