diff --git a/openapi/v2023.11.1/bundled.yaml b/openapi/v2023.11.1/bundled.yaml index 633d07e..82b0588 100644 --- 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 new file mode 100644 index 0000000..d935534 --- /dev/null +++ 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 \ No newline at end of file diff --git a/openapi/v2023.11.1/paths/serviceAgreementList.yaml b/openapi/v2023.11.1/paths/serviceAgreementList.yaml index 13dfb73..8251cdd 100644 --- 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 index 1de81f6..8dd53f4 100644 --- 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 index 0a78bcc..311e61b 100644 --- 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 index 1e0ea55..d8dea01 100644 --- 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 index ab20f9e..7f94989 100644 --- 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 diff --git a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml index 1c50d79..880e617 100644 --- a/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml +++ b/openapi/v2023.11.1/paths/serviceCreateIndividualConsentRecordSignature.yaml @@ -1,14 +1,15 @@ description: CREATE - Creates and returns a blank Signature object for the consent record operationId: serviceCreateIndividualConsentRecordSignature parameters: -- description: Unique ID of an object - in: path - name: consentRecordId - required: true - schema: - type: string + - description: Unique ID of an object + in: path + name: consentRecordId + required: true + schema: + type: string + - $ref: "../parameters/individualIdHeader.yaml" responses: - '200': + "200": content: application/json: schema: @@ -16,15 +17,15 @@ responses: properties: signature: $ref: ../definitions/Signature.yaml - description: '' - '400': + description: "" + "400": description: bad input parameter security: - BearerAuth: [] summary: CREATE - Creates and returns a blank Signature object for the consent record tags: -- service -x-specification-crudl-model: '' -x-specification-pii-or-sensitive: 'True' -x-specification-scenario: '' + - service +x-specification-crudl-model: "" +x-specification-pii-or-sensitive: "True" +x-specification-scenario: "" x-specification-usecase: UC-Post-Partum-001-Registration_PostPartum_and_InfantCare diff --git a/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml b/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml index f9ee3dd..f8de766 100644 --- a/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml +++ b/openapi/v2023.11.1/paths/serviceDeleteAllRecords.yaml @@ -3,7 +3,8 @@ description: DELETE - Cascading delete operation for Right To Be Forgotten, dele May also delete an unsigned consent record, for instance in cases where the user exits the signing process. operationId: serviceDeleteAllRecords -parameters: [] +parameters: + - $ref: "../parameters/individualIdHeader.yaml" responses: '200': description: '' diff --git a/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml b/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml index 8888e10..3a73586 100644 --- a/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml +++ b/openapi/v2023.11.1/paths/serviceListDataAgreementRecordHistory.yaml @@ -6,6 +6,7 @@ summary: LIST - Fetch all consent record history parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": description: OK diff --git a/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml b/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml index 78943ce..e06dd69 100644 --- a/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml +++ b/openapi/v2023.11.1/paths/serviceListDataAttributesForDataAgreement.yaml @@ -5,6 +5,7 @@ parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - $ref: "../parameters/revisionId.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: '200': content: diff --git a/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml index 58f4bde..ee9008b 100644 --- a/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml +++ b/openapi/v2023.11.1/paths/serviceListIndividualAgreementConsentRecordList.yaml @@ -4,6 +4,7 @@ parameters: - $ref: "../parameters/dataAgreementId.yaml" - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: diff --git a/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml index 3749371..d14e00b 100644 --- a/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml +++ b/openapi/v2023.11.1/paths/serviceListIndividualConsentRecordList.yaml @@ -3,6 +3,7 @@ operationId: serviceListIndividualConsentRecordList parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: diff --git a/openapi/v2023.11.1/paths/serviceListIndividuals.yaml b/openapi/v2023.11.1/paths/serviceListIndividuals.yaml index 89ec9c2..5620a1b 100644 --- a/openapi/v2023.11.1/paths/serviceListIndividuals.yaml +++ b/openapi/v2023.11.1/paths/serviceListIndividuals.yaml @@ -6,7 +6,7 @@ description: "LIST - lists individuals in the system" parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" - + - $ref: "../parameters/individualIdHeader.yaml" x-specification-usecase: "" x-specification-scenario: "" x-specification-pii-or-sensitive: "True" diff --git a/openapi/v2023.11.1/paths/servicePolicyRead.yaml b/openapi/v2023.11.1/paths/servicePolicyRead.yaml index 2dd4882..9cface2 100644 --- a/openapi/v2023.11.1/paths/servicePolicyRead.yaml +++ b/openapi/v2023.11.1/paths/servicePolicyRead.yaml @@ -3,6 +3,7 @@ operationId: servicePolicyRead parameters: - $ref: "../parameters/policyId.yaml" - $ref: "../parameters/revisionId.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: diff --git a/openapi/v2023.11.1/paths/serviceReadIdp.yaml b/openapi/v2023.11.1/paths/serviceReadIdp.yaml index bf708d2..53009a3 100644 --- a/openapi/v2023.11.1/paths/serviceReadIdp.yaml +++ b/openapi/v2023.11.1/paths/serviceReadIdp.yaml @@ -2,6 +2,7 @@ description: READ - Read an IDP operationId: serviceReadIdp parameters: - $ref: "../parameters/idpId.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: diff --git a/openapi/v2023.11.1/paths/serviceReadIndividual.yaml b/openapi/v2023.11.1/paths/serviceReadIndividual.yaml index 50b4929..9599fe3 100644 --- a/openapi/v2023.11.1/paths/serviceReadIndividual.yaml +++ b/openapi/v2023.11.1/paths/serviceReadIndividual.yaml @@ -10,7 +10,7 @@ parameters: required: true schema: type: string - + - $ref: "../parameters/individualIdHeader.yaml" x-specification-usecase: "" x-specification-scenario: "" x-specification-pii-or-sensitive: "True" diff --git a/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml b/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml index fc0d556..773925c 100644 --- a/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml +++ b/openapi/v2023.11.1/paths/serviceReadIndividualRecordRead.yaml @@ -4,6 +4,7 @@ description: operationId: serviceReadIndividualRecordRead parameters: - $ref: "../parameters/dataAgreementId.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml index 3039972..c9fa05d 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisation.yaml @@ -1,6 +1,8 @@ deprecated: false description: Read organization operationId: serviceReadOrganisation +parameters: + - $ref: "../parameters/individualIdHeader.yaml" responses: '200': content: diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml index fbea5ed..f2ca865 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisationCoverImage.yaml @@ -1,6 +1,8 @@ deprecated: false description: Read organization cover image operationId: serviceReadOrganisationCoverImage +parameters: + - $ref: "../parameters/individualIdHeader.yaml" responses: '200': headers: {} diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml index 0dc2b13..e4c11b4 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisationImage.yaml @@ -1,6 +1,8 @@ deprecated: false description: Get organization image operationId: serviceReadOrganisationImage +parameters: + - $ref: "../parameters/individualIdHeader.yaml" responses: '200': headers: {} diff --git a/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml b/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml index a24d828..b9c9962 100644 --- a/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml +++ b/openapi/v2023.11.1/paths/serviceReadOrganisationLogoImage.yaml @@ -1,10 +1,12 @@ deprecated: false description: Read organization logo image operationId: serviceReadOrganisationLogoImage +parameters: + - $ref: "../parameters/individualIdHeader.yaml" responses: - '200': + "200": headers: {} security: -- BearerAuth: [] + - BearerAuth: [] tags: -- service + - service diff --git a/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml b/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml index 7dc232d..5216487 100644 --- a/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml +++ b/openapi/v2023.11.1/paths/serviceUpdateIndividual.yaml @@ -10,7 +10,7 @@ parameters: required: true schema: type: string - + - $ref: "../parameters/individualIdHeader.yaml" x-specification-usecase: "" x-specification-scenario: "" x-specification-pii-or-sensitive: "True" diff --git a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml index 9d173b8..93fa8d4 100644 --- a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml +++ b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecord.yaml @@ -1,25 +1,26 @@ description: UPDATE* - Update a consent record. Note that updating a signed consent record invalidates its signature. operationId: serviceUpdateIndividualConsentRecord parameters: -- $ref: "../parameters/consentRecordId.yaml" -- 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/consentRecordId.yaml" + - 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" requestBody: content: application/json: @@ -32,7 +33,7 @@ requestBody: description: "True: The individual has positively opted in. False: The individual has explicitly said no (or withdrawn a previous consent)." type: object responses: - '200': + "200": content: application/json: schema: @@ -42,15 +43,15 @@ responses: $ref: ../definitions/consentRecord.yaml revision: $ref: ../definitions/Revision.yaml - description: '' - '400': + description: "" + "400": description: bad input parameter security: - BearerAuth: [] summary: UPDATE* - Update a consent record tags: -- service -x-specification-crudl-model: '' -x-specification-pii-or-sensitive: 'True' -x-specification-scenario: '' + - service +x-specification-crudl-model: "" +x-specification-pii-or-sensitive: "True" +x-specification-scenario: "" x-specification-usecase: UC-C-PIC-I-003 diff --git a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml index a11dabe..2b86826 100644 --- a/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml +++ b/openapi/v2023.11.1/paths/serviceUpdateIndividualConsentRecordSignature.yaml @@ -10,6 +10,7 @@ parameters: required: true schema: type: string + - $ref: "../parameters/individualIdHeader.yaml" requestBody: content: application/json: diff --git a/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml b/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml index 6af3f66..27a6ccf 100644 --- a/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml +++ b/openapi/v2023.11.1/paths/serviceVerificationAgreementConsentRecordRead.yaml @@ -1,9 +1,10 @@ description: READ - Fetch a consent record (latest revision). The individualId is supplied as HTTP header. operationId: serviceVerificationAgreementConsentRecordRead parameters: -- $ref: "../parameters/consentRecordId.yaml" + - $ref: "../parameters/consentRecordId.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: - '200': + "200": content: application/json: schema: @@ -13,15 +14,15 @@ responses: $ref: "../definitions/consentRecord.yaml" revision: $ref: "../definitions/Revision.yaml" - description: '' - '400': + description: "" + "400": description: bad input parameter security: - BearerAuth: [] summary: READ - Fetch a consent record (latest revision) tags: -- service -x-specification-crudl-model: '' -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '1.2' + - service +x-specification-crudl-model: "" +x-specification-pii-or-sensitive: "False" +x-specification-scenario: "1.2" x-specification-usecase: UC-C-PIC-A-003 diff --git a/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml b/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml index 5f04799..8a2dd5f 100644 --- a/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml +++ b/openapi/v2023.11.1/paths/serviceVerificationAgreementList.yaml @@ -1,10 +1,11 @@ description: LIST - Fetch all consent records operationId: serviceVerificationAgreementList parameters: -- $ref: "../parameters/offset.yaml" -- $ref: "../parameters/limit.yaml" + - $ref: "../parameters/offset.yaml" + - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: - '200': + "200": content: application/json: schema: @@ -16,15 +17,15 @@ responses: $ref: ../definitions/consentRecord.yaml pagination: $ref: "../definitions/Pagination.yaml" - description: '' - '400': + description: "" + "400": description: bad input parameter security: - BearerAuth: [] summary: LIST - Fetch all consent records tags: -- service -x-specification-crudl-model: '' -x-specification-pii-or-sensitive: 'False' -x-specification-scenario: '1.1' + - service +x-specification-crudl-model: "" +x-specification-pii-or-sensitive: "False" +x-specification-scenario: "1.1" x-specification-usecase: UC-C-PIC-A-003 diff --git a/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml b/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml index 9f7ec3e..4ba6875 100644 --- a/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml +++ b/openapi/v2023.11.1/paths/serviceVerificationConsentRecordList.yaml @@ -3,6 +3,7 @@ operationId: serviceVerificationConsentRecordList parameters: - $ref: "../parameters/offset.yaml" - $ref: "../parameters/limit.yaml" + - $ref: "../parameters/individualIdHeader.yaml" responses: "200": content: