Skip to content

docs(api): add V3/V4 to V5 migration guide - #1691

Open
sohamd22 wants to merge 7 commits into
api-v5-docs/versioned-referencefrom
api-v5-docs/migration-guide
Open

sohamd22 wants to merge 7 commits into
api-v5-docs/versioned-referencefrom
api-v5-docs/migration-guide

Conversation

@sohamd22

Copy link
Copy Markdown
Contributor

Document every migrated workflow, request and response change, typed-filter conversion, verification strategy, and rollout step so agents can upgrade integrations deterministically.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
supermemory-mcp b114063 Sep 30 2026, 01:28 AM

Copy link
Copy Markdown
Contributor Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add the label Main to this PR to add it to the merge queue.

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Sep 20, 2026 •

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
supermemory-app b114063 Commit Preview URL

Branch Preview URL
Sep 30 2026, 01:28 AM

## Stack context

This is the second PR in the V5 documentation stack, on top of the versioned API reference.

## What and why

Add an agent-oriented V3/V4 to V5 migration guide covering document ingestion and updates, content management, search, profiles, forgetting, namespaces, organization settings, typed filters, and rollout verification. Shared snippets keep the comprehensive guide and focused topic pages consistent.

```mermaid
flowchart LR
  Legacy[Legacy integration inventory] --> Mapping[Domain migration guidance]
  Mapping --> V5[V5 requests and response readers]
  V5 --> Verify[Side-by-side verification and rollout]
```

## Validation

- Verified all 11 migration navigation entries resolve to authored pages.
- Verified all imports across 23 migration and snippet files resolve.
- `git diff --check` passed.
- Mintlify build validation passed against the local generated V5 OpenAPI snapshot.

## Impact

Documentation only. The guide explicitly covers changed defaults, removed operations, partial failures, namespace isolation, and rollback-oriented side-by-side testing.
@sohamd22
sohamd22 force-pushed the api-v5-docs/versioned-reference branch from 91bf709 to f55fe00 Compare September 20, 2026 04:50
@sohamd22
sohamd22 force-pushed the api-v5-docs/migration-guide branch from bbdb77a to e473367 Compare September 20, 2026 04:50
@sohamd22
sohamd22 marked this pull request as ready for review September 20, 2026 04:50
MaheshtheDev and others added 5 commits September 28, 2026 19:29
…nto api-v5-docs/migration-guide

# Conflicts:
#	apps/docs/docs.json
- New "SDKs, tools and the CLI" section: TypeScript SDK is v5 from
  5.0.0-rc.5 (earlier RCs still v3/v4), Python SDK and @supermemory/tools
  still on v3/v4, CLI and `supermemory local` unaffected; v4 -> v5 SDK
  call map and dropped methods, linking the SDK's MIGRATION.md
- Link /v5/reference and /reference to api.supermemory.ai
- List conversation ingestion and container-tag merges as having no v5
  replacement

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…tion-guide

# Conflicts:
#	apps/docs/docs.json

This branch has not been deployed

No deployments
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.

3 participants