OVPAY-1946 - Updated bulk responsestatus endpoints.

src/openapi/fiko/fiko-crud.yaml

@@ -2979,10 +2979,10 @@ paths:
         - default: []
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited
-  /transactionitems/reject:
+  /transactionitems/bulk:
-    post:
+    patch:
-      summary: Reject transaction items to source in bulk.
+      summary: Patch transaction items in bulk.
-      description: Reject transaction items to source in bulk.
+      description: Patch transaction items in bulk.
       tags:
         - Bulk processing v2.2
       requestBody:
@@ -2992,14 +2992,22 @@ paths:
             schema:
               $ref: "#/components/schemas/TransactionItemsBulkRequestBody"
             examples:
-              List of transaction item ids to reject:
+              List of transactions items to reject:
-                summary: List of transaction item ids to reject to source
+                summary: List of transaction items to reject to source
-                description: List of transaction item ids to reject to source.
+                description: List of transaction items to reject to source in bulk.
                 value:
-                  transactionItemIds:
+                  - transactionItemId: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
-                    - afce35b2-1dff-4ace-98d0-4b9ac405c87d
+                    status: returned to src
-                    - b1c4f8e7-3f4e-4d2a-9c6e-2f5e6d7c8b9a
+                  - transactionItemId: 88910e83-4b1e-4fde-ab13-bd8bb60cbcd3
-                    - c2d5e6f7-4g5h-5i6j-0k1l-3m4n5o6p7q8r
+                    status: returned to src
+              List of transactions items to return:
+                summary: List of transaction items to return to transaction database
+                description: List of transaction items to return to transaction database in bulk.
+                value:
+                  - transactionItemId: eacb9bdc-c6b5-4277-942b-cebb102944f5
+                    status: returned to trx-db
+                  - transactionItemId: 2f361bfb-9df0-4e0f-af7c-7b9be3e7bc61
+                    status: returned to trx-db
       responses:
         "202":
           description: Accepted
@@ -3018,32 +3026,32 @@ paths:
                     startTime: 2025-02-14T05:32:47.0672237Z
                     status: Running
                     clientTrackingId: 08584620957189579629541919368CU00
-                    callbackurl: https://api.integratielaag.nl/transactionitems/reject/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
+                    callbackurl: https://api.integratielaag.nl/transactionitems/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
                     retryAfter: 10
       security:
         - default: []
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited
-  /transactionitems/responsestatus/reject/{clientTrackingId}:
+  /transactionitems/bulk/responsestatus/{clientTrackingId}:
     get:
       tags:
         - Bulk processing v2.2
-      summary: Get the status of the transaction item bulk reject.
+      summary: Get the status of the transaction item bulk patch.
-      description: Get the status of the asynchronous transaction item bulk reject.
+      description: Get the status of the asynchronous transaction item bulk patch.
       parameters:
         - in: path
           name: clientTrackingId
           schema:
             type: string
           required: true
-          description: The clientTrackingId of the transaction item bulk reject.
+          description: The clientTrackingId of the transaction item bulk patch.
       responses:
         "200":
           description: OK
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/TransactionItemsRejectResponseStatusGetResponseBody"
+                $ref: "#/components/schemas/TransactionItemsBulkResponseStatusGetResponseBody"
               examples:
                 Batch successfully processed:
                   summary: Batch successfully processed
@@ -3058,85 +3066,6 @@ paths:
         - default: []
       x-auth-type: Application & Application User
       x-throttling-tier: Unlimited
-  /transactionitems/return:
-    post:
-      summary: Return transaction items to trx db in bulk.
-      description: Return transaction items to trx db in bulk.
-      tags:
-        - Bulk processing v2.2
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              $ref: "#/components/schemas/TransactionItemsBulkRequestBody"
-            examples:
-              List of transaction item ids to reject:
-                summary: List of transaction item ids to return to trx db
-                description: List of transaction item ids to return to trx db.
-                value:
-                  transactionItemIds:
-                    - afce35b2-1dff-4ace-98d0-4b9ac405c87d
-                    - b1c4f8e7-3f4e-4d2a-9c6e-2f5e6d7c8b9a
-                    - c2d5e6f7-4g5h-5i6j-0k1l-3m4n5o6p7q8r
-      responses:
-        "202":
-          description: Accepted
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/TransactionItemsPostResponseBody"
-              examples:
-                Array of transaction items accepted:
-                  summary: Array of transaction item ids accepted
-                  description: |
-                    The array of transaction item ids 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:
-                    startTime: 2025-02-14T05:32:47.0672237Z
-                    status: Running
-                    clientTrackingId: 08584620957189579629541919368CU00
-                    callbackurl: https://api.integratielaag.nl/transactionitems/return/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
-                    retryAfter: 10
-      security:
-        - default: []
-      x-auth-type: Application & Application User
-      x-throttling-tier: Unlimited
-  /transactionitems/responsestatus/return/{clientTrackingId}:
-    get:
-      tags:
-        - Bulk processing v2.2
-      summary: Get the status of the transaction item bulk return.
-      description: Get the status of the asynchronous transaction item bulk return.
-      parameters:
-        - in: path
-          name: clientTrackingId
-          schema:
-            type: string
-          required: true
-          description: The clientTrackingId of the transaction item bulk return.
-      responses:
-        "200":
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/TransactionItemsReturnResponseStatusGetResponseBody"
-              examples:
-                Batch successfully processed:
-                  summary: Batch successfully processed
-                  description: |
-                    Body of a batch of transaction items that was successfully returned to trx db. 
-                    A number of transaction items were returned to trx db.
-                  value:
-                    summary:
-                      returned: 15
-                      total: 15
-      security:
-        - default: []
-      x-auth-type: Application & Application User
-      x-throttling-tier: Unlimited
 components:
   securitySchemes:
     default:
@@ -4960,17 +4889,21 @@ components:
                 type: string
                 example: fee907dd-e59d-44f5-a63b-bbdec38f79b7
     TransactionItemsBulkRequestBody:
-      type: object
-      properties:
-        transactionItemIds:
       type: array
       items:
+        type: object
+        properties:
+          transactionItemId:
             type: string
             format: uuid
-            example: 1ad109d3-fd7d-4b6f-872b-220d492f385f
+            example: d8ee7035-fa3d-400e-9ad5-4fe8c4c73eb7
+          status:
+            type: string
+            example: returned to src
         required:
-        - transactionItemIds
+          - transactionItemId
-    TransactionItemsRejectResponseStatusGetResponseBody:
+          - status
+    TransactionItemsBulkResponseStatusGetResponseBody:
       type: object
       properties:
         summary:
@@ -4987,23 +4920,6 @@ components:
             - total
       required:
         - summary
-    TransactionItemsReturnResponseStatusGetResponseBody:
-      type: object
-      properties:
-        summary:
-          type: object
-          properties:
-            returned:
-              type: integer
-              example: 3
-            total:
-              type: integer
-              example: 3
-          required:
-            - returned
-            - total
-      required:
-        - summary
     rfc9457:
       type: object
       properties: