Merge pull request #817 from teamleadercrm/CON-363-API-doc-for-dayoff-type-update-endpoint

CON-363 Add API doc for dayoff type update endpoint

Author: Gehad Mohamed

apiary.apib

@@ -429,7 +429,7 @@ We list all backwards-compatible additions here. These are currently available i
 #### June 2024
 - We added `tax` to the `products.info` endpoint.
 - We added the `daysOff.import` and `daysOff.bulkDelete` endpoints.
-- We added the `dayOffTypes.create` and `dayOffTypes.delete` endpoints.
+- We added the `dayOffTypes.create`, `dayOffTypes.update` and `dayOffTypes.delete` endpoints.
 - We added the `closingDays.add` and `closingDays.delete` endpoints.
 
 #### May 2024
@@ -1866,6 +1866,21 @@ Create a new day off type.
             + type: `dayOffType` (string)
             + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string)
 
+### dayOffTypes.update [POST /dayOffTypes.update]
+
+Update a day off type.
+
++ Request (application/json)
+    + Attributes (object)
+        + `id`: `1b7cece0-288c-0bbe-b916-5a315fbe9fe2` (string, required)
+        + name: `day off type` (string, optional)
+        + color: `#00B2B2` (string, optional)
+        + date_validity (object, nullable, optional)
+            + from: `2024-04-04` (string, required)
+            + unit: `2025-05-05` (string, required)
+
++ Response 204 (application/json)
+
 ### dayOffTypes.delete [POST /dayOffTypes.delete]
 
 Delete a day off type.

src/01-general/day-off-types.apib

@@ -32,6 +32,21 @@ Create a new day off type.
             + type: `dayOffType` (string)
             + id: `cf307a90-d778-003c-b820-ab8415d1a524` (string)
 
+### dayOffTypes.update [POST /dayOffTypes.update]
+
+Update a day off type.
+
++ Request (application/json)
+    + Attributes (object)
+        + `id`: `1b7cece0-288c-0bbe-b916-5a315fbe9fe2` (string, required)
+        + name: `day off type` (string, optional)
+        + color: `#00B2B2` (string, optional)
+        + date_validity (object, nullable, optional)
+            + from: `2024-04-04` (string, required)
+            + unit: `2025-05-05` (string, required)
+
++ Response 204 (application/json)
+
 ### dayOffTypes.delete [POST /dayOffTypes.delete]
 
 Delete a day off type.

src/changes-backwards-compatible.apib

@@ -7,7 +7,7 @@ We list all backwards-compatible additions here. These are currently available i
 #### June 2024
 - We added `tax` to the `products.info` endpoint.
 - We added the `daysOff.import` and `daysOff.bulkDelete` endpoints.
-- We added the `dayOffTypes.create` and `dayOffTypes.delete` endpoints.
+- We added the `dayOffTypes.create`, `dayOffTypes.update` and `dayOffTypes.delete` endpoints.
 - We added the `closingDays.add` and `closingDays.delete` endpoints.
 
 #### May 2024