Update auth-jwt README: change registration endpoint to /user

[StefSchalks]

…user

Summary by CodeRabbit

• Documentation
  • Updated registration endpoint in the README from /api/auth/register to /api/user across usage examples and the API Endpoints list.
  • Improves accuracy and clarity for developers integrating with the registration flow.
  • No functional changes to the application or API behavior.

[welcome]

Thanks for opening this pull request! 🎉 Please check out our contributing guidelines.

[gemini-code-assist]

Summary of Changes

Hello @StefSchalks, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request focuses on maintaining accurate documentation by updating the auth-jwt README. The primary change ensures that the example curl command for user registration points to the correct and current API endpoint, thereby preventing confusion and facilitating proper usage for anyone following the documentation.

Highlights

• Documentation Update: The auth-jwt README has been updated to reflect the correct user registration endpoint.
• Endpoint Change: The registration endpoint in the curl example within the README was changed from /api/auth/register to /api/user.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[coderabbitai]

Walkthrough

Documentation update in auth-jwt/README.md: the example registration endpoint was changed from /api/auth/register to /api/user in usage snippet and API Endpoints list. No code, logic, or control flow changes.

Changes

Cohort / File(s)	Summary of edits
Docs: auth-jwt README auth-jwt/README.md	Updated documented registration endpoint from /api/auth/register to /api/user in examples and endpoint list; no behavioral or code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Update README.md of a recipe: Auth + Docker + Postgres + JWT #3041 — Performs the same README change, updating the registration endpoint to POST /api/user.

Poem

I twitch my nose at routes anew,
From auth to user, paths run true.
A hop, a skip, docs realign—
The burrow signs now clearly shine.
With ears perked high, I stamp and cheer:
“POST to /api/user lives here!” 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check	✅ Passed	The title accurately and concisely summarizes the single main change of updating the auth-jwt README to use the /user registration endpoint, making it clear to reviewers and future readers what the pull request achieves. It directly references the key file (README) and the specific endpoint adjustment without unnecessary detail or ambiguity.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9405e5f and b8a0bcd.

📒 Files selected for processing (1)

• auth-jwt/README.md (1 hunks)

---

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 and usage tips.}

[gemini-code-assist]

Code Review

This pull request updates the user registration endpoint in the auth-jwt README example. The change correctly aligns the example with the router's implementation. However, it introduces an inconsistency, as the API endpoint list in the same file was not updated. I've added a comment suggesting a fix to ensure the documentation is fully consistent.

[gemini-code-assist]

While this change correctly updates the example to use the /api/user endpoint, it creates an inconsistency within the README. The 'API Endpoints' list (line 65) still refers to the old /api/auth/register endpoint, and line 68 also lists /api/user.

For clarity and consistency, please update the API endpoints list to remove the incorrect /api/auth/register entry and clarify that POST /api/user is for user registration.