OVPAY-1518 - Minor documentation improvements.

src/openapi/fiko/fiko-crud.yaml

@@ -1,8 +1,10 @@
 openapi: "3.0.3"
 info:
-  title: ABT FIKO CRUD APIs v2
+  title: FIKO CRUD APIs v2.2
   version: "1.0"
-  description: CRUD APIs for ABT FIKO database v2.
+  description: |
+    CRUD APIs for FIKO resource model v2.2. This version of the API corresponds with version 2.2
+    of the data model in [Lucid Chart](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?page=LL7PJg1Y_GOA>).
 servers:
   - url: https://api.integratielaag.nl/fiko/1.0
 paths:
@@ -11,7 +13,7 @@ paths:
       summary: Find transaction items.
       description: Find transaction items.
       tags:
-        - Transactions v2
+        - Transactions v2.2
       parameters:
         - in: query
           name: transactionItemId
@@ -267,7 +269,7 @@ paths:
       summary: Add one ore more finanicial transaction items in bulk.
       description: Add one ore more finanicial transaction items in bulk.
       tags:
-        - Transactions v2
+        - Transactions v2.2
       requestBody:
         required: true
         content:
@@ -358,7 +360,7 @@ paths:
       summary: Update a transaction item.
       description: Update a transaction item.
       tags:
-        - Transactions v2
+        - Transactions v2.2
       requestBody:
         required: true
         content:
@@ -402,7 +404,7 @@ paths:
   /transactionitems/responsestatus/*:
     get:
       tags:
-        - Transactions v2
+        - Transactions v2.2
       summary: Get the status of the transaction items POST.
       description: Get the status of the asynchronous transaction items POST processing.
       responses:
@@ -460,7 +462,7 @@ paths:
       summary: Add a processing failure.
       description: Add a processing failure.
       tags:
-        - Failures v2
+        - Failures v2.2
       requestBody:
         required: true
         content:
@@ -508,7 +510,7 @@ paths:
       summary: Add an audit trail entry.
       description: Add an audit trail entry.
       tags:
-        - Audit Trail v2
+        - Audit Trail v2.2
       requestBody:
         required: true
         content:
@@ -556,7 +558,7 @@ paths:
       summary: Find audit trail entries.
       description: Find audit trail entries.
       tags:
-        - Audit Trail v2
+        - Audit Trail v2.2
       parameters:
         - in: query
           name: transactionAuditTrailId
@@ -761,7 +763,7 @@ paths:
       summary: Find processing failures.
       description: Find processing failures.
       tags:
-        - Failures v2
+        - Failures v2.2
       parameters:
         - in: query
           name: processingFailureId
@@ -925,7 +927,7 @@ paths:
       summary: Update processing failure.
       description: Update processing failure.
       tags:
-        - Failures v2
+        - Failures v2.2
       requestBody:
         content:
           application/json:
@@ -958,7 +960,7 @@ paths:
       summary: Find booking processes.
       description: Find booking processes.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       parameters:
         - in: query
           name: bookingProcessId
@@ -1014,7 +1016,7 @@ paths:
       summary: Add a booking process.
       description: Add a booking process.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1057,7 +1059,7 @@ paths:
       summary: Update a booking process.
       description: Update a booking process.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1098,7 +1100,7 @@ paths:
       summary: Add booking metadata.
       description: Add booking metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1139,7 +1141,7 @@ paths:
       summary: Find booking metadata.
       description: Find booking metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       parameters:
         - in: query
           name: bookingMetadataId
@@ -1261,7 +1263,7 @@ paths:
       summary: Update booking metadata.
       description: Update booking metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1302,7 +1304,7 @@ paths:
       summary: Add booking group fields.
       description: Add booking group fields.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1342,7 +1344,7 @@ paths:
       summary: Add booking line metadata.
       description: Add booking line metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1404,7 +1406,7 @@ paths:
       summary: Find booking group fields.
       description: Find booking group fields.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       parameters:
         - in: query
           name: bookingGroupFieldId
@@ -1504,7 +1506,7 @@ paths:
       summary: Delete booking group field.
       description: Delete booking group field.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       responses:
         "200":
           description: OK
@@ -1513,7 +1515,7 @@ paths:
       summary: Find booking line metadata.
       description: Find booking line metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       parameters:
         - in: query
           name: bookingLineMetadataId
@@ -1825,7 +1827,7 @@ paths:
       summary: Update booking line metadata.
       description: Update booking line metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       requestBody:
         required: true
         content:
@@ -1856,7 +1858,7 @@ paths:
       summary: Delete booking line metadata.
       description: Delete booking line metadata.
       tags:
-        - Booking Processes v2
+        - Booking Processes v2.2
       responses:
         "200":
           description: OK
@@ -1865,7 +1867,7 @@ paths:
       summary: Find tax metadata.
       description: Find tax metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       parameters:
         - in: query
           name: taxMetadataId
@@ -1953,7 +1955,7 @@ paths:
       summary: Add tax metadata.
       description: Add tax metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -1997,7 +1999,7 @@ paths:
       summary: Update tax metadata.
       description: Update tax metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2028,7 +2030,7 @@ paths:
       summary: Find source metadata.
       description: Find source metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       parameters:
         - in: query
           name: sourceMetadataId
@@ -2115,7 +2117,7 @@ paths:
       summary: Add source metadata.
       description: Add source metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2160,7 +2162,7 @@ paths:
       summary: Update source metadata.
       description: Update source metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2191,7 +2193,7 @@ paths:
       summary: Find accounting period metadata.
       description: Find accounting period metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       parameters:
         - in: query
           name: accountingPeriodMetadataId
@@ -2239,7 +2241,7 @@ paths:
       summary: Add accounting period metadata.
       description: Add accounting period metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2280,7 +2282,7 @@ paths:
       summary: Update accounting period metadata.
       description: Update accounting period metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2311,7 +2313,7 @@ paths:
       summary: Find concession metadata.
       description: Find concession metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       parameters:
         - in: query
           name: concessionMetadataId
@@ -2401,7 +2403,7 @@ paths:
       summary: Add concession metadata.
       description: Add concession metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2446,7 +2448,7 @@ paths:
       summary: Update concession metadata.
       description: Update concession metadata.
       tags:
-        - Metadata v2
+        - Metadata v2.2
       requestBody:
         required: true
         content:
@@ -2480,7 +2482,7 @@ paths:
       description: Find metadata audit trails.
       deprecated: true
       tags:
-        - Audit Trail v2
+        - Audit Trail v2.2
       parameters:
         - in: query
           name: metadataAuditTrailId
@@ -2574,7 +2576,7 @@ paths:
       description: Add metadata audit trail.
       deprecated: true
       tags:
-        - Audit Trail v2
+        - Audit Trail v2.2
       requestBody:
         required: true
         content:
@@ -2593,7 +2595,7 @@ paths:
       summary: Get all concessions.
       description: Get all concessions.
       tags:
-        - References v2
+        - References v2.2
       responses:
         "200":
           description: OK