Skip to content

Commit

Permalink
Upd: Replace consent record with data agreement record
Browse files Browse the repository at this point in the history
Signed-off-by: George J Padayatti <[email protected]>
  • Loading branch information
georgepadayatti committed Oct 22, 2023
1 parent 3a793dc commit 1cce920
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions openapi/v2023.8.2/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ components:
individual:
$ref: '#/components/schemas/Individual'
x-fk-model: Individual
description: The Individual who has signed this consent record
description: The Individual who has signed this data agreement record
optIn:
type: boolean
format: ''
Expand All @@ -372,7 +372,7 @@ components:
signature:
$ref: '#/components/schemas/Signature'
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?'
description: 'A signature that hashes all the values of the data agreement record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?'
ConsentRecordFilter:
type: object
title: ConsentRecordFilter
Expand Down Expand Up @@ -705,7 +705,7 @@ components:
type: string
format: ''
example: ''
description: 'A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)'
description: 'A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a data agreement record, an agreement, policy etc)'
StatusReadiness:
type: object
description: This model is not stored in a database. It describes the status of the Building Block while running. Returns immediately. API should not be public.
Expand Down Expand Up @@ -3499,7 +3499,7 @@ paths:
x-specification-usecase: UC-C-PIC-I-001
/service/individual/record/data-agreement-record/draft:
post:
description: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without a PK) for a given dataAgreementId.
description: CREATE - Create a DRAFT (unsaved) data agreement record and signature objects (without a PK) for a given dataAgreementId.
operationId: serviceCreateIndividualConsentRecordDraft
parameters:
- description: An object with id individualId
Expand Down Expand Up @@ -3536,7 +3536,7 @@ paths:
description: bad input parameter
security:
- BearerAuth: []
summary: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without a PK) for a given dataAgreementId.
summary: CREATE - Create a DRAFT (unsaved) data agreement record and signature objects (without a PK) for a given dataAgreementId.
tags:
- service
x-specification-crudl-model: ''
Expand Down Expand Up @@ -3695,7 +3695,7 @@ paths:
description: bad input parameter
security:
- BearerAuth: []
summary: LIST - Fetch all consent records for individual
summary: LIST - Fetch all data agreement records for individual
tags:
- service
x-specification-crudl-model: ''
Expand Down
4 changes: 2 additions & 2 deletions openapi/v2023.8.2/definitions/ConsentRecord.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ properties:
individual:
$ref: "./Individual.yaml"
x-fk-model: "Individual"
description: "The Individual who has signed this consent record"
description: "The Individual who has signed this data agreement record"

optIn:
type: boolean
Expand All @@ -50,4 +50,4 @@ properties:
signature:
$ref: "./Signature.yaml"
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?"
description: "A signature that hashes all the values of the data agreement record and has signed it with the key of the Invidiual, making it verifiable and tamper-proof. TBD: Relation to a Signature schema?"
2 changes: 1 addition & 1 deletion openapi/v2023.8.2/definitions/Signature.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ properties:
type: string
format: ""
example: ""
description: "A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a consent record, an agreement, policy etc)"
description: "A symmetric relation / back reference to the objectType that was signed. We are currently just modelling signing another signature (a chain) or signing a Revision (which can be a revision of a data agreement record, an agreement, policy etc)"
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without
description: CREATE - Create a DRAFT (unsaved) data agreement record and signature objects (without
a PK) for a given dataAgreementId.
operationId: serviceCreateIndividualConsentRecordDraft
parameters:
Expand Down Expand Up @@ -36,7 +36,7 @@ responses:
description: bad input parameter
security:
- BearerAuth: []
summary: CREATE - Create a DRAFT (unsaved) consent record and signature objects (without
summary: CREATE - Create a DRAFT (unsaved) data agreement record and signature objects (without
a PK) for a given dataAgreementId.
tags:
- service
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ responses:
description: bad input parameter
security:
- BearerAuth: []
summary: LIST - Fetch all consent records for individual
summary: LIST - Fetch all data agreement records for individual
tags:
- service
x-specification-crudl-model: ""
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
description: LIST - Fetch consent records for supplied AgreementFilter
description: LIST - Fetch data agreement records for supplied AgreementFilter
operationId: serviceVerificationAgreementListFilter
parameters:
- description: Requested index for start of resources to be provided in response requested
Expand Down Expand Up @@ -40,7 +40,7 @@ responses:
description: bad input parameter
security:
- BearerAuth: []
summary: LIST - Fetch consent records for supplied AgreementFilter
summary: LIST - Fetch data agreement records for supplied AgreementFilter
tags:
- service
x-specification-crudl-model: ''
Expand Down

0 comments on commit 1cce920

Please sign in to comment.