generated from RealDevSquad/website-template
-
Notifications
You must be signed in to change notification settings - Fork 15
Add onboarding extension requests data model and examples in different state #74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
pankajjs
wants to merge
5
commits into
main
Choose a base branch
from
fix/add-onboarding-extension-requests-data-model
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d0d0fb1
Create README.md
pankajjs d6c619c
add data model and examples of request
pankajjs 62bc789
fix: resolve nitpick comment
pankajjs ed79944
fix: add onboarding-extension-requests folder path in README for navi…
pankajjs 5b27857
fix: add string in type field
pankajjs File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,98 @@ | ||
|
|
||
| ### Onboarding Extension Request Firestore collection model | ||
|
|
||
| ```json | ||
| { | ||
| "id": "String", | ||
| "type": "String", | ||
| "userId": "String", | ||
| "state": "String", | ||
| "oldEndsOn": "number", | ||
| "newEndsOn": "number", | ||
| "message": "String", | ||
| "createdAt": "Timestamp", | ||
| "updatedAt": "Timestamp", | ||
| "lastModifiedBy": "String", | ||
| "reason": "String", | ||
| "requestedBy": "String", | ||
| "requestedNumber": "number" | ||
| } | ||
| ``` | ||
|
|
||
| #### Fields | ||
|
|
||
| | Field | Type | Description | | ||
| | ------------- | --------- | ------------------------------------------------------------------------| | ||
| | id | String | Unique identifier for the document. | | ||
| | userId | String | The id of the user who created the request. | | ||
| | state | String | The state of the request like APPROVED, REJECTED, PENDING. | | ||
| | oldEndsOn | number | Old deadline of the onboarding task in millisecond. | | ||
| | newEndsOn | number | New deadline of the onboarding task in millisecond. | | ||
| | message | String | The message provided by superuser while approving or rejecting request. | | ||
| | createdAt | Timestamp | Unix timestamp for the creation time of the request. | | ||
| | updatedAt | Timestamp | Unix timestamp for the last update time of the request. | | ||
| | lastModifiedBy| String | The id of the superuser or request owner who processed the request. | | ||
| | reason | String | The reason for the extension request. | | ||
| | requestedBy | String | The username of the user who created the request. | | ||
| | requestNumber | number | The current request number of onboarding extension request. | | ||
| | type | String | The type of request, i.e., ONBOARDING. | | ||
|
|
||
| ### Example data | ||
|
|
||
| #### Example for PENDING state | ||
|
|
||
| ```json | ||
| { | ||
| "id": "VYSTHeIERJlEtQdpViWo", | ||
| "createdAt": 1741328586836, | ||
| "updatedAt": 1741328586836, | ||
| "type": "ONBOARDING", | ||
| "state": "PENDING", | ||
| "userId": "7bTCwaMgEnKSumhenkwj", | ||
| "requestedBy": "mridul-khandelwal-1", | ||
| "oldEndsOn": 1743683053755, | ||
| "newEndsOn": 1744115053755, | ||
| "reason": "testing", | ||
| "requestNumber": 1 | ||
| } | ||
| ``` | ||
|
|
||
| #### Example for APPROVED state | ||
|
|
||
| ```json | ||
| { | ||
| "id": "Vv5IPkhghnNyjPYhw6Ws", | ||
| "createdAt": 1738686977925, | ||
| "type": "ONBOARDING", | ||
| "userId": "p86xesKNsxic6uFe6SZi", | ||
| "requestedBy": "mohit-ramani-1", | ||
| "oldEndsOn": 1740584089491, | ||
| "requestNumber": 1, | ||
| "reason": "test 2", | ||
| "newEndsOn": 1741132800000, | ||
| "lastModifiedBy": "65QiTlqudZfDk3i5W9WO", | ||
| "state": "APPROVED", | ||
| "message": "super-user message for testing", | ||
| "updatedAt": 1738830512066 | ||
| } | ||
| ``` | ||
|
|
||
| #### Example for REJECTED state | ||
|
|
||
| ```json | ||
| { | ||
| "id": "Vv5IPkhghnNyjPYhw6Ws", | ||
| "createdAt": 1738686977925, | ||
| "type": "ONBOARDING", | ||
| "userId": "p86xesKNsxic6uFe6SZi", | ||
| "requestedBy": "mohit-ramani-1", | ||
| "oldEndsOn": 1740584089491, | ||
| "requestNumber": 1, | ||
| "reason": "test 2", | ||
| "newEndsOn": 1741132800000, | ||
| "lastModifiedBy": "65QiTlqudZfDk3i5W9WO", | ||
| "state": "REJECTED", | ||
| "message": "super-user message for testing", | ||
| "updatedAt": 1738830512066 | ||
| } | ||
| ``` | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧹 Nitpick (assertive)
Consider Adding a Top-Level Heading
While the file begins with a level-3 heading, markdown best practices (and tools such as markdownlint MD041) suggest that the first line should be a top-level (level-1) heading. For better structure and readability, consider replacing the current heading with a level-1 heading (e.g.,
# Onboarding Extension Request Firestore Collection Model).🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
2-2: First line in a file should be a top-level heading
null
(MD041, first-line-heading, first-line-h1)