Skip to content

refactor(api): rename POST /room/document → POST /room/summary (#735)#739

Merged
ajianaz merged 2 commits into
developfrom
fix/rename-room-document-to-room-summary
Jul 17, 2026
Merged

refactor(api): rename POST /room/document → POST /room/summary (#735)#739
ajianaz merged 2 commits into
developfrom
fix/rename-room-document-to-room-summary

Conversation

@ajianaz

@ajianaz ajianaz commented Jul 17, 2026

Copy link
Copy Markdown
Collaborator

Summary

Renames POST /room/document (room summary document generation) to POST /room/summary to eliminate route naming confusion with the room↔document junction endpoints.

Changes

Server (uteke-server)

  • POST /room/summary — new primary endpoint (generates structured document from room)
  • POST /room/documentdeprecated alias, still works but logs warn! with deprecation notice
  • room_document()room_summary_document() called by new handler

Core (uteke-core)

  • MemoryStore::room_document()MemoryStore::room_summary_document()
  • Uteke::room_document()Uteke::room_summary_document() (public API wrapper)
  • SQL table room_documents unchanged (not a route rename)
  • All 3 tests updated to use new function name

CLI (uteke-cli)

  • uteke room document <id> command unchanged (still works)
  • Help text updated to note new API route
  • Uses room_summary_document() internally

MCP (uteke-mcp)

  • uteke_room_document tool updated to call room_summary_document()

Docs

  • cli-reference.md — route table updated
  • docker.md — endpoint reference updated
  • mcp.md — MCP tool reference updated
  • rooms.md — usage example updated with note

NOT Changed

  • /room/document/add, /room/document/list, /room/document/remove — junction routes unchanged
  • /doc/room/list, /doc/mem-refs, /memory/doc-refs — cross-reference routes unchanged
  • SQL table name room_documents — unchanged
  • CLI subcommand name room document — unchanged

Migration

  • Existing consumers hitting POST /room/document continue to work (deprecated alias)
  • New consumers should use POST /room/summary
  • Deprecation log: DEPRECATED: POST /room/document is renamed to POST /room/summary (see #735)

Closes #735

BREAKING: The room summary document endpoint is renamed from POST /room/document
to POST /room/summary to eliminate confusion with the room↔document junction
routes (/room/document/add, /room/document/list, /room/document/remove).

Changes:
- Server: POST /room/summary is the new primary endpoint
- Server: POST /room/document retained as deprecated alias with warn! log
- Core: room_document() → room_summary_document() across all crates
- CLI: 'uteke room document' command unchanged (help text updated)
- MCP: uteke_room_document tool updated to use new function
- Docs: cli-reference, docker, mcp, rooms updated

Closes #735
@ajianaz ajianaz self-assigned this Jul 17, 2026
@github-actions

github-actions Bot commented Jul 17, 2026

Copy link
Copy Markdown

🔍 Cora AI Code Review

Blocked — critical issues found.

🔴 Error (1)

  • crates/uteke-server/src/handlers.rs:60 — The path allowlist replaced /room/document with /room/summary-document ("/room/document" -> "/room/summary-document"). However, the deprecated handler (Method::Post, "/room/document") is still kept below for backward compatibility (with a warn! log). If this allowlist is used to gate requests (e.g., CORS preflight allow list or method dispatch filter), then clients still calling the old POST /room/document endpoint will be rejected before reaching the deprecated handler, silently breaking backward compatibility. The deprecated route is effectively dead code. Verify how the allowlist is consumed; if it gates routing, /room/document must remain in the list during the deprecation window.

Review powered by cora-cli · BYOK · MIT

…om/summary

Clippy caught unreachable pattern: POST /room/summary already used by
room_summary() (tag clustering). Renamed to POST /room/summary-document
to eliminate ambiguity with both junction routes AND the clustering endpoint.

Refs #735
"/room/recall",
"/room/summary",
"/room/document",
"/room/summary-document",
@ajianaz
ajianaz merged commit fbafa27 into develop Jul 17, 2026
8 of 9 checks passed
@ajianaz
ajianaz deleted the fix/rename-room-document-to-room-summary branch July 17, 2026 23:51
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.

refactor(api): rename POST /room/document to POST /room/summary to avoid junction route confusion

2 participants