HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

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

Browse Source
This commit is contained in:
Bas Boterman 2025-02-20 13:11:36 +01:00
parent d496370cbe
commit 40795f380a
1 changed files with 42 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/openapi/fiko/fiko-crud.yaml
View File

@ -467,6 +467,20 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresPostRequestBody" $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: responses:
"201": "201":
description: Created description: Created
@ -474,6 +488,12 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresPostResponseBody" $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: /transactionitems/{transactionItemId}/transactionaudittrails:
parameters: parameters:
- in: path - in: path
@ -662,7 +682,7 @@ paths:
href: null href: null
? List containing multiple transaction audit trails of one transaction item ? List containing multiple transaction audit trails of one transaction item
: summary: List containing multiple 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: value:
transactionAuditTrails: transactionAuditTrails:
- transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e - transactionAuditTrailId: d571ff7c-eaa5-428a-9bc3-5a0fa3e5ee2e
@ -833,7 +853,7 @@ paths:
timestamp: 2022-01-01 00:00:00 timestamp: 2022-01-01 00:00:00
element: costType element: costType
value: 901 value: 901
reasonCode: 004 reasonCode: "004"
reasonDescription: Cost type does not exist. reasonDescription: Cost type does not exist.
resolved: false resolved: false
change: null change: null
@ -842,7 +862,7 @@ paths:
timestamp: 2025-01-01 00:43:01 timestamp: 2025-01-01 00:43:01
element: costCenter element: costCenter
value: 84955 value: 84955
reasonCode: 002 reasonCode: "002"
reasonDescription: Cost center does not exist. reasonDescription: Cost center does not exist.
resolved: true resolved: true
change: Adapt config change: Adapt config
@ -851,7 +871,7 @@ paths:
timestamp: 2025-01-01 00:43:01 timestamp: 2025-01-01 00:43:01
element: department element: department
value: 1337 value: 1337
reasonCode: 001 reasonCode: "001"
reasonDescription: Department does not exist. reasonDescription: Department does not exist.
resolved: true resolved: true
change: Adapt config change: Adapt config
@ -868,7 +888,7 @@ paths:
timestamp: 2022-01-01 00:00:00 timestamp: 2022-01-01 00:00:00
element: occuredOn element: occuredOn
value: 2027-01-01 value: 2027-01-01
reasonCode: 009 reasonCode: "009"
reasonDescription: Transaction date is in the future reasonDescription: Transaction date is in the future
resolved: false resolved: false
change: null change: null
@ -877,7 +897,7 @@ paths:
timestamp: 2025-01-01 00:43:01 timestamp: 2025-01-01 00:43:01
element: costCenter element: costCenter
value: 84955 value: 84955
reasonCode: 002 reasonCode: "002"
reasonDescription: Cost center does not exist. reasonDescription: Cost center does not exist.
resolved: false resolved: false
change: null change: null
@ -886,7 +906,7 @@ paths:
timestamp: 2025-01-01 00:43:01 timestamp: 2025-01-01 00:43:01
element: department element: department
value: 1337 value: 1337
reasonCode: 001 reasonCode: "001"
reasonDescription: Department does not exist. reasonDescription: Department does not exist.
resolved: false resolved: false
change: null change: null
@ -911,6 +931,15 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresPatchRequestBody" $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: responses:
"200": "200":
description: OK description: OK
@ -918,6 +947,12 @@ paths:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/ProcessingFailuresPatchResponseBody" $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: /bookingprocesses:
get: get:
summary: Find booking processes. summary: Find booking processes.