Upd: Remove consentRecord.yaml and replace with ConsentRecord.yaml

Signed-off-by: George J Padayatti <[email protected]>
decentralised-dataexchange · Nov 21, 2023 · 7922a2f · 7922a2f
1 parent cb150c4
commit 7922a2f
Show file tree

Hide file tree

Showing 15 changed files with 54 additions and 151 deletions.
diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml
@@ -382,7 +382,7 @@ components:
     ConsentRecord:
       type: object
       title: ConsentRecord
-      description: 'A Consent Record expresses consent (as defined in this building block''s specification) to a single DataAgreement. There must be a UNIQUE constraint on (agreementRevision, individual)'
+      description: 'A consent record expresses consent (as defined in this building block''s specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)'
       x-not-in-database: false
       required:
         - id
@@ -394,21 +394,21 @@ components:
           format: ''
           example: ''
           description: 'Objects may be passed back by some API endpoints without an id (PK), denoting that they are a "draft", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated.'
-        agreement:
-          $ref: '#/components/schemas/DataAgreement'
+        dataAgreementId:
+          type: string
           x-fk-model: DataAgreement
           description: The DataAgreement to which consent has been given
-        agreementRevision:
-          $ref: '#/components/schemas/Revision'
+        dataAgreementRevisionId:
+          type: string
           x-fk-model: Revision
-          description: The Revision of the agreement which consent has been given to
-        agreementRevisionHash:
+          description: The Revision of the data agreement which consent has been given to
+        dataAgreementRevisionHash:
           type: string
           format: ''
           example: ''
           description: Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement.
-        individual:
-          $ref: '#/components/schemas/Individual'
+        individualId:
+          type: string
           x-fk-model: Individual
           description: The Individual who has signed this consent record
         optIn:
@@ -421,8 +421,11 @@ components:
           format: ''
           example: ''
           description: 'The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed'
-        signature:
-          $ref: '#/components/schemas/Signature'
+          enum:
+            - unsigned
+            - signed
+        signatureId:
+          type: string
           x-fk-model: Signature
           description: 'A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?'
     ConsentRecordFilter:
@@ -3271,7 +3274,7 @@ paths:
                   consentRecords:
                     type: array
                     items:
-                      $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                      $ref: '#/components/schemas/ConsentRecord'
                   pagination:
                     $ref: '#/components/schemas/Pagination'
           description: ''
@@ -3301,7 +3304,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                    $ref: '#/components/schemas/ConsentRecord'
                   revision:
                     $ref: '#/components/schemas/Revision'
           description: ''
@@ -3334,7 +3337,7 @@ paths:
                   consentRecords:
                     type: array
                     items:
-                      $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                      $ref: '#/components/schemas/ConsentRecord'
                   pagination:
                     $ref: '#/components/schemas/Pagination'
           description: ''
@@ -3365,7 +3368,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                    $ref: '#/components/schemas/ConsentRecord'
                   revision:
                     $ref: '#/components/schemas/Revision'
           description: ''
@@ -3394,7 +3397,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                    $ref: '#/components/schemas/ConsentRecord'
           description: ''
         '400':
           description: bad input parameter
@@ -3439,7 +3442,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                    $ref: '#/components/schemas/ConsentRecord'
                   signature:
                     $ref: '#/components/schemas/Signature'
           description: ''
@@ -3466,7 +3469,7 @@ paths:
             schema:
               properties:
                 consentRecord:
-                  $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                  $ref: '#/components/schemas/ConsentRecord'
                   description: An object of type DataAgreementRecord
                 signature:
                   $ref: '#/components/schemas/Signature'
@@ -3483,7 +3486,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                    $ref: '#/components/schemas/ConsentRecord'
                   revision:
                     $ref: '#/components/schemas/Revision'
                   signature:
@@ -3516,7 +3519,7 @@ paths:
                 properties:
                   consentRecords:
                     items:
-                      $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                      $ref: '#/components/schemas/ConsentRecord'
                     type: array
                   pagination:
                     $ref: '#/components/schemas/Pagination'
@@ -3596,7 +3599,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                    $ref: '#/components/schemas/ConsentRecord'
                   revision:
                     $ref: '#/components/schemas/Revision'
           description: ''
@@ -3705,7 +3708,7 @@ paths:
                 properties:
                   consentRecords:
                     items:
-                      $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                      $ref: '#/components/schemas/ConsentRecord'
                     type: array
                   pagination:
                     $ref: '#/components/schemas/Pagination'
@@ -4111,7 +4114,7 @@ paths:
                   consentRecords:
                     items:
                       allOf:
-                        - $ref: '#/paths/~1audit~1consent-record~1%7BconsentRecordId%7D/get/responses/200/content/application~1json/schema/properties/consentRecord'
+                        - $ref: '#/components/schemas/ConsentRecord'
                         - type: object
                           properties:
                             timestamp:
@@ -4171,54 +4174,7 @@ paths:
                 type: object
                 properties:
                   consentRecord:
-                    type: object
-                    title: ConsentRecord
-                    description: 'A consent record expresses consent (as defined in this building block''s specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)'
-                    x-not-in-database: false
-                    required:
-                      - id
-                      - agreementRevisionHash
-                      - state
-                    properties:
-                      id:
-                        type: string
-                        format: ''
-                        example: ''
-                        description: 'Objects may be passed back by some API endpoints without an id (PK), denoting that they are a "draft", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated.'
-                      dataAgreementId:
-                        type: string
-                        x-fk-model: DataAgreement
-                        description: The DataAgreement to which consent has been given
-                      dataAgreementRevisionId:
-                        type: string
-                        x-fk-model: Revision
-                        description: The Revision of the data agreement which consent has been given to
-                      dataAgreementRevisionHash:
-                        type: string
-                        format: ''
-                        example: ''
-                        description: Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement.
-                      individualId:
-                        type: string
-                        x-fk-model: Individual
-                        description: The Individual who has signed this consent record
-                      optIn:
-                        type: boolean
-                        format: ''
-                        example: ''
-                        description: 'True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent).'
-                      state:
-                        type: string
-                        format: ''
-                        example: ''
-                        description: 'The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed'
-                        enum:
-                          - unsigned
-                          - signed
-                      signatureId:
-                        type: string
-                        x-fk-model: Signature
-                        description: 'A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?'
+                    $ref: '#/components/schemas/ConsentRecord'
           description: ''
         '400':
           description: bad input parameter

diff --git a/openapi/v2023.11.1/definitions/ConsentRecord.yaml b/openapi/v2023.11.1/definitions/ConsentRecord.yaml
@@ -1,6 +1,6 @@
 type: object
 title: ConsentRecord
-description: "A Consent Record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (agreementRevision, individual)"
+description: "A consent record expresses consent (as defined in this building block's specification) to a single DataAgreement. There must be a UNIQUE constraint on (data agreement revision, individual)"
 x-not-in-database: false
 
 required:
@@ -14,24 +14,24 @@ properties:
     example: ""
     description: 'Objects may be passed back by some API endpoints without an id (PK), denoting that they are a "draft", i.e. a ConsentRecord that is not yet stored in the database and only exist in transit. Draft ConsentRecords do not have a Revision, but if paired up with a Signature, a valid Revision should be generated.'
 
-  agreement:
-    $ref: "./DataAgreement.yaml"
+  dataAgreementId:
+    type: string
     x-fk-model: "DataAgreement"
     description: "The DataAgreement to which consent has been given"
 
-  agreementRevision:
-    $ref: "./Revision.yaml"
+  dataAgreementRevisionId:
+    type: string
     x-fk-model: "Revision"
-    description: "The Revision of the agreement which consent has been given to"
+    description: "The Revision of the data agreement which consent has been given to"
 
-  agreementRevisionHash:
+  dataAgreementRevisionHash:
     type: string
     format: ""
     example: ""
     description: "Copy of the revision hash. The hash is the included in the signature and ensures against tampering with the original agreement."
 
-  individual:
-    $ref: "./Individual.yaml"
+  individualId:
+    type: string
     x-fk-model: "Individual"
     description: "The Individual who has signed this consent record"
 
@@ -46,8 +46,11 @@ properties:
     format: ""
     example: ""
     description: "The state field is used to record state changes after-the-fact. It is maintained by the Consent BB itself. Valid states: unsigned/pending more signatures/signed"
+    enum:
+      - unsigned
+      - signed
 
-  signature:
-    $ref: "./Signature.yaml"
+  signatureId:
+    type: string
     x-fk-model: "Signature"
     description: "A signature that hashes all the values of the consent record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"
diff --git a/openapi/v2023.11.1/definitions/consentRecord.yaml b/openapi/v2023.11.1/definitions/consentRecord.yaml
diff --git a/openapi/v2023.11.1/paths/auditDataAgreementRecordRead.yaml b/openapi/v2023.11.1/paths/auditDataAgreementRecordRead.yaml
@@ -10,7 +10,7 @@ responses:
           type: object
           properties:
             consentRecord:
-              $ref: ../definitions/consentRecord.yaml
+              $ref: ../definitions/ConsentRecord.yaml
     description: ""
   "400":
     description: bad input parameter

diff --git a/openapi/v2023.11.1/paths/auditDataAgreementRecordsList.yaml b/openapi/v2023.11.1/paths/auditDataAgreementRecordsList.yaml
@@ -15,7 +15,7 @@ responses:
             consentRecords:
               items:
                 allOf:
-                  - $ref: ../definitions/consentRecord.yaml
+                  - $ref: ../definitions/ConsentRecord.yaml
                   - $ref: "../definitions/ListDataAgreementRecordExtras.yaml"
               type: array
             pagination:

diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecord.yaml
@@ -14,7 +14,7 @@ responses:
           type: object
           properties:
             consentRecord:
-              $ref: ../definitions/consentRecord.yaml
+              $ref: ../definitions/ConsentRecord.yaml
             revision:
               $ref: ../definitions/Revision.yaml
     description: ""

diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordAndSignature.yaml
@@ -9,7 +9,7 @@ requestBody:
       schema:
         properties:
           consentRecord:
-            $ref: ../definitions/consentRecord.yaml
+            $ref: ../definitions/ConsentRecord.yaml
             description: An object of type DataAgreementRecord
           signature:
             $ref: ../definitions/Signature.yaml
@@ -26,7 +26,7 @@ responses:
           type: object
           properties:
             consentRecord:
-              $ref: ../definitions/consentRecord.yaml
+              $ref: ../definitions/ConsentRecord.yaml
             revision:
               $ref: ../definitions/Revision.yaml
             signature:

diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordDraft.yaml
@@ -30,7 +30,7 @@ responses:
           type: object
           properties:
             consentRecord:
-              $ref: ../definitions/consentRecord.yaml
+              $ref: ../definitions/ConsentRecord.yaml
             signature:
               $ref: ../definitions/Signature.yaml
     description: ""

diff --git a/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml
@@ -14,7 +14,7 @@ responses:
           properties:
             consentRecords:
               items:
-                $ref: ../definitions/consentRecord.yaml
+                $ref: ../definitions/ConsentRecord.yaml
               type: array
             pagination:
               $ref: "../definitions/Pagination.yaml"