Skip to content

🚚(global) move favorite documents API endpoint to /documents/favorites/ - #2540

Merged
lunika merged 1 commit into
mainfrom
fix-api-favorite-list-endpoint
Sep 14, 2026
Merged

lunika merged 1 commit into
mainfrom
fix-api-favorite-list-endpoint

Conversation

@jmaupetit

@jmaupetit jmaupetit commented Jul 27, 2026 •

Copy link
Copy Markdown
Contributor

Purpose

Current favorite documents listing endpoint path is /documents/favorite_list/. To respect current API semantic (e.g. /documents/{id}/favorite/), we think we can make a shorter version of the endpoint path without being less explicit 😜

Proposal

  • 🚚(global) move favorite documents API endpoint to /documents/favorites/

@jmaupetit jmaupetit changed the title 🚚(global) move favorite documents API endpoint to /documents/favorites/ 🚚(global) move favorite documents API endpoint to /documents/favorites/ Jul 27, 2026
@jmaupetit jmaupetit self-assigned this Jul 27, 2026
@github-actions

github-actions Bot commented Jul 27, 2026 •

Copy link
Copy Markdown
Contributor

Size Change: 0 B

Total Size: 5.94 MB

📦 View Changed
Filename Size Change
apps/impress/out/_next/static/3385d6a2/_buildManifest.js 717 B +717 B (new file) 🆕
apps/impress/out/_next/static/a1a53899/_buildManifest.js 0 B -717 B (removed) 🏆

compressed-size-action

@jmaupetit
jmaupetit marked this pull request as ready for review July 27, 2026 16:40
@jmaupetit
jmaupetit requested a review from lunika July 27, 2026 16:40
@coderabbitai

coderabbitai Bot commented Jul 27, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 037bcfb9-41b5-4763-8bdd-8b1cb064d41d

📥 Commits

Reviewing files that changed from the base of the PR and between 20d424e and 25bea79.

📒 Files selected for processing (3)
  • CHANGELOG.md
  • src/backend/core/api/viewsets.py
  • src/frontend/apps/impress/src/features/docs/doc-management/api/useDocsFavorite.tsx

Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review.


Walkthrough

The favorite documents API route is renamed from favorite_list to favorites in the backend documentation and runtime action. Frontend requests and backend and external API tests use the new path. Existing assertions remain unchanged. The changelog records the endpoint change.

Priority: ⬇️ Low

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

Suggested reviewers: antolc

Merge Risk: ⚪ Minimal · up to 25bea

The endpoint rename is consistently applied across the service, client, and tests, with no concrete merge-blocking risk identified.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the endpoint migration from /documents/favorite_list/ to /documents/favorites/.
Description check ✅ Passed The description explains the reason for the endpoint migration and matches the changeset.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 1 functions across 2 files. (1 skipped: 1 …
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-api-favorite-list-endpoint

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

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

@lunika
lunika force-pushed the fix-api-favorite-list-endpoint branch from 20d424e to 9d2f39f Compare September 14, 2026 09:37
To respect the globally used pattern, we can safely switch to a simpler
path.
@lunika
lunika force-pushed the fix-api-favorite-list-endpoint branch from 9d2f39f to 25bea79 Compare September 14, 2026 09:38
@lunika
lunika enabled auto-merge (squash) September 14, 2026 09:39
@lunika
lunika merged commit 31cff89 into main Sep 14, 2026
41 checks passed
@lunika
lunika deleted the fix-api-favorite-list-endpoint branch September 14, 2026 10:01
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.

2 participants