Upd: audit endpoints

Signed-off-by: George J Padayatti <[email protected]>

openapi/v2023.8.2/definitions/DataAgreementRecordHistory.yaml

@@ -0,0 +1,29 @@
+required:
+  - id
+  - organisationId
+  - dataAgreementId
+  - log
+  - timestamp
+type: object
+properties:
+  id:
+    type: string
+    description: Data agreement record history Id
+  organisationId:
+    type: string
+    description: Organisation Id
+  dataAgreementId:
+    type: string
+    description: Data agreement Id
+  log:
+    type: string
+    description: Log string
+  timestamp:
+    type: string
+    description: Timestamp in ISO 8601 date time format
+example:
+  id: 64e91591e2f6a8000142c665
+  organisationId: 603e683c69dd720001c74f93
+  dataAgreementId: 61e183127c81650001f97d43
+  log: Updated consent value to <Allow> for the purpose <Customer Loyalty Card Issuance> in organization <The Retail Company (Germany)>
+  timestamp: '2023-08-25T20:56:49Z'

openapi/v2023.8.2/index.yaml

@@ -268,7 +268,7 @@ paths:
       $ref: ./paths/serviceCreateIndividualConsentRecord.yaml
     get:
       $ref: ./paths/serviceReadIndividualRecordRead.yaml
-  
+
   /service/individual/record/data-agreement-record/draft:
     post:
       $ref: ./paths/serviceCreateIndividualConsentRecordDraft.yaml
@@ -284,27 +284,34 @@ paths:
   /service/individual/record/data-agreement-record/{dataAgreementRecordId}:
     put:
       $ref: ./paths/serviceUpdateIndividualConsentRecord.yaml
-  
+
   /service/individual/record/data-agreement-record/{dataAgreementRecordId}/signature:
     post:
       $ref: ./paths/serviceCreateIndividualConsentRecordSignature.yaml
     put:
       $ref: ./paths/serviceUpdateIndividualConsentRecordSignature.yaml
-  
+
   /service/individual/record/data-agreement/{dataAgreementId}/all:
     get:
       $ref: ./paths/serviceListIndividualAgreementConsentRecordList.yaml
-
-
+  /service/individual/record/data-agreement-record/history':
+    get:
+      $ref: "./paths/serviceListDataAgreementRecordHistory.yaml"
   /audit/admin/logs:
     get:
       $ref: ./paths/auditAdminLogs.yaml
+  /audit/data-agreement-records:
+    get:
+      $ref: "./paths/auditDataAgreementRecordsList.yaml"
   /audit/data-agreement-record/{dataAgreementRecordId}:
     get:
-      $ref: ./paths/auditConsentRecordRead.yaml
+      $ref: ./paths/auditDataAgreementRecordRead.yaml
+  /audit/data-agreements:
+    get:
+      $ref: "./paths/auditDataAgreementList.yaml"
   /audit/data-agreement/{dataAgreementId}:
     get:
-      $ref: ./paths/auditReadRecord.yaml
+      $ref: ./paths/auditReadDataAgreement.yaml
 servers:
   - description: Development server
     url: https://api.bb-consent.dev/v2

openapi/v2023.8.2/parameters/dataAgreementIdQueryParam.yaml

@@ -0,0 +1,5 @@
+description: Unique ID of an object
+in: query
+name: dataAgreementId
+schema:
+  type: string

openapi/v2023.8.2/parameters/dataAgreementRecordIdQueryParam.yaml

@@ -0,0 +1,5 @@
+description: Unique ID of an object
+in: query
+name: dataAgreementRecordId
+schema:
+  type: string

openapi/v2023.8.2/parameters/individualIdQueryParam.yaml

@@ -0,0 +1,5 @@
+description: Unique ID of an object
+in: query
+name: individualId
+schema:
+  type: string

openapi/v2023.8.2/parameters/lawfulBasisQueryParam.yaml

@@ -0,0 +1,13 @@
+description: Unique ID of an object
+in: query
+name: lawfulBasis
+schema:
+  type: string
+  description: "Lawful basis of the agreement - consent / legal_obligation / contract / vital_interest / public_task / legitimate_interest"
+  enum:
+    - consent
+    - legal_obligation
+    - contract
+    - vital_interest
+    - public_task
+    - legitimate_interest

openapi/v2023.8.2/paths/auditDataAgreementList.yaml

@@ -0,0 +1,30 @@
+description: LIST - Fetch all data agreements stored in the system
+operationId: auditDataAgreementList
+parameters:
+  - $ref: "../parameters/offset.yaml"
+  - $ref: "../parameters/limit.yaml"
+responses:
+  "200":
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            dataAgreements:
+              items:
+                $ref: ../definitions/DataAgreement.yaml
+              type: array
+            pagination:
+              $ref: "../definitions/Pagination.yaml"
+    description: ""
+  "400":
+    description: bad input parameter
+security:
+  - BearerAuth: []
+summary: LIST - Fetch all data agreements stored in the system
+tags:
+  - audit
+x-specification-crudl-model: ""
+x-specification-pii-or-sensitive: "False"
+x-specification-scenario: ""
+x-specification-usecase: UC-C-PIC-AT-001, UC-C-PIC-AT-003

openapi/v2023.8.2/paths/auditConsentRecordRead.yaml → openapi/v2023.8.2/paths/auditDataAgreementRecordRead.yaml

@@ -1,18 +1,16 @@
 description: READ - Fetch a single data agreement record
 operationId: auditConsentRecordRead
 parameters:
-  - description: Unique ID of an object
-    in: path
-    name: dataAgreementRecordId
-    required: true
-    schema:
-      type: string
+  - $ref: "../parameters/dataAgreementRecordId.yaml"
 responses:
   "200":
     content:
       application/json:
         schema:
-          $ref: ../definitions/DataAgreementRecord.yaml
+          type: object
+          properties:
+            dataAgreementRecord:
+              $ref: ../definitions/DataAgreementRecord.yaml
     description: ""
   "400":
     description: bad input parameter

openapi/v2023.8.2/paths/auditDataAgreementRecordsList.yaml

@@ -0,0 +1,34 @@
+description: LIST - Fetch all data agreement records
+operationId: auditDataAgreementRecordsList
+parameters:
+  - $ref: "../parameters/offset.yaml"
+  - $ref: "../parameters/limit.yaml"
+  - $ref: "../parameters/lawfulBasisQueryParam.yaml"
+  - $ref: "../parameters/individualIdQueryParam.yaml"
+  - $ref: "../parameters/dataAgreementIdQueryParam.yaml"
+  - $ref: "../parameters/dataAgreementRecordIdQueryParam.yaml"
+responses:
+  "200":
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            dataAgreementRecords:
+              items:
+                $ref: ../definitions/DataAgreementRecord.yaml
+              type: array
+            pagination:
+              $ref: "../definitions/Pagination.yaml"
+    description: ""
+  "400":
+    description: bad input parameter
+security:
+  - BearerAuth: []
+summary: LIST - Fetch all data agreement records
+tags:
+  - audit
+x-specification-crudl-model: ""
+x-specification-pii-or-sensitive: "False"
+x-specification-scenario: ""
+x-specification-usecase: UC-C-PIC-AT-003

openapi/v2023.8.2/paths/auditReadRecord.yaml → openapi/v2023.8.2/paths/auditReadDataAgreement.yaml

@@ -1,27 +1,25 @@
 description: READ - Fetch a single data agreement.
 operationId: auditReadRecord
 parameters:
-- description: Unique ID of an object
-  in: path
-  name: dataAgreementId
-  required: true
-  schema:
-    type: string
+  - $ref: "../parameters/dataAgreementId.yaml"
 responses:
-  '200':
+  "200":
     content:
       application/json:
         schema:
-          $ref: ../definitions/DataAgreement.yaml
-    description: ''
-  '400':
+          type: object
+          properties:
+            dataAgreement:
+              $ref: ../definitions/DataAgreement.yaml
+    description: ""
+  "400":
     description: bad input parameter
 security:
   - BearerAuth: []
 summary: READ - Fetch a single data agreement.
 tags:
-- audit
-x-specification-crudl-model: ''
-x-specification-pii-or-sensitive: 'False'
-x-specification-scenario: ''
+  - audit
+x-specification-crudl-model: ""
+x-specification-pii-or-sensitive: "False"
+x-specification-scenario: ""
 x-specification-usecase: UC-C-PIC-AT-001, UC-C-PIC-AT-003

openapi/v2023.8.2/paths/serviceListDataAgreementRecordHistory.yaml

@@ -0,0 +1,23 @@
+operationId: serviceListDataAgreementRecordHistory
+tags:
+  - service
+description: LIST - Fetch all data agreement record history
+summary: LIST - Fetch all data agreement record history
+parameters:
+  - $ref: "../parameters/offset.yaml"
+  - $ref: "../parameters/limit.yaml"
+responses:
+  "200":
+    description: OK
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            dataAgreementRecordHistory:
+              $ref: "../definitions/DataAgreementRecordHistory.yaml"
+            pagination:
+              $ref: "../definitions/Pagination.yaml"
+deprecated: false
+security:
+  - BearerAuth: []