diff --git a/ooo-request/README.md b/ooo-request/README.md index 5f1c133..c26d195 100644 --- a/ooo-request/README.md +++ b/ooo-request/README.md @@ -3,15 +3,16 @@ ```json { "id": "String", - "userId": "String", - "state": "", + "status": "", "from": "Timestamp", "until": "Timestamp", - "message": "String", + "comment": "String | null", "createdAt": "Timestamp", + "requestedBy":"String", "updatedAt": "Timestamp", - "lastUpdatedBy": "String", - "reason": "String" + "lastModifiedBy": "String | null", + "reason": "String", + "type":"OOO" } ``` @@ -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. | +| 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 @@ -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" } ``` @@ -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" } ``` @@ -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" } ```