Skip to content

fix: align Agent Memory docs with current API spec#3332

Merged
cmilesb merged 1 commit into
redis:DOC-6447from
atanas-andonov:fix/agent-memory-api-docs-consistency
May 15, 2026
Merged

fix: align Agent Memory docs with current API spec#3332
cmilesb merged 1 commit into
redis:DOC-6447from
atanas-andonov:fix/agent-memory-api-docs-consistency

Conversation

@atanas-andonov
Copy link
Copy Markdown

@atanas-andonov atanas-andonov commented May 15, 2026

Summary

Fixes 8 inconsistencies between the hand-written Agent Memory documentation pages and the current OpenAPI spec (verified against the Smithy-generated spec from langcache main fd8b6c2b).

Fixes in api-examples.md

# Issue Severity
1 Curl example uses /v1/caches/ instead of /v1/stores/ High — broken example
2 Store ID variable description has typo ("Store ID ID of your cache") Low
3 AddSessionEvent endpoint missing /events (/session-memory -> /session-memory/events) High — wrong endpoint
4 createdAt uses Unix ms (1778076906498) instead of ISO 8601 ("2026-05-02T18:15:06Z") per MOD-15623 High — API will reject
5 Filter table has duplicate namespace row; second should be topics Medium
6 Filter table missing memoryType filter Medium
7 createdAt filter data type listed as integer instead of string (ISO 8601) Medium

Fixes in create-service.md

# Issue Severity
8 Long-term TTL description is copy-pasted from the database selector field Medium

Test plan

  • Verify the staging links render correctly after merge into DOC-6447
  • Cross-reference all API examples against the OpenAPI spec

Made with Cursor


Note

Low Risk
Low risk documentation-only updates, but they correct previously broken endpoints and payload formats that could mislead users if incorrect.

Overview
Aligns api-examples.md with the current Agent Memory API by fixing the base path (/v1/stores), correcting the session event endpoint to /session-memory/events, updating createdAt examples/filters to ISO-8601 strings, and fixing/expanding the long-term memory search filter table (adds topics and memoryType, removes duplicate row).

Clarifies create-service.md by correcting the Long-term TTL description to describe long-term memory retention rather than unrelated database selection text.

Reviewed by Cursor Bugbot for commit f32e3ab. Bugbot is set up for automated code reviews on this repo. Configure here.

Fix 8 inconsistencies between the hand-written documentation and the
Agent Memory OpenAPI spec (MemoryDataPlaneServer):

api-examples.md:
- Fix curl path: /v1/caches/ -> /v1/stores/ (wrong path segment)
- Fix Store ID description typo ("Store ID ID of your cache")
- Fix AddSessionEvent endpoint: /session-memory -> /session-memory/events
- Fix createdAt format: Unix ms -> ISO 8601 date-time (per MOD-15623)
- Fix duplicate namespace row in filter table (second should be topics)
- Add missing memoryType filter to the table
- Fix createdAt filter data type: integer -> string (ISO 8601)

create-service.md:
- Fix Long-term TTL description (was copy-pasted from database selector)

Verified against the Smithy-generated OpenAPI spec from langcache main
(commit fd8b6c2b).

Co-authored-by: Cursor <cursoragent@cursor.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented May 15, 2026

CLA assistant check
All committers have signed the CLA.

Copy link
Copy Markdown
Contributor

@cmilesb cmilesb left a comment

Choose a reason for hiding this comment

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

Thanks for your help!

@cmilesb cmilesb merged commit c94b578 into redis:DOC-6447 May 15, 2026
4 of 5 checks passed
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