mirror of
https://github.com/supermemoryai/supermemory.git
synced 2026-10-11 03:37:56 +00:00
e47336737e
## 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.
57 lines
1.8 KiB
Text
57 lines
1.8 KiB
Text
V5 exposes only the organization-wide context needed to guide memory formation. Internal controls and profile bucket mutation are no longer part of this settings resource.
|
|
|
|
### Endpoint mapping
|
|
|
|
| Legacy | V5 |
|
|
| --- | --- |
|
|
| `GET /v3/settings` | `GET /organization` |
|
|
| `PATCH /v3/settings` | `PATCH /organization` |
|
|
| `filterPrompt` | `organizationalContext` |
|
|
|
|
### Read organization settings
|
|
|
|
```bash
|
|
GET /organization
|
|
```
|
|
|
|
```json
|
|
{
|
|
"organizationalContext": "Acme builds security tools for enterprises",
|
|
"namespaceCount": 42
|
|
}
|
|
```
|
|
|
|
Remove readers for legacy settings that are not present in this allowlisted response. `namespaceCount` is informational and cannot be changed through PATCH.
|
|
|
|
### Update organization context
|
|
|
|
<CodeGroup>
|
|
```bash Legacy
|
|
PATCH /v3/settings
|
|
{"filterPrompt":"Acme builds security tools for enterprises"}
|
|
```
|
|
|
|
```bash V5
|
|
PATCH /organization
|
|
{"organizationalContext":"Acme builds security tools for enterprises"}
|
|
```
|
|
</CodeGroup>
|
|
|
|
The field is exhaustive: the supplied value replaces the existing context. Send `null` to remove it. Empty strings are rejected.
|
|
|
|
Organization updates require an organization administrator. Do not silently fall back to namespace context when the caller receives `403`.
|
|
|
|
### Removed public operations
|
|
|
|
- Organization profile-bucket mutation is not exposed through organization settings.
|
|
- Bucket suggestion is not part of V5.
|
|
- Organization data reset is not part of V5.
|
|
- Namespace-owned profile buckets are managed through `/ns/{namespace}/profile/buckets`.
|
|
|
|
### Verification
|
|
|
|
- Compare the V5 context with the legacy `filterPrompt` before cutover.
|
|
- Set, replace, and clear organizational context.
|
|
- Confirm `namespaceCount` agrees with `GET /namespaces` for the same credentials.
|
|
- Verify non-admin callers receive `403` on PATCH.
|
|
- Confirm removed fields are not required by downstream configuration code.
|