OVPAY-2103 - Added batch endpoints for bulk patch processing failures.

src/openapi/fiko/fiko-crud.yaml

@@ -228,7 +228,7 @@ paths:
         content:
           application/json:
             schema:
-              $ref: "#/components/schemas/TransactionItemsPostRequestBody"
+              $ref: "#/components/schemas/TransactionItemsBulkRequestBody"
             examples:
               Add single transaction item:
                 summary: Add single transaction item
@@ -285,7 +285,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TransactionItemsPostResponseBody"
+                $ref: "#/components/schemas/BulkResponseBody"
               examples:
                 Array of transaction items accepted:
                   summary: Array of transaction items accepted
@@ -381,7 +381,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TransactionItemsResponseStatusGetResponseBody"
+                $ref: "#/components/schemas/GetResponseStatus"
               examples:
                 Batch successfully processed:
                   summary: Batch successfully processed
@@ -2996,6 +2996,7 @@ paths:
                 summary: List of transaction items to reject to source
                 description: List of transaction items to reject to source in bulk.
                 value:
+                  transactionItems:
                   - transactionItemId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
                     status: returned to src
                   - transactionItemId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
@@ -3004,6 +3005,7 @@ paths:
                 summary: List of transaction items to return to transaction database
                 description: List of transaction items to return to transaction database in bulk.
                 value:
+                  transactionItems:
                   - transactionItemId: eacb9bdc-c6b5-4277-942b-cebb102944f5
                     status: returned to trx-db
                   - transactionItemId: 2f361bfb-9df0-4e0f-af7c-7b9be3e7bc61
@@ -3014,12 +3016,12 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TransactionItemsPostResponseBody"
+                $ref: "#/components/schemas/BulkResponseBody"
               examples:
                 Array of transaction items accepted:
-                  summary: Array of transaction item ids accepted
+                  summary: Array of transaction items accepted
                   description: |
-                    The array of transaction item ids was accepted successfully.
+                    The array of transaction items was accepted successfully.
                     The transaction items will be processed asynchronously.
                     In the response body the consumer will find information on how to retrieve the processing status.
                   value:
@@ -3051,16 +3053,98 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TransactionItemsBulkResponseStatusGetResponseBody"
+                $ref: "#/components/schemas/GetResponseStatus"
               examples:
                 Batch successfully processed:
                   summary: Batch successfully processed
                   description: |
-                    Body of a batch of transaction items that was successfully rejected. 
-                    A number of transaction items were rejected.
+                    Body of a batch of transaction items that was successfully patched. 
+                    A number of transaction items were patched.
                   value:
                     summary:
-                      rejected: 15
+                      created: 0
+                      updated: 15
+                      total: 15
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /processingfailures/bulk:
+    patch:
+      summary: Patch processing failures in bulk.
+      description: Patch processing failures in bulk.
+      tags:
+        - Bulk processing v2.2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ProcessingFailuresBulkRequestBody"
+            examples:
+              List of processing failures to resolve:
+                summary: List of processing failures to resolve
+                description: List of processing failures to resolve in bulk.
+                value:
+                  processingFailures:
+                  - processingFailureId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
+                    resolved: true
+                  - processingFailureId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
+                    resolved: true
+      responses:
+        "202":
+          description: Accepted
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/BulkResponseBody"
+              examples:
+                Array of processing failures accepted:
+                  summary: Array of processing failures accepted
+                  description: |
+                    The array of processing failures was accepted successfully.
+                    The processing failures will be processed asynchronously.
+                    In the response body the consumer will find information on how to retrieve the processing status.
+                  value:
+                    startTime: 2025-02-14T05:32:47.0672237Z
+                    status: Running
+                    clientTrackingId: 08584620957189579629541919368CU00
+                    callbackurl: https://api.integratielaag.nl/processingfailures/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
+                    retryAfter: 10
+      security:
+        - default: []
+      x-auth-type: Application & Application User
+      x-throttling-tier: Unlimited
+  /processingfailures/bulk/responsestatus/{clientTrackingId}:
+    get:
+      tags:
+        - Bulk processing v2.2
+      summary: Get the status of the processing failures bulk patch.
+      description: Get the status of the asynchronous processing failures bulk patch.
+      parameters:
+        - in: path
+          name: clientTrackingId
+          schema:
+            type: string
+          required: true
+          description: The clientTrackingId of the processing failures bulk patch.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/GetResponseStatus"
+              examples:
+                Batch successfully processed:
+                  summary: Batch successfully processed
+                  description: |
+                    Body of a batch of processing failures that was successfully patched. 
+                    A number of processing failures were patched.
+                  value:
+                    summary:
+                      created: 0
+                      updated: 15
                       total: 15
       security:
         - default: []
@@ -3178,7 +3262,7 @@ components:
             - occurredOn
             - type
             - status
-    TransactionItemsPostRequestBody:
+    TransactionItemsBulkRequestBody:
       type: object
       properties:
         transactionItems:
@@ -3186,6 +3270,10 @@ components:
           items:
             type: object
             properties:
+              transactionItemId:
+                type: string
+                format: uuid
+                example: afce35b2-1dff-4ace-98d0-4b9ac405c87d
               transactionType:
                 type: string
                 enum:
@@ -3245,7 +3333,7 @@ components:
               - amountTax
               - occurredOn
               - type
-    TransactionItemsPostResponseBody:
+    BulkResponseBody:
       type: object
       properties:
         startTime:
@@ -4831,7 +4919,7 @@ components:
       required:
         - concessionId
         - name
-    TransactionItemsResponseStatusGetResponseBody:
+    GetResponseStatus:
       type: object
       properties:
         summary:
@@ -4888,38 +4976,24 @@ components:
               transactionLineId:
                 type: string
                 example: fee907dd-e59d-44f5-a63b-bbdec38f79b7
-    TransactionItemsBulkRequestBody:
-      type: array
-      items:
-        type: object
-        properties:
-          transactionItemId:
-            type: string
-            format: uuid
-            example: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
-          status:
-            type: string
-            example: returned to src
-        required:
-          - transactionItemId
-          - status
-    TransactionItemsBulkResponseStatusGetResponseBody:
+    ProcessingFailuresBulkRequestBody:
       type: object
       properties:
-        summary:
-          type: object
-          properties:
-            rejected:
-              type: integer
-              example: 3
-            total:
-              type: integer
-              example: 3
-          required:
-            - rejected
-            - total
-      required:
-        - summary
+        processingFailures:
+          type: array
+          items:
+            type: object
+            properties:
+              processingFailureId::
+                type: string
+                format: uuid
+                example: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
+              resolved:
+                type: boolean
+                example: true
+            required:
+              - transactionItemId
+              - resolved
     rfc9457:
       type: object
       properties: