Skip to content

Conversation

@abrookins
Copy link
Collaborator

Implement the API URL restructuring as described in issue #17:

  • Add /v1/ prefix for versioning
  • Use consistent resource-oriented naming
  • Replace session-based URLs with working-memory URLs

Breaking changes:

  • GET /sessions/ → GET /v1/working-memory/
  • GET/PUT/DELETE /sessions/{id}/memory → GET/PUT/DELETE /v1/working-memory/{id}
  • POST /long-term-memory → POST /v1/long-term-memory/
  • POST /long-term-memory/search → POST /v1/long-term-memory/search
  • POST /memory/search → POST /v1/memory/search
  • POST /memory-prompt → POST /v1/memory/prompt
  • GET /health → GET /v1/health

Updated:

  • API routes in api.py and healthcheck.py
  • Client library in client/api.py
  • All tests in test_api.py
  • Documentation in docs/ and CLAUDE.md
  • Manual testing examples in manual_oauth_qa/

Closes #17

Generated with Claude Code

Implement the API URL restructuring as described in issue #17:

- Add /v1/ prefix for versioning
- Use consistent resource-oriented naming 
- Replace session-based URLs with working-memory URLs

Breaking changes:
- GET /sessions/ → GET /v1/working-memory/
- GET/PUT/DELETE /sessions/{id}/memory → GET/PUT/DELETE /v1/working-memory/{id}
- POST /long-term-memory → POST /v1/long-term-memory/
- POST /long-term-memory/search → POST /v1/long-term-memory/search
- POST /memory/search → POST /v1/memory/search
- POST /memory-prompt → POST /v1/memory/prompt
- GET /health → GET /v1/health

Updated:
- API routes in api.py and healthcheck.py
- Client library in client/api.py
- All tests in test_api.py  
- Documentation in docs/ and CLAUDE.md
- Manual testing examples in manual_oauth_qa/

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

Co-Authored-By: abrookins <abrookins@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 5, 2025 17:38
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR restructures API URLs to introduce versioning and consistent resource-oriented naming as described in issue #17. Key changes include adding a /v1/ prefix to endpoints, renaming session routes to working-memory routes, and updating related documentation and client code accordingly.

Reviewed Changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/test_api.py Updated API endpoints in tests; one URL contains duplicative segments.
manual_oauth_qa/README.md Updated curl commands to reflect new API URL structure.
docs/memory-types.md Revised HTTP example endpoints to use /v1/ prefix.
docs/authentication.md Adjusted API URLs to use /v1/working-memory/ and /v1/memory/prompt endpoints.
docs/api.md Documentation updated with new URL structure.
agent_memory_server/healthcheck.py Health endpoint changed to /v1/health.
agent_memory_server/client/api.py Updated client calls to use new endpoint paths.
agent_memory_server/api.py Updated API router decorators to use new URL structure.
CLAUDE.md Documentation reflects revised URL endpoints.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@abrookins abrookins merged commit a69add0 into main Jun 5, 2025
4 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Restructure API URLs for Better Clarity and Consistency

2 participants