Document RDI API v1 deprecation and migration#3668
Conversation
stoyanr
left a comment
There was a problem hiding this comment.
The bot made a mess of this one :-(
…ocs into RDSC-5718-rdi-api-v1-deprecation
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit d2d462e. Configure here.
|
@ZdravkoDonev-redis The note you originally added to the API reference Markdown won't be visible (this page uses a special layout to render the reference). I've added a change to |
andy-stark-redis
left a comment
There was a problem hiding this comment.
I'd recommend the suggested changes before merging (I can commit these myself if you're happy with them), but they're easy enough to add - I'll approve to avoid delays.

Note
Low Risk
Documentation-only changes with no runtime or API behavior impact.
Overview
Documents RDI API v1 deprecation as of RDI 1.19.0 and steers integrators toward API v2.
Adds a dedicated API migration page with v1→v2 endpoint mapping, notes on v1-only endpoints (login, templates, etc.), and guidance to replace action-ID polling with pipeline-scoped status polling (including
curlexamples). The Reference index, 1.19.0 release notes, and OpenAPIinfo.description(shown in Redoc) now surface the same deprecation message and link to the migration guide;api-reference.mddocuments that Redoc ignores the markdown body so the notice lives in the spec.Reviewed by Cursor Bugbot for commit fc7e1d5. Bugbot is set up for automated code reviews on this repo. Configure here.