Skip to content

docs: replace Appsmith AI reference with migration guide (deprecated Sept 30, 2026) - #3025

Open
salevine wants to merge 2 commits into
mainfrom
docs/appsmith-ai-migration-guide
Open

docs: replace Appsmith AI reference with migration guide (deprecated Sept 30, 2026)#3025
salevine wants to merge 2 commits into
mainfrom
docs/appsmith-ai-migration-guide

Conversation

@salevine

Copy link
Copy Markdown
Contributor

Description

Provide a concise summary of the changes made in this pull request

  • Replace the Appsmith AI reference page (/connect-data/reference/appsmith-ai) with a Migrate from Appsmith AI guide at the same URL. Appsmith AI is deprecated and stops working on September 30, 2026; new datasource creation is blocked by feat: block new Appsmith AI datasource creation and show deprecation banner appsmith#42015, and the in-product deprecation banner links to this URL.
  • The guide covers: a deprecation notice with the shutdown date, command-by-command mapping of all seven Appsmith AI commands to the OpenAI / Anthropic / Google AI datasources (BYOK), prompt examples for the wrapped commands (summarise/classify/extract), re-binding widgets to new response shapes, and alternatives for file context, which has no drop-in replacement after shutdown.
  • Keeping the same URL means no redirect rules are needed and the shipped in-product link resolves to migration guidance.

Pull request type

Check the appropriate box:

Documentation tickets

Link to one or more documentation tickets:

Checklist

From the below options, select the ones that are applicable:

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

🤖 Generated with Claude Code

https://claude.ai/code/session_01WfztenqynzJcU2DZJD6nR5

… Sept 30, 2026)

Appsmith AI is deprecated; new datasource creation is blocked as of
appsmithorg/appsmith#42015. Replace the reference page with a migration
guide at the same URL (the in-product deprecation banner already links
here): command-by-command mapping to OpenAI/Anthropic/Google AI with
your own API key, plus alternatives for file context, which has no
drop-in replacement after shutdown.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WfztenqynzJcU2DZJD6nR5
@vercel

vercel Bot commented Jul 20, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
appsmith-docs Ready Ready Preview, Comment Jul 21, 2026 2:00pm

Request Review

…lso blocked

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WfztenqynzJcU2DZJD6nR5
salevine added a commit to appsmithorg/appsmith that referenced this pull request Jul 28, 2026
…banner (#42015)

## Description

**TL;DR:** First shipping step of the Appsmith AI deprecation (release
2.3): users can no longer create new Appsmith AI (`appsmithai-plugin`)
datasources **or new queries against existing ones** — the tile is
hidden in the create-new flow, query-creation affordances are hidden,
and the API rejects both with a clear 400 — while existing Appsmith AI
datasources and queries keep working and now show a deprecation banner
with the shutdown date (September 30, 2026) and BYOK migration guidance.

Appsmith pays for LLM tokens behind the managed Appsmith AI plugin
(proxied through Cloud Services with Appsmith-owned credentials). Per
the deprecation plan, 2.3 blocks new adoption and tells existing users
to migrate to the OpenAI / Anthropic / Google AI datasources with their
own API keys. Managed credentials are revoked ~60 days after GA as the
hard stop.

**Server**
- New `DEPRECATED_DATASOURCE_PLUGIN` error (400, `AE-DTS-4031`) with an
actionable message naming the BYOK alternatives.
- `DatasourceServiceCEImpl.create()` rejects brand-new datasources whose
plugin package is in `getDeprecatedPluginPackageNames()` — a `protected`
method (CE = `appsmithai-plugin`) so the EE repo can extend the
blocklist with `appsmith-agent-plugin` without CE changes.
- The previous `create()` body moved to a new
`createWithoutDeprecationCheck()`; the fork service now uses it.
- Storage-saves for existing datasources (id present) bypass the guard —
existing Appsmith AI datasources remain fully editable/executable until
shutdown.

**Client**
- Appsmith AI filtered out of the "AI Integrations" create-new list
(`AIPlugins.tsx`); OpenAI / Anthropic / Google AI remain.
- New `AppsmithAIDeprecationCallout` (ADS `Callout`, warning,
non-dismissible, "Learn how to migrate" docs link) mounted on the
datasource editor (view + edit) and on the Appsmith AI query editor.
Copy explicitly calls out that uploaded files (file context) will not be
available after the shutdown date.

**Explicit decisions (per product direction)**
- **Import and fork intentionally bypass the guard.** Importing or
forking apps that already contain an Appsmith AI datasource must keep
working; the T+60 credential revoke is the hard stop for non-migrated
usage. (Import uses `createWithoutPermissions`, which never routed
through `create()`; fork uses `createWithoutDeprecationCheck`.)
- **No feature flag.** The deprecation is unconditional and
restrictive-only; rollback is a clean revert (no data migration).
- **Appsmith AI query creation is now also blocked** (originally
deferred to a later phase, pulled in per product direction). Server:
`DEPRECATED_PLUGIN_QUERY_CREATION` (400, `AE-DTS-4032`) from a guard in
`LayoutActionServiceCEImpl.createSingleAction`, running after
page-permission resolution; saved datasources are resolved with a
permission-scoped read, and embedded (id-less) payloads are checked by
`pluginId` so a crafted payload can't bypass the block. The
`createAction(dto, meta)` overload used by clone/fork/import is
intentionally unguarded so existing Appsmith AI queries survive those
flows (pinned by test). Client: Appsmith AI datasources are filtered
from all query-creation lists (omnibar, query add pane, explorer files)
and the New query button is hidden on the datasource page and card.
- **Copy/Duplicate of an existing Appsmith AI query now fails with the
same 400** — a copy is a new query. The context-menu items remain
visible; hiding them is a possible follow-up if product prefers.
- **Accepted risks** (deprecation gate, not a security boundary; the
T+60 credential revoke is the real control): re-pointing an existing
query to an Appsmith AI datasource via action *update* is not blocked
(blocking updates would break editing existing AI queries); JS actions
skip the guard (they never execute against the AI plugin).

**Follow-ups tracked**
- EE companion PR: override `getDeprecatedPluginPackageNames()` to add
`appsmith-agent-plugin`; EE banners for Agent/RAG surfaces.
- ~~Docs: publish the BYOK migration guide and repoint
`DocsLink.APPSMITH_AI_DEPRECATION`.~~ Done:
appsmithorg/appsmith-docs#3025 replaces the Appsmith AI reference page
with the migration guide at the same URL, so no repoint is needed —
merge that PR before or with this one.
- Optional analytics on `DEPRECATED_DATASOURCE_PLUGIN` rejections to
measure migration ahead of the kill date.

**Tests**
- Server (`DatasourceServiceTest`): create with `appsmithai-plugin`
rejected; `createWithoutDeprecationCheck` succeeds (fork path);
existing-datasource storage-save allowed. All 3 green locally with
CI-equivalent env.
- Server (`ActionServiceCE_Test`): new query on a saved Appsmith AI
datasource rejected; embedded (id-less) Appsmith AI datasource payload
rejected; clone-context creation on an Appsmith AI datasource succeeds.
Green locally, plus `CurlImporterServiceTest` (32) and
`CreateDBTablePageSolutionTests` (17) as regression checks on the
guarded path.
- Client (jest): callout renders message/kill date/link and opens the
right doc on click; create-list filter hides Appsmith AI but keeps other
AI plugins; query-creation file operations exclude Appsmith AI
datasources (and omit "Create a query" when only AI datasources exist).
`yarn check-types` and ESLint clean.

Fixes
https://linear.app/appsmith/issue/APP-15696/disable-appsmith-ai-datasource-breaking-change

## Automation

/ok-to-test tags="@tag.All"

### 🔍 Cypress test results
<!-- This is an auto-generated comment: Cypress test results  -->
> [!TIP]
> 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉
> Workflow run:
<https://github.com/appsmithorg/appsmith/actions/runs/29837761810>
> Commit: ac8c527
> <a
href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=29837761810&attempt=1"
target="_blank">Cypress dashboard</a>.
> Tags: `@tag.All`
> Spec:
> <hr>Tue, 21 Jul 2026 15:20:02 UTC
<!-- end of auto-generated comment: Cypress test results  -->


## Communication
Should the DevRel and Marketing teams inform users about this change?
- [x] Yes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

https://claude.ai/code/session_01AN5jb73MFwozkWuB4jvs6W


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
* Added an Appsmith AI deprecation callout to the datasource, plugin,
and action editors, including kill-date messaging and a “Learn more”
docs link.
* **Bug Fixes**
* Hid “create new action”/“create query” options and excluded deprecated
Appsmith AI plugins from relevant UI flows.
* Blocked query creation for deprecated-plugin datasources while
allowing existing datasources and internal clone flows to continue
working.
* **Tests**
* Added UI tests for visibility rules and callout behavior, plus backend
tests for deprecated-plugin datasource and query creation handling.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
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