OVPAY-1518 - Added POST and PATCH examples for Processing Failure v2.

src/openapi/fiko/fiko-crud.yaml

@@ -467,6 +467,20 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/ProcessingFailuresPostRequestBody"
+            examples:
+              Add new processing failure for a transaction item:
+                summary: Add new processing failure for a transaction item
+                description: |
+                  Add a new processing failure for a transaction item. This usually happens when
+                  a transaction item has failed validation. In this specific example, the transaction
+                  item has a timestamp in the future.
+                value:
+                  timestamp: 2025-01-01 12:34:00
+                  element: occuredOn
+                  value: 2027-01-01 12:34:00
+                  reasonCode: "012"
+                  reasonDescription: Transaction date is in the future.
+                  resolved: false
       responses:
         "201":
           description: Created
@@ -474,6 +488,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ProcessingFailuresPostResponseBody"
+              examples:
+                Processing failure successfully added:
+                  summary: Processing failure successfully added
+                  description: The processing failure was successfully added to the database.
+                  value:
+                    processingFailureId: 6ce10520-9a73-4cb4-b8dd-39ee46ceb617
   /transactionitems/{transactionItemId}/transactionaudittrails:
     parameters:
       - in: path
@@ -662,7 +682,7 @@ paths:
                     href: null
                 ? List containing multiple transaction audit trails of one transaction item
                 : summary: List containing multiple audit trails of one transaction item
-                  description: List containing multiple audit trail records of one transaction item (with id d667d293-aa82-4c9e-9b10-77cffc9058a1).
+                  description: List containing multiple audit trail records of one transaction item (with id `d667d293-aa82-4c9e-9b10-77cffc9058a1`).
                   value:
                     transactionAuditTrails:
                       - transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e
@@ -833,7 +853,7 @@ paths:
                         timestamp: 2022-01-01 00:00:00
                         element: costType
                         value: 901
-                        reasonCode: 004
+                        reasonCode: "004"
                         reasonDescription: Cost type does not exist.
                         resolved: false
                         change: null
@@ -842,7 +862,7 @@ paths:
                         timestamp: 2025-01-01 00:43:01
                         element: costCenter
                         value: 84955
-                        reasonCode: 002
+                        reasonCode: "002"
                         reasonDescription: Cost center does not exist.
                         resolved: true
                         change: Adapt config
@@ -851,7 +871,7 @@ paths:
                         timestamp: 2025-01-01 00:43:01
                         element: department
                         value: 1337
-                        reasonCode: 001
+                        reasonCode: "001"
                         reasonDescription: Department does not exist.
                         resolved: true
                         change: Adapt config
@@ -868,7 +888,7 @@ paths:
                         timestamp: 2022-01-01 00:00:00
                         element: occuredOn
                         value: 2027-01-01
-                        reasonCode: 009
+                        reasonCode: "009"
                         reasonDescription: Transaction date is in the future
                         resolved: false
                         change: null
@@ -877,7 +897,7 @@ paths:
                         timestamp: 2025-01-01 00:43:01
                         element: costCenter
                         value: 84955
-                        reasonCode: 002
+                        reasonCode: "002"
                         reasonDescription: Cost center does not exist.
                         resolved: false
                         change: null
@@ -886,7 +906,7 @@ paths:
                         timestamp: 2025-01-01 00:43:01
                         element: department
                         value: 1337
-                        reasonCode: 001
+                        reasonCode: "001"
                         reasonDescription: Department does not exist.
                         resolved: false
                         change: null
@@ -911,6 +931,15 @@ paths:
           application/json:
             schema:
               $ref: "#/components/schemas/ProcessingFailuresPatchRequestBody"
+            examples:
+              Resolve an existing processing failure:
+                summary: Resolve an existing processing failure
+                description: |
+                  In this example, the processing failure with the id `37a8095b-19db-498f-9349-5f37d21c5bdf` 
+                  has been resolved by chaning the config.
+                value:
+                  resolved: true
+                  change: Adapt config
       responses:
         "200":
           description: OK
@@ -918,6 +947,12 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ProcessingFailuresPatchResponseBody"
+              examples:
+                Processing failure updated successfully:
+                  summary: Processing failure updated successfully
+                  description: The processing failure has been updated successfully.
+                  value:
+                    processingFailureId: 37a8095b-19db-498f-9349-5f37d21c5bdf
   /bookingprocesses:
     get:
       summary: Find booking processes.