Skip to content

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

Description

@ajianaz

Problem

POST /room/document generates a room summary document (sections, entries, pinned items), while the room↔document junction endpoints are separate routes (PUT /room/document/add, POST /room/document/list, DELETE /room/document/remove). This naming overlap causes confusion.

Current Routes

Route Method Purpose
/room/document POST Generate room summary document
/room/document/add PUT Link doc to room
/room/document/list POST List linked docs
/room/document/remove DELETE Unlink doc from room

Suggested Change

Rename POST /room/documentPOST /room/summary to eliminate ambiguity.

Version

v0.8.0 (#689, #692)

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions