Upd: Add individualId to the header

Signed-off-by: George J Padayatti <[email protected]>
decentralised-dataexchange · Nov 20, 2023 · 15f0fba · 15f0fba
1 parent e329671
commit 15f0fba
Show file tree

Hide file tree

Showing 28 changed files with 175 additions and 105 deletions.
diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml
@@ -2996,6 +2996,8 @@ paths:
       deprecated: false
       description: Read organization cover image
       operationId: serviceReadOrganisationCoverImage
+      parameters:
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           headers: {}
@@ -3008,6 +3010,8 @@ paths:
       deprecated: false
       description: Read organization logo image
       operationId: serviceReadOrganisationLogoImage
+      parameters:
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           headers: {}
@@ -3026,6 +3030,7 @@ paths:
           required: true
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3069,6 +3074,8 @@ paths:
       deprecated: false
       description: Read organization
       operationId: serviceReadOrganisation
+      parameters:
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3110,6 +3117,7 @@ paths:
         - $ref: '#/paths/~1config~1data-agreements/get/parameters/0'
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3146,6 +3154,7 @@ paths:
           required: true
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3180,6 +3189,7 @@ paths:
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
         - $ref: '#/paths/~1config~1data-agreements/get/parameters/0'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3217,6 +3227,7 @@ paths:
           schema:
             type: string
         - $ref: '#/paths/~1config~1data-agreements/get/parameters/0'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3247,6 +3258,7 @@ paths:
       parameters:
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3278,6 +3290,7 @@ paths:
       operationId: serviceVerificationAgreementConsentRecordRead
       parameters:
         - $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/parameters/0'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3308,6 +3321,7 @@ paths:
       parameters:
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3340,6 +3354,7 @@ paths:
       parameters:
         - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0'
         - $ref: '#/paths/~1config~1data-agreements/get/parameters/0'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3368,6 +3383,7 @@ paths:
       operationId: serviceReadIndividualRecordRead
       parameters:
         - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3412,6 +3428,7 @@ paths:
           required: false
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3439,7 +3456,8 @@ paths:
     post:
       description: CREATE - Create a paired consent record and signature object. Returns the same objects with the PK defined.
       operationId: serviceCreateIndividualConsentRecordAndSignature
-      parameters: []
+      parameters:
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       requestBody:
         content:
           application/json:
@@ -3486,6 +3504,7 @@ paths:
       parameters:
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3515,7 +3534,8 @@ paths:
     delete:
       description: 'DELETE - Cascading delete operation for Right To Be Forgotten, deletes all data agreement records that shall not be retained and have a "forgettable" DataAgreement. May also delete an unsigned consent record, for instance in cases where the user exits the signing process.'
       operationId: serviceDeleteAllRecords
-      parameters: []
+      parameters:
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           description: ''
@@ -3554,6 +3574,7 @@ paths:
           required: false
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       requestBody:
         content:
           application/json:
@@ -3599,6 +3620,7 @@ paths:
           required: true
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3630,6 +3652,7 @@ paths:
           required: true
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       requestBody:
         content:
           application/json:
@@ -3670,6 +3693,7 @@ paths:
         - $ref: '#/paths/~1audit~1data-agreement~1%7BdataAgreementId%7D/get/parameters/0'
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           content:
@@ -3705,6 +3729,7 @@ paths:
       parameters:
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           description: OK
@@ -3805,6 +3830,7 @@ paths:
           required: true
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       x-specification-usecase: ''
       x-specification-scenario: ''
       x-specification-pii-or-sensitive: 'True'
@@ -3838,6 +3864,7 @@ paths:
           required: true
           schema:
             type: string
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       x-specification-usecase: ''
       x-specification-scenario: ''
       x-specification-pii-or-sensitive: 'True'
@@ -3881,6 +3908,12 @@ paths:
       parameters:
         - $ref: '#/paths/~1config~1policies/get/parameters/1'
         - $ref: '#/paths/~1config~1policies/get/parameters/2'
+        - in: header
+          name: X-ConsentBB-IndividualId
+          required: true
+          schema:
+            type: string
+          description: Individual Id
       x-specification-usecase: ''
       x-specification-scenario: ''
       x-specification-pii-or-sensitive: 'True'
@@ -3910,6 +3943,8 @@ paths:
       deprecated: false
       description: Get organization image
       operationId: serviceReadOrganisationImage
+      parameters:
+        - $ref: '#/paths/~1service~1individuals/get/parameters/2'
       responses:
         '200':
           headers: {}

diff --git a/openapi/v2023.11.1/parameters/individualIdHeader.yaml b/openapi/v2023.11.1/parameters/individualIdHeader.yaml
@@ -0,0 +1,6 @@
+in: header
+name: X-ConsentBB-IndividualId
+required: true
+schema:
+  type: string
+description: Individual Id
diff --git a/openapi/v2023.11.1/paths/serviceAgreementList.yaml b/openapi/v2023.11.1/paths/serviceAgreementList.yaml
@@ -4,6 +4,7 @@ parameters:
   - $ref: "../parameters/revisionId.yaml"
   - $ref: "../parameters/offset.yaml"
   - $ref: "../parameters/limit.yaml"
+  - $ref: "../parameters/individualIdHeader.yaml"
 responses:
   "200":
     content:

diff --git a/openapi/v2023.11.1/paths/serviceAgreementRead.yaml b/openapi/v2023.11.1/paths/serviceAgreementRead.yaml
@@ -1,14 +1,15 @@
 description: READ - Read data agreement
 operationId: serviceAgreementRead
 parameters:
-- description: Unique ID of an object
-  in: path
-  name: dataAgreementId
-  required: true
-  schema:
-    type: string
+  - description: Unique ID of an object
+    in: path
+    name: dataAgreementId
+    required: true
+    schema:
+      type: string
+  - $ref: "../parameters/individualIdHeader.yaml"
 responses:
-  '200':
+  "200":
     content:
       application/json:
         schema:
@@ -20,15 +21,15 @@ responses:
                 $ref: ../definitions/DataAgreement.yaml
               revision:
                 $ref: ../definitions/Revision.yaml
-    description: ''
-  '400':
+    description: ""
+  "400":
     description: bad input parameter
 security:
   - BearerAuth: []
 summary: READ - Read data agreement
 tags:
-- service
+  - service
 x-specification-crudl-model: DataAgreement
-x-specification-pii-or-sensitive: 'False'
-x-specification-scenario: ''
+x-specification-pii-or-sensitive: "False"
+x-specification-scenario: ""
 x-specification-usecase: UC-C-PIC-A-003
diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml
@@ -5,6 +5,7 @@ operationId: serviceCreateIndividualConsentRecord
 parameters:
   - $ref: "../parameters/dataAgreementId.yaml"
   - $ref: "../parameters/revisionId.yaml"
+  - $ref: "../parameters/individualIdHeader.yaml"
 responses:
   "200":
     content:

diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml
@@ -1,7 +1,8 @@
 description: CREATE - Create a paired consent record and signature object. Returns
   the same objects with the PK defined.
 operationId: serviceCreateIndividualConsentRecordAndSignature
-parameters: []
+parameters:
+  - $ref: "../parameters/individualIdHeader.yaml"
 requestBody:
   content:
     application/json:

diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml
@@ -1,27 +1,29 @@
-description: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without
+description:
+  CREATE - Create a DRAFT (unsaved) consent record and signature objects (without
   a PK) for a given dataAgreementId.
 operationId: serviceCreateIndividualConsentRecordDraft
 parameters:
-- description: An object with id individualId
-  in: query
-  name: individualId
-  required: true
-  schema:
-    type: string
-- description: An object with id dataAgreementId
-  in: query
-  name: dataAgreementId
-  required: true
-  schema:
-    type: string
-- description: An object with id revisionId
-  in: query
-  name: revisionId
-  required: false
-  schema:
-    type: string
+  - description: An object with id individualId
+    in: query
+    name: individualId
+    required: true
+    schema:
+      type: string
+  - description: An object with id dataAgreementId
+    in: query
+    name: dataAgreementId
+    required: true
+    schema:
+      type: string
+  - description: An object with id revisionId
+    in: query
+    name: revisionId
+    required: false
+    schema:
+      type: string
+  - $ref: "../parameters/individualIdHeader.yaml"
 responses:
-  '200':
+  "200":
     content:
       application/json:
         schema:
@@ -31,16 +33,17 @@ responses:
               $ref: ../definitions/consentRecord.yaml
             signature:
               $ref: ../definitions/Signature.yaml
-    description: ''
-  '400':
+    description: ""
+  "400":
     description: bad input parameter
 security:
   - BearerAuth: []
-summary: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without
+summary:
+  CREATE - Create a DRAFT (unsaved) consent record and signature objects (without
   a PK) for a given dataAgreementId.
 tags:
-- service
-x-specification-crudl-model: ''
-x-specification-pii-or-sensitive: 'True'
-x-specification-scenario: '1.2'
+  - service
+x-specification-crudl-model: ""
+x-specification-pii-or-sensitive: "True"
+x-specification-scenario: "1.2"
 x-specification-usecase: UC-C-PIC-I-002