src/openapi/fiko/fiko-crud.yaml

@@ -563,6 +563,34 @@ paths:
                 $ref: "#/components/schemas/unavailable"
               example:
                 { "productMetadataId": "39a87c2a-9011-4dfd-b35e-1245a98c2e61" }
+  /productmetadata/{productMetadataId}/metadataaudittrails:
+    parameters:
+      - in: path
+        name: productMetadataId
+        schema:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        required: true
+        description: The id of the product metadata.
+    post:
+      summary: Add metadata audit trail.
+      description: Add metadata audit trail.
+      tags:
+        - Audit Trail v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postMetadataAuditTrailResponse"
   /contraaccountmetadata:
     get:
       summary: Find contra account metadata.
@@ -672,6 +700,34 @@ paths:
                 {
                   "contraAccountMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
                 }
+  /contraaccountmetadata/{contraAccountMetadataId}/metadataaudittrails:
+    parameters:
+      - in: path
+        name: contraAccountMetadataId
+        schema:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        required: true
+        description: The id of the contra account metadata.
+    post:
+      summary: Add metadata audit trail.
+      description: Add metadata audit trail.
+      tags:
+        - Audit Trail v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postMetadataAuditTrailResponse"
   /taxmetadata:
     get:
       summary: Find tax metadata.
@@ -811,6 +867,34 @@ paths:
                 $ref: "#/components/schemas/unavailable"
               example:
                 { "taxMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" }
+  /taxmetadata/{taxMetadataId}/metadataaudittrails:
+    parameters:
+      - in: path
+        name: taxMetadataId
+        schema:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        required: true
+        description: The id of the contra account metadata.
+    post:
+      summary: Add metadata audit trail.
+      description: Add metadata audit trail.
+      tags:
+        - Audit Trail v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postMetadataAuditTrailResponse"
   /sourcemetadata:
     get:
       summary: Find source metadata.
@@ -961,6 +1045,34 @@ paths:
                 $ref: "#/components/schemas/unavailable"
               example:
                 { "sourceMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf" }
+  /sourcemetadata/{sourceMetadataId}/metadataaudittrails:
+    parameters:
+      - in: path
+        name: sourceMetadataId
+        schema:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        required: true
+        description: The id of the contra account metadata.
+    post:
+      summary: Add metadata audit trail.
+      description: Add metadata audit trail.
+      tags:
+        - Audit Trail v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postMetadataAuditTrailResponse"
   /accountingperiodmetadata:
     get:
       summary: Find accounting period metadata.
@@ -1058,6 +1170,34 @@ paths:
                 {
                   "accountingPeriodMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
                 }
+  /accountingperiodmetadata/{accountingPeriodMetadataId}/metadataaudittrails:
+    parameters:
+      - in: path
+        name: accountingPeriodMetadataId
+        schema:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        required: true
+        description: The id of the contra account metadata.
+    post:
+      summary: Add metadata audit trail.
+      description: Add metadata audit trail.
+      tags:
+        - Audit Trail v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postMetadataAuditTrailResponse"
   /concessionmetadata:
     get:
       summary: Find concession metadata.
@@ -1185,6 +1325,143 @@ paths:
                 {
                   "concessionMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
                 }
+  /concessionmetadata/{concessionMetadataId}/metadataaudittrails:
+    parameters:
+      - in: path
+        name: concessionMetadataId
+        schema:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+        required: true
+        description: The id of the product metadata.
+    post:
+      summary: Add metadata audit trail.
+      description: Add metadata audit trail.
+      tags:
+        - Audit Trail v2
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/postMetadataAuditTrailRequest"
+      responses:
+        "201":
+          description: Created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/postMetadataAuditTrailResponse"
+  /metadataaudittrails:
+    get:
+      summary: Find metadata audit trails.
+      description: Find metadata audit trails.
+      tags:
+        - Audit Trail v2
+      parameters:
+        - in: query
+          name: metadataAuditTrailId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          required: true
+          description: The id of the metadata audit trail.
+        - in: query
+          name: productMetadataId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          description: The id of the product metadata.
+        - in: query
+          name: concessionMetadataId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          description: The id of the concession metadata.
+        - in: query
+          name: contraAccountMetadataId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          description: The id of the contra account metadata.
+        - in: query
+          name: taxMetadataId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          description: The id of the tax metadata.
+        - in: query
+          name: sourceMetadataId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          description: The id of the source metadata.
+        - in: query
+          name: accountingPeriodMetadataId
+          schema:
+            type: string
+            format: uuid
+            example: 37a8095b-19db-498f-9349-5f37d21c5bdf
+          description: The id of the accounting period metadata.
+        - in: query
+          name: user
+          schema:
+            type: string
+            example: rmeeuws
+          description: The username of the user.
+        - in: query
+          name: timestampBefore
+          schema:
+            type: string
+            example: 2022-01-01 00:00:00
+          description: The timestamp before the event occured.
+        - in: query
+          name: timestampAfter
+          schema:
+            type: string
+            example: 2022-01-01 00:00:00
+          description: The timestamp after the event occured.
+        - in: query
+          name: correlationId
+          schema:
+            type: string
+            example: a3891560-3084-42cb-867c-f289e7cda47d
+          description: The correlation id of the event.
+      responses:
+        "200":
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/unavailable"
+              example:
+                {
+                  "metadataAuditTrailId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
+                  "productMetadataId": "37a8095b-19db-498f-9349-5f37d21c5bdf",
+                  "concessionMetadataId": null,
+                  "contraAccountMetadataId": null,
+                  "taxMetadataId": null,
+                  "sourceMetadataId": null,
+                  "accountingPeriodMetadataId": null,
+                  "user": "rmeeuws",
+                  "timestamp": "2022-01-01 00:00:00",
+                  "correlationId": "a3891560-3084-42cb-867c-f289e7cda47d",
+                  "metadataChanges": [
+                    {
+                      "metadataChangesId": "43a481a7-0845-460f-b44a-b4112cc2e193",
+                      "fieldName": "businessOwner",
+                      "oldValue": "Corneel Verstoep",
+                      "newValue": "Jan-Willem Vermeij",
+                    }
+                  ]
+                }
   /concessions:
     get:
       summary: Get all concessions.
@@ -1274,3 +1551,38 @@ components:
             example:
               - "/account/12345"
               - "/account/67890"
+    postMetadataAuditTrailRequest:
+      type: object
+      properties:
+        user:
+          type: string
+          example: rmeeuws
+        timestamp:
+          type: string
+          format: date-time
+          example: 2024-10-04T00:00:00
+        correlationId:
+          type: string
+          format: uuid
+          example: a03cd0c2-38b5-4619-b9e3-d6e5b842e127
+        metadataChanges:
+          type: array
+          items:
+            type: object
+            properties:
+              fieldName:
+                type: string
+                example: businessOwner
+              oldValue:
+                type: string
+                example: Corneel Verstoep
+              newValue:
+                type: string
+                example: Jan-Willem Vermeij
+    postMetadataAuditTrailResponse:
+      type: object
+      properties:
+        metadataAuditTrailId:
+          type: string
+          format: uuid
+          example: 37a8095b-19db-498f-9349-5f37d21c5bdf