Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 31 additions & 24 deletions ooo-request/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,16 @@
```json
{
"id": "String",
"userId": "String",
"state": "<PENDING | APPROVED | REJECTED>",
"status": "<PENDING | APPROVED | REJECTED>",
"from": "Timestamp",
"until": "Timestamp",
"message": "String",
"comment": "String | null",
"createdAt": "Timestamp",
"requestedBy":"String",
"updatedAt": "Timestamp",

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updatedAt type will be also "Timestamp | null"

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please confirm if updatedAt is null during creation, if yes then use null here

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No updatedAt is not null during creation

"lastUpdatedBy": "String",
"reason": "String"
"lastModifiedBy": "String | null",
"reason": "String",
"type":"OOO"
}
```

Expand All @@ -20,15 +21,16 @@
| 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. |
| requestedBy | String | UID of the user who created the request. |

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • what is UID

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

unique ID of the user creating the request

| status | String | current status for the request: PENDING|APPROVED|REJECTED. |
| from | Timestamp | Unix timestamp for the start date of the OOO request. |
| until | Timestamp | Unix timestamp for the end date of the OOO request. |
| message | String | The message for the request. |
| reason | String | Reason for requesting the OOO. |
| createdAt | Timestamp | Unix timestamp for the creation time of the request. |
| updatedAt | Timestamp | Unix timestamp for the last update time of the request. |
| lastUpdatedBy | String | The id of the superuser who processed the request |
| reason | String | The reason for the APPROVED or REJECTED. |
| lastModifiedBy| String | The id of the superuser who processed the request |
| comment | String | The reason for the APPROVED or REJECTED. |
| type | String | The type of requests being sent OOO, Onboarding, extension |

### Example data

Expand All @@ -37,13 +39,16 @@
```json
{
"id": "OfsT1Tlid4Y6Y0d",
"userId": "dfdsd5T1Tlid4Y6Y0d",
"state": "PENDING",
"requestedBy": "dfdsd5T1Tlid4Y6Y0d",
"status": "PENDING",
"from": 1709438800000,
"until": 1709870800000,
"message": "Out of office for personal reasons.",
"reason": "Out of office for personal reasons.",
"createdAt": 1709438900000,
"updatedAt": 1709438900000
"updatedAt": 1709438900000,
"comment": null,
"lastModifiedBy":null,
"type":"OOO"
}
```

Expand All @@ -52,15 +57,16 @@
```json
{
"id": "MpykhM8sT1Tlid4Y6Y0d",
"userId": "dfdsd5T1Tlid4Y6Y0d",
"state": "APPROVED",
"requestedBy": "dfdsd5T1Tlid4Y6Y0d",
"status": "APPROVED",
"from": 1709525300000,
"until": 1709870800000,
"message": "Attending a work conference.",
"reason": "Attending a work conference.",
"createdAt": 1709525400000,
"updatedAt": 1709827800000,
"lastUpdatedBy": "Sedv5T1Tlid4Y6Y0d",
"reason": "Nice to have you back."
"lastModifiedBy": "Sedv5T1Tlid4Y6Y0d",
"comment": "Nice to have you back.",
"type":"OOO"
}
```

Expand All @@ -69,14 +75,15 @@
```json
{
"id": "Me8sT1Tlid4Y6Y0d",
"userId": "dfdsd5T1Tlid4Y6Y0d",
"state": "REJECTED",
"requestedBy": "dfdsd5T1Tlid4Y6Y0d",
"status": "REJECTED",
"from": 1709603700000,
"until": 1709785600000,
"message": "Out of office for personal reasons.",
"reason": "Out of office for personal reasons.",
"createdAt": 1708763200000,
"updatedAt": 1708841500000,
"lastUpdatedBy": "Sedv5T1Tlid4Y6Y0d",
"reason": "Not enough vacation days."
"lastModifiedBy": "Sedv5T1Tlid4Y6Y0d",
"comment": "Not enough vacation days.",
"type":"OOO"
}
```