Skip to content

Document RDI API v1 deprecation and migration#3668

Open
ZdravkoDonev-redis wants to merge 10 commits into
mainfrom
RDSC-5718-rdi-api-v1-deprecation
Open

Document RDI API v1 deprecation and migration#3668
ZdravkoDonev-redis wants to merge 10 commits into
mainfrom
RDSC-5718-rdi-api-v1-deprecation

Conversation

@ZdravkoDonev-redis

@ZdravkoDonev-redis ZdravkoDonev-redis commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

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 curl examples). The Reference index, 1.19.0 release notes, and OpenAPI info.description (shown in Redoc) now surface the same deprecation message and link to the migration guide; api-reference.md documents 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.

@stoyanr stoyanr left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bot made a mess of this one :-(

Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/_index.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md
Comment thread content/integrate/redis-data-integration/reference/api-migration.md
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-reference.md Outdated
Comment thread content/integrate/redis-data-integration/release-notes/rdi-1-19-0.md Outdated

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.

Fix All in Cursor

❌ 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.

Comment thread content/integrate/redis-data-integration/reference/api-migration.md
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
@andy-stark-redis

Copy link
Copy Markdown
Contributor

@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 openapi.json to render the note correctly and also made a corresponding change in a PR on the RDI repo.

@andy-stark-redis andy-stark-redis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Comment thread content/integrate/redis-data-integration/reference/api-migration.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants