From 7b2cf2f579f2570f0bc1554f39d4106f3c6edfc3 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Wed, 19 Feb 2025 15:30:17 +0100 Subject: [PATCH] OVPAY-1518 - Added examples for Audit Trail v2. --- src/openapi/fiko/fiko-crud.yaml | 155 +++++++++++++++++++++++++++++++- 1 file changed, 154 insertions(+), 1 deletion(-) diff --git a/src/openapi/fiko/fiko-crud.yaml b/src/openapi/fiko/fiko-crud.yaml index 385be12..04f48d8 100644 --- a/src/openapi/fiko/fiko-crud.yaml +++ b/src/openapi/fiko/fiko-crud.yaml @@ -334,7 +334,10 @@ paths: examples: Array of transaction items accepted: summary: Array of transaction items accepted - description: Array of transaction items accepted. + description: | + 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: startTime: 2025-02-14T05:32:47.0672237Z status: Running @@ -445,6 +448,27 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionAuditTrailsPostRequestBody" + examples: + Add new transaction audit trail for created transaction item: + summary: Add new transaction audit trail for created transaction item + description: Add a new audit trail record for a newly created transaction item. + value: + user: fiko + timestamp: 2022-01-01 12:34:00 + action: create + status: created + description: Transaction item created. + correlationId: null + Add new transaction audit trail for updated transaction item: + summary: Add new transaction audit trail for updated transaction item + description: Add a new audit trail record for an updated transaction item. + value: + user: r.meeuws + timestamp: 2022-01-02 12:34:00 + action: update + status: return to src + description: Transaction item returned to source. + correlationId: 0dc216ea-58e7-4a5e-aa18-449f0304209c responses: "201": description: Created @@ -452,6 +476,14 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionAuditTrailsPostResponseBody" + examples: + Transaction audit trail record created: + summary: Transaction audit trail record created + description: | + A new audit trail record for this transaction item was successfully created. + The transactionAuditTrailId is returned as a reference for the consumer. + value: + transactionAuditTrailId: 37a8095b-19db-498f-9349-5f37d21c5bdf /transactionaudittrails: get: summary: Find audit trail entries. @@ -536,6 +568,127 @@ paths: application/json: schema: $ref: "#/components/schemas/TransactionAuditTrailsGetResponseBody" + examples: + No transaction items: + summary: No transaction audit trails were found + description: No transaction audit trails that match the search criteria were found. + value: + transactionAuditTrails: [] + href: null + List containing multiple transaction audit trails: + summary: List containing multiple transaction audit trails + description: List containing multiple transaction audit trails of different transaction items (no filters applied). + value: + transactionAuditTrails: + - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-01 12:34:51 + action: create + status: created + description: Transaction created. + correlationId: null + - transactionAuditTrailId: 1d234fc1-eb16-41d3-b2e0-e400e17b017f + transactionItemId: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b + user: fiko + timestamp: 2025-01-01 12:34:50 + action: create + status: created + description: Transaction created. + correlationId: null + - transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6 + transactionItemId: e8891be1-1b8a-4a0f-91e2-6b523b6497dd + user: r.meeuws + timestamp: 2025-01-01 12:34:48 + action: update + status: return to src + description: Transaction retunred to source. + correlationId: a3891560-3084-42cb-867c-f289e7cda47d + - transactionAuditTrailId: cc80d58d-6ee7-409a-8c14-b1f807e67c10 + transactionItemId: 34ba3d7c-3ca1-4fa4-aa42-23d4c4fc767b + user: fiko + timestamp: 2025-01-01 12:34:47 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + 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). + value: + transactionAuditTrails: + - transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-07 12:34:59 + action: update + status: re-entered + description: Transaction re-entered. + correlationId: null + - transactionAuditTrailId: b2192e6c-ab79-4000-a04d-d8f4d574a82f + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: r.meeuws + timestamp: 2025-01-04 12:34:54 + action: update + status: return to src + description: Transaction retunred to source. + correlationId: a3891560-3084-42cb-867c-f289e7cda47d + - transactionAuditTrailId: 1d759985-7f1a-48bd-8dd1-efa30ce26423 + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-02 00:34:50 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-01 12:34:47 + action: create + status: created + description: Transaction created. + correlationId: null + href: null + List containing multiple audit trails of failed transactions: + summary: List containing multiple audit trails of failed transactions + description: List containing multiple audit trails of just failed transactions (status = failed). + value: + transactionAuditTrails: + - transactionAuditTrailId: afce35b2-1dff-4ace-98d0-4b9ac405c87d + transactionItemId: d667d293-aa82-4c9e-9b10-77cffc9058a1 + user: fiko + timestamp: 2025-01-01 00:34:51 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + - transactionAuditTrailId: 1d234fc1-eb16-41d3-b2e0-e400e17b017f + transactionItemId: urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b + user: fiko + timestamp: 2025-01-01 00:34:50 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + - transactionAuditTrailId: f4798a84-489d-4533-9dfe-42423c70f6b6 + transactionItemId: e8891be1-1b8a-4a0f-91e2-6b523b6497dd + user: fiko + timestamp: 2025-01-01 00:34:48 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + - transactionAuditTrailId: cc80d58d-6ee7-409a-8c14-b1f807e67c10 + transactionItemId: 34ba3d7c-3ca1-4fa4-aa42-23d4c4fc767b + user: fiko + timestamp: 2025-01-01 00:34:47 + action: update + status: failed + description: Validation XYZ failed. + correlationId: null + href: null /processingfailures: get: summary: Find processing failures.