fix: Route Description table for Users contract #232

Suvidh-kaushik · 2025-04-30T20:00:47Z

Date: 01/05/2025

Developer Name: Suvidh Kaushik

Issue Ticket Number

N/A

Description

Added two new routes in the table PUT /users/:userId/intro and PATCH /users/:userId which has contracts but were not in the table
fixed small linking issues in the table which on click take u to that route

Documentation Updated?

Yes
No

Under Feature Flag

Yes
No

Database Changes

Yes
No

Breaking Changes

Yes
No

Development Tested?

Yes
No

Screenshots

Screenshot 1

coderabbitai · 2025-04-30T20:00:54Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Summary by CodeRabbit

Documentation
- Updated user API documentation to add new endpoints for creating user intros and updating user profiles.
- Marked the PATCH /users/self route as "to be deprecated."
- Clarified route descriptions and improved formatting for better readability.

Walkthrough

The documentation for user-related API routes has been updated. The summary table now includes two new endpoints: PUT /users/:userId/intro for creating a user intro and PATCH /users/:userId with separate descriptions for super user approvals and authenticated user updates. The PATCH /users/self endpoint is now marked as "to be deprecated" with an updated anchor. Minor formatting adjustments were made to the routes table for improved clarity and consistency. No changes were made to the detailed endpoint descriptions.

Changes

File(s)	Change Summary
users/README.md	Updated API routes table: added `PUT /users/:userId/intro`, expanded `PATCH /users/:userId`, marked `PATCH /users/self` as "to be deprecated", and improved formatting.

Poem

In the warren of docs, some routes hop anew,
With intros and patches, their numbers now grew.
"Self" takes a rest, soon to retire,
While super users and friends can now aspire.
The table aligns, all neat and precise—
For every user, a change that’s quite nice!
🐇✨

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 377d467 and 1698b65.

📒 Files selected for processing (1)

users/README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

users/README.md

[grammar] ~43-~43: When ‘logged-in’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...elf) | Returns the logged in user's details | | [GET /user...

(LOGGED_IN_HYPHEN)

[grammar] ~53-~53: This is normally spelled as one word.
Context: ...ch-usersuserid) | Allows super users to approve profile diff | | [...

(SUPER_COMPOUNDS)

🔇 Additional comments (2)

users/README.md (2)

49-49: Verify and correct anchor for deprecated PATCH /users/self
The table link uses [#patch-usersself-to-be-deprecated], but given the heading ## PATCH /users/self(To Be Deprecated), GitHub’s slug might actually be patch-users-self-to-be-deprecated. Please confirm the generated anchor and update the link to match exactly, preventing broken navigation.

52-52: Ensure anchor for PUT /users/:userId/intro matches heading slug
The link currently points to #put-usersuseridintro, but the heading ## PUT /users/:userId/intro will likely generate a slug like put-users-userid-intro. Please verify the correct anchor and adjust the link to avoid a 404.

users/README.md

AnujChhikara

Please consider creating issue ticket before raising PR

AnujChhikara · 2025-05-02T16:29:52Z

users/README.md

+|              [PATCH /users](#patch-users)                      |     Archive users if not in discord             |
+| [PUT /users/:userId/intro](#put-usersuseridintro)              | Create a User Intro in DB if not present        |
+|      [PATCH /users/:userId](#patch-usersuserid)                | Allows super users to approve profile diffs     |
+|      [PATCH /users/:userId](#patch-usersuserid)                |Allows authenticated users to update profile data|


PATCH /users/:userId is listed twice—should we clarify roles or merge into one row with both use cases?

yes it is used for 2 things so added it twice , adding both in the same row will increase table width that's why i did not prefer that

Suvidh-kaushik · 2025-05-02T18:02:43Z

Please consider creating issue ticket before raising PR
small bug did not think it was necessary, will keep in mind from next time

fixed route-description table for users contract

1698b65

coderabbitai bot reviewed Apr 30, 2025

View reviewed changes

users/README.md Outdated Show resolved Hide resolved

users/README.md Outdated Show resolved Hide resolved

fixed naming inconsistencies

974e9ea

AnujChhikara reviewed May 2, 2025

View reviewed changes

Suvidh-kaushik closed this May 2, 2025

Suvidh-kaushik reopened this May 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix: Route Description table for Users contract #232

fix: Route Description table for Users contract #232

Uh oh!

Suvidh-kaushik commented Apr 30, 2025

Uh oh!

coderabbitai bot commented Apr 30, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Uh oh!

AnujChhikara left a comment

Uh oh!

AnujChhikara May 2, 2025

Uh oh!

Suvidh-kaushik May 2, 2025

Uh oh!

Suvidh-kaushik commented May 2, 2025

Uh oh!

Uh oh!

fix: Route Description table for Users contract #232

Are you sure you want to change the base?

fix: Route Description table for Users contract #232

Uh oh!

Conversation

Suvidh-kaushik commented Apr 30, 2025

Issue Ticket Number

Description

Documentation Updated?

Under Feature Flag

Database Changes

Breaking Changes

Development Tested?

Screenshots

Uh oh!

coderabbitai bot commented Apr 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Summary by CodeRabbit

Walkthrough

Changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

AnujChhikara left a comment

Choose a reason for hiding this comment

Uh oh!

AnujChhikara May 2, 2025

Choose a reason for hiding this comment

Uh oh!

Suvidh-kaushik May 2, 2025

Choose a reason for hiding this comment

Uh oh!

Suvidh-kaushik commented May 2, 2025

Uh oh!

Uh oh!

coderabbitai bot commented Apr 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)