feat/ add API contract for impersonation session feature#244
Merged
yesyash merged 4 commits intoRealDevSquad:mainfrom Jun 29, 2025
Merged
Conversation
![korbit-ai[bot]](https://avatars.githubusercontent.com/in/322216?s=60&v=4){kind=small}
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Summary by CodeRabbit
WalkthroughA new API endpoint, Changes
Sequence Diagram(s)sequenceDiagram
participant SuperUser
participant API
participant ImpersonationSession
SuperUser->>API: PATCH /impersonation/:id?action=START&dev=true
API->>ImpersonationSession: Start session for :id
ImpersonationSession-->>API: Session started (details)
API-->>SuperUser: Success response with session data
SuperUser->>API: PATCH /impersonation/:id?action=STOP&dev=true
API->>ImpersonationSession: Stop session for :id
ImpersonationSession-->>API: Session stopped (details)
API-->>SuperUser: Success response with session data
Possibly related PRs
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
impersonation/README.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: Suvidh-kaushik
PR: Real-Dev-Squad/website-api-contracts#242
File: impersonation/README.md:119-122
Timestamp: 2025-06-23T17:43:25.779Z
Learning: In the impersonation API documentation, the `dev` flag description in the POST method is incorrect and will be fixed in a separate GET PR. The PATCH method's `dev` flag behavior should follow the pattern of other update contracts in the project.
Learnt from: Suvidh-kaushik
PR: Real-Dev-Squad/website-api-contracts#240
File: impersonation/README.md:117-127
Timestamp: 2025-06-22T16:30:06.385Z
Learning: In the GET /impersonation/requests API endpoint, the `dev` query parameter is required. Without this parameter, the API returns a 404 not found error, so it's not just for enabling a developer view but is necessary for the endpoint to work at all.
Learnt from: Suvidh-kaushik
PR: Real-Dev-Squad/website-api-contracts#240
File: impersonation/README.md:181-190
Timestamp: 2025-06-22T16:28:01.053Z
Learning: In the impersonation API, a 204 No Content response is returned when filter criteria don't match any impersonation requests, rather than returning an empty array with 200 status.
Learnt from: Suvidh-kaushik
PR: Real-Dev-Squad/website-api-contracts#240
File: impersonation/README.md:137-180
Timestamp: 2025-06-22T16:26:40.204Z
Learning: The impersonation API uses cursor-based pagination by default with `next` and `prev` fields, not page-based pagination with `nextPage`.
impersonation/README.md (2)
Learnt from: Suvidh-kaushik
PR: Real-Dev-Squad/website-api-contracts#242
File: impersonation/README.md:119-122
Timestamp: 2025-06-23T17:43:25.779Z
Learning: In the impersonation API documentation, the `dev` flag description in the POST method is incorrect and will be fixed in a separate GET PR. The PATCH method's `dev` flag behavior should follow the pattern of other update contracts in the project.
Learnt from: Suvidh-kaushik
PR: Real-Dev-Squad/website-api-contracts#240
File: impersonation/README.md:117-127
Timestamp: 2025-06-22T16:30:06.385Z
Learning: In the GET /impersonation/requests API endpoint, the `dev` query parameter is required. Without this parameter, the API returns a 404 not found error, so it's not just for enabling a developer view but is necessary for the endpoint to work at all.
🪛 LanguageTool
impersonation/README.md
[uncategorized] ~362-~362: Loose punctuation mark.
Context: ...ted. - Query Parameters: - dev: Required boolean feature flag to update...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~363-~363: Loose punctuation mark.
Context: ...g to update request status. - action: Required string to start or stop the im...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
impersonation/README.md
375-375: Multiple consecutive blank lines
Expected: 1; Actual: 2
(MD012, no-multiple-blanks)
435-435: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
Suvidh-kaushik
force-pushed
the
feat/api_contract_for_impersonation_session_feat
branch
from
6e1e3ac to
18936cf
Compare
Suvidh-kaushik
force-pushed
the
feat/api_contract_for_impersonation_session_feat
branch
from
18936cf to
4af32d9
Compare
Suvidh-kaushik
force-pushed
the
feat/api_contract_for_impersonation_session_feat
branch
from
4af32d9 to
f0d8e3c
Compare
Suvidh-kaushik
force-pushed
the
feat/api_contract_for_impersonation_session_feat
branch
from
f0d8e3c to
bc1e895
Compare
Suvidh-kaushik
force-pushed
the
feat/api_contract_for_impersonation_session_feat
branch
from
bc0011d to
1398040
Compare
MayankBansal12
approved these changes
Jun 29, 2025
yesyash
approved these changes
Jun 29, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Date: 29/06/2025
Developer Name: Suvidh Kaushik
Issue Ticket Number
Description
Documentation Updated?
Under Feature Flag
Database Changes
Breaking Changes
Development Tested?
Screenshots
Screenshot 1
Test Coverage
Screenshot 1
Additional Notes
Description by Korbit AI
What change is being made?
Add API contract documentation for the PATCH /impersonation/:id endpoint to start and stop impersonation sessions.
Why are these changes being made?
This change is made to provide clear API documentation for a new feature allowing super-users to manage impersonation sessions. This ensures developers understand the endpoint requirements, parameters, responses, authentication, and authorization details needed to implement and interact with the feature effectively.