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

[jmaupetit]

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/

[github-actions]

Size Change: 0 B

Total Size: 4.36 MB

📦 View Changed

Filename	Size	Change
apps/impress/out/_next/static/85faf5a3/_buildManifest.js	0 B	-677 B (removed)	🏆
apps/impress/out/_next/static/b104dc57/_buildManifest.js	677 B	+677 B (new file)	🆕

_{compressed-size-action}

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 9bd42f57-14ca-4463-960e-ca9ff84357f6

📥 Commits

Reviewing files that changed from the base of the PR and between 61c2183 and 20d424e.

📒 Files selected for processing (5)

• CHANGELOG.md
• src/backend/core/api/viewsets.py
• src/backend/core/tests/documents/test_api_documents_favorite_list.py
• src/backend/core/tests/external_api/test_external_api_documents_favorite.py
• src/frontend/apps/impress/src/features/docs/doc-management/api/useDocsFavorite.tsx

---

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 are updated to use the new path, with existing assertions unchanged. The changelog records the endpoint change.

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

Suggested reviewers: antolc

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and accurately describes the endpoint rename from /documents/favorite_list/ to /documents/favorites/.
Description check	✅ Passed	The description matches the change and explains the move to the shorter favorites endpoint path.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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

• X
• Mastodon
• Reddit
• LinkedIn

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