diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml index be56cf7..2f92f29 100644 --- a/openapi/v2023.8.2/bundled.yaml +++ b/openapi/v2023.8.2/bundled.yaml @@ -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: '' @@ -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 @@ -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. @@ -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 @@ -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: '' @@ -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: '' diff --git a/openapi/v2023.8.2/definitions/ConsentRecord.yaml b/openapi/v2023.8.2/definitions/ConsentRecord.yaml index 97fa092..2db8ea3 100644 --- a/openapi/v2023.8.2/definitions/ConsentRecord.yaml +++ b/openapi/v2023.8.2/definitions/ConsentRecord.yaml @@ -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 @@ -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?" diff --git a/openapi/v2023.8.2/definitions/Signature.yaml b/openapi/v2023.8.2/definitions/Signature.yaml index b29256e..22fac60 100644 --- a/openapi/v2023.8.2/definitions/Signature.yaml +++ b/openapi/v2023.8.2/definitions/Signature.yaml @@ -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)" diff --git a/openapi/v2023.8.2/paths/serviceCreateIndividualConsentRecordDraft.yaml b/openapi/v2023.8.2/paths/serviceCreateIndividualConsentRecordDraft.yaml index 8cc0e4a..59a46e6 100644 --- a/openapi/v2023.8.2/paths/serviceCreateIndividualConsentRecordDraft.yaml +++ b/openapi/v2023.8.2/paths/serviceCreateIndividualConsentRecordDraft.yaml @@ -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: @@ -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 diff --git a/openapi/v2023.8.2/paths/serviceListIndividualConsentRecordList.yaml b/openapi/v2023.8.2/paths/serviceListIndividualConsentRecordList.yaml index 7baba02..1300165 100644 --- a/openapi/v2023.8.2/paths/serviceListIndividualConsentRecordList.yaml +++ b/openapi/v2023.8.2/paths/serviceListIndividualConsentRecordList.yaml @@ -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: "" diff --git a/openapi/v2023.8.2/paths/serviceVerificationAgreementListFilter.yaml b/openapi/v2023.8.2/paths/serviceVerificationAgreementListFilter.yaml index c951763..c82e71b 100644 --- a/openapi/v2023.8.2/paths/serviceVerificationAgreementListFilter.yaml +++ b/openapi/v2023.8.2/paths/serviceVerificationAgreementListFilter.yaml @@ -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 @@ -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: ''