Skip to content

Sync published trailing-delete description from docs-site - #1160

Merged
sweetmantech merged 2 commits into
mainfrom
claude/trailing-docs-fixture
Oct 25, 2026
Merged

sweetmantech merged 2 commits into
mainfrom
claude/trailing-docs-fixture

Conversation

@sweetmantech

@sweetmantech sweetmantech commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

Fixture-only companion to docs-site#5 (tracker: app#2352).

Review feedback on docs-site#5: operation descriptions should be at most 4 sentences, ideally 2-3. The DELETE /api/chats/{id}/messages/trailing description was 13. docs-site#5 rewrites it to three:

Delete a message in a Workflow chat and every message after it, ordered by created_at then id. Concurrent edit/resend is unsupported: stop other writers first, because an active workflow run returns 409. 200 means the delete ran, possibly affecting zero rows; after a transport failure, refresh the chat history instead of resending.

The dropped detail (legacy memories untouched, auth, ownership, timestamp tie-break) is still stated by the operation's parameters, security and per-status response descriptions.

lib/contracts/fixtures/published-docs.json holds a copy of the published record, so this PR updates it with python3 scripts/build-contract-examples.py --api <this checkout> from docs-site#5. The diff is two lines: chatTrailingDelete.description and the research.json source hash. No runtime code changes.

Merge order: this PR first, then docs-site#5 re-pins operation-inventory.json to this merge commit (docs-site CI checks the fixture at the pinned API commit).

Checks: pnpm exec vitest run lib/contracts → 29 files, 308 tests pass.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the published description of trailing-message deletion to clarify its ordering, behavior during active workflows, and response when no rows are affected.
    • Clarified that concurrent edits or resends are unsupported and that clients should refresh history after a transport failure rather than resend.
    • The description no longer includes some previously documented ownership, authentication, boundary, writer-state, and failure guarantees.

The docs review (docs-site#5) shortens the DELETE
/api/chats/{id}/messages/trailing operation description to three
sentences. This copies the regenerated record, so docs-site's
build-contract-examples --check matches once the inventory pins this merge.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 25, 2026 •

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api Ready Ready Preview Oct 25, 2026 11:06pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Oct 25, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 5 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration
Commits

Reviewing files that changed from the base of the PR and between 06cdac2 and 4ed7da4.

Files selected for processing: 1
  • lib/contracts/fixtures/published-docs.json

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 9b92f80 and 06cdac2.

Files selected for processing: 1
  • lib/contracts/fixtures/published-docs.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The published-docs fixture updates the recorded SHA-256 for research.json and replaces the chatTrailingDelete description with revised ordering, concurrency, response, and transport-failure details.

Changes: Published API fixture

Layer / File(s) Summary
Update the published contract fixture
lib/contracts/fixtures/published-docs.json
The chatTrailingDelete description now states that deletion is ordered by created_at and id, concurrent edit or resend is unsupported, and an active workflow run returns 409. It also notes that a successful 200 may affect zero rows and advises refreshing history after a transport failure. The fixture updates the recorded SHA-256 for research.json.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related issues

  • recoupable/mono issue 360: The fixture update is a concrete example of keeping a published API record aligned with documentation checks.
  • recoupable/mono issue 320: The PR revises the published description for DELETE /api/chats/{id}/messages/trailing.
  • recoupable/mono issue 319: The updated API-reference record is part of the published documentation workflow.

Suggested reviewers: sidneyswift

Merge Risk: Minimal · up to 06cda

This fixture-only update has no identified merge-blocking impact.

Pre-merge checks: Passed 3
Check name Status Explanation
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Solid & Clean Code Passed PASS. The pull request changes only the generated JSON fixture lib/contracts/fixtures/published-docs.json. It adds no classes, functions, control flow, abstractions, or duplicated logic. The JSON re…
Full details: Solid & Clean Code

Explanation

PASS. The pull request changes only the generated JSON fixture lib/contracts/fixtures/published-docs.json. It adds no classes, functions, control flow, abstractions, or duplicated logic. The JSON remains valid, and the changed description is a simple three-sentence data value.

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

A hash takes a refreshed place,
A contract gets a shorter face.
The sort keys set the order right,
A 409 marks workflow flight.
History refreshes after a lost reply.

Comment @coderabbitai help to get the list of available commands.

@sweetmantech
sweetmantech merged commit 1920d30 into main Oct 25, 2026
5 of 7 checks passed

This branch was successfully deployed

1 active deployment
Preview — 4ed7da4c Deployed Oct 25, 2026 by vercel[bot]
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.

1 participant