diff --git a/openapi/v2023.8.1/bundled.yaml b/openapi/v2023.8.1/bundled.yaml index d754665..4c43a78 100644 --- a/openapi/v2023.8.1/bundled.yaml +++ b/openapi/v2023.8.1/bundled.yaml @@ -94,7 +94,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}': + '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}': get: tags: - service @@ -118,7 +118,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path description: Consent agreement ID required: true @@ -194,7 +194,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status': + '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/status': post: tags: - service @@ -215,7 +215,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -236,7 +236,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}': + '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}': patch: tags: - service @@ -257,7 +257,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -2256,7 +2256,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/data-agreements/{purposeId}': + '/v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}': delete: tags: - config @@ -2267,7 +2267,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -2313,7 +2313,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -2350,7 +2350,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -2375,7 +2375,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/templates': + '/v1/organisations/{orgId}/data-attributes': post: tags: - config @@ -2391,10 +2391,10 @@ paths: application/json: schema: required: - - templates + - data-attributes type: object properties: - templates: + data-attributes: type: array items: $ref: '#/components/schemas/DataAttribute' @@ -2444,7 +2444,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/data-agreements/{purposeId}/templates': + '/v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}/data-attributes': delete: tags: - config @@ -2455,7 +2455,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -2475,7 +2475,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/templates/{templateID}': + '/v1/organisations/{orgId}/data-attributes/{dataAttributeId}': get: tags: - config @@ -2486,7 +2486,7 @@ paths: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -2519,7 +2519,7 @@ paths: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -2565,7 +2565,7 @@ paths: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -3205,7 +3205,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users': + '/v1/organisations/{orgId}/data-agreements/{dataAgreementId}/attributes/{attributeID}/consented/users': get: tags: - onboard @@ -3216,7 +3216,7 @@ paths: required: true schema: type: string - - name: purposeID + - name: dataAgreementId in: path required: true schema: @@ -3260,7 +3260,7 @@ paths: deprecated: false security: - BearerAuth: [] - '/v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users': + '/v1/organisations/{orgId}/data-agreements/{dataAgreementId}/consented/users': get: tags: - onboard @@ -3271,7 +3271,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -3999,7 +3999,7 @@ paths: - consentID - days - organisationID - - purposeID + - dataAgreementId - timestamp - userID type: object @@ -4015,7 +4015,7 @@ paths: format: int32 organisationID: type: string - purposeID: + dataAgreementId: type: string timestamp: type: string diff --git a/openapi/v2023.8.1/index.yaml b/openapi/v2023.8.1/index.yaml index 5817596..c45bf32 100644 --- a/openapi/v2023.8.1/index.yaml +++ b/openapi/v2023.8.1/index.yaml @@ -53,15 +53,15 @@ paths: $ref: "./paths/audit/getOrgLogs.yaml" /v1/users/{userId}/consenthistory: $ref: "./paths/service/getConsentHistory.yaml" - /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}: + /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}: $ref: "./paths/service/getConsentsByConsentAgreementId.yaml" /v1/organisations/{orgId}/users/{userId}/consents/{consentId}: $ref: "./paths/service/getConsentsForAllConsentAgreements.yaml" /v1/organisations/{orgId}/users/{userId}/consents: $ref: "./paths/service/getConsents.yaml" - /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status: + /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/status: $ref: "./paths/service/updateConsentForConsentAgreement.yaml" - /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}: + /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}: $ref: "./paths/service/updateConsentForDataAttribute.yaml" /v1/user/organisations/{orgId}/data-status: $ref: "./paths/service/dataRequests/listAllDataRequests.yaml" @@ -145,13 +145,13 @@ paths: $ref: "./paths/config/dataAgreements/globalPolicyConfigurations/getAndUpdateGlobalPolicyConfiguration.yaml" /v1/organisations/{orgId}/data-agreements: $ref: "./paths/config/dataAgreements/getAndAddConsentAgreements.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeId}: + /v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}: $ref: "./paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml" - /v1/organisations/{orgId}/templates: + /v1/organisations/{orgId}/data-attributes: $ref: "./paths/config/dataAttributes/getAndAddDataAttributes.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeId}/templates: + /v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}/data-attributes: $ref: "./paths/config/dataAttributes/deleteMultipleDataAttributes.yaml" - /v1/organisations/{orgId}/templates/{templateID}: + /v1/organisations/{orgId}/data-attributes/{dataAttributeId}: $ref: "./paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml" /v1/organisations/{orgId}/idp/open-id: $ref: "./paths/onboard/manageIndividuals/subscription/addGetUpdateAndDeleteIdentityProvider.yaml" @@ -175,9 +175,9 @@ paths: $ref: "./paths/onboard/manageIndividuals/addAndGetOrganisationUsers.yaml" /v1/organisations/{orgId}/users/{userId}: $ref: "./paths/onboard/manageIndividuals/deleteUserFromOrganisation.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users: + /v1/organisations/{orgId}/data-agreements/{dataAgreementId}/attributes/{attributeID}/consented/users: $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users: + /v1/organisations/{orgId}/data-agreements/{dataAgreementId}/consented/users: $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml" /v1/organisations/data-requests: $ref: "./paths/onboard/dataRequests/getAvailableDataRequestStatuses.yaml" diff --git a/openapi/v2023.8.1/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml b/openapi/v2023.8.1/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml index 91dd446..86d02f9 100644 --- a/openapi/v2023.8.1/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml +++ b/openapi/v2023.8.1/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml @@ -8,7 +8,7 @@ delete: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -54,7 +54,7 @@ put: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -91,7 +91,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple diff --git a/openapi/v2023.8.1/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml b/openapi/v2023.8.1/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml index fae011d..00596bc 100644 --- a/openapi/v2023.8.1/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml +++ b/openapi/v2023.8.1/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml @@ -8,7 +8,7 @@ delete: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.1/paths/config/dataAttributes/getAndAddDataAttributes.yaml b/openapi/v2023.8.1/paths/config/dataAttributes/getAndAddDataAttributes.yaml index c321f1f..ab92ae5 100644 --- a/openapi/v2023.8.1/paths/config/dataAttributes/getAndAddDataAttributes.yaml +++ b/openapi/v2023.8.1/paths/config/dataAttributes/getAndAddDataAttributes.yaml @@ -13,10 +13,10 @@ post: application/json: schema: required: - - templates + - data-attributes type: object properties: - templates: + data-attributes: type: array items: $ref: "../../../definitions/config/DataAttribute.yaml" diff --git a/openapi/v2023.8.1/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml b/openapi/v2023.8.1/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml index 498150a..afecedf 100644 --- a/openapi/v2023.8.1/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml +++ b/openapi/v2023.8.1/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -41,7 +41,7 @@ put: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -87,7 +87,7 @@ delete: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: diff --git a/openapi/v2023.8.1/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml b/openapi/v2023.8.1/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml index 184d665..96aa67f 100644 --- a/openapi/v2023.8.1/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml +++ b/openapi/v2023.8.1/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml @@ -85,7 +85,7 @@ get: - consentID - days - organisationID - - purposeID + - dataAgreementId - timestamp - userID type: object @@ -101,7 +101,7 @@ get: format: int32 organisationID: type: string - purposeID: + dataAgreementId: type: string timestamp: type: string diff --git a/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml b/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml index f64e725..2285cba 100644 --- a/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml +++ b/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml b/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml index dc39b85..41c7688 100644 --- a/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml +++ b/openapi/v2023.8.1/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: purposeID + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.1/paths/service/getConsentsByConsentAgreementId.yaml b/openapi/v2023.8.1/paths/service/getConsentsByConsentAgreementId.yaml index d7404c1..cfe84d2 100644 --- a/openapi/v2023.8.1/paths/service/getConsentsByConsentAgreementId.yaml +++ b/openapi/v2023.8.1/paths/service/getConsentsByConsentAgreementId.yaml @@ -21,7 +21,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path description: "Consent agreement ID" required: true diff --git a/openapi/v2023.8.1/paths/service/updateConsentForConsentAgreement.yaml b/openapi/v2023.8.1/paths/service/updateConsentForConsentAgreement.yaml index 86f4e99..d475131 100644 --- a/openapi/v2023.8.1/paths/service/updateConsentForConsentAgreement.yaml +++ b/openapi/v2023.8.1/paths/service/updateConsentForConsentAgreement.yaml @@ -18,7 +18,7 @@ post: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.1/paths/service/updateConsentForDataAttribute.yaml b/openapi/v2023.8.1/paths/service/updateConsentForDataAttribute.yaml index 15ddbd6..b2e03c0 100644 --- a/openapi/v2023.8.1/paths/service/updateConsentForDataAttribute.yaml +++ b/openapi/v2023.8.1/paths/service/updateConsentForDataAttribute.yaml @@ -18,7 +18,7 @@ patch: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml index 8a15a24..f0ce748 100644 --- a/openapi/v2023.8.2/bundled.yaml +++ b/openapi/v2023.8.2/bundled.yaml @@ -100,7 +100,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}': + '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}': get: tags: - service @@ -124,7 +124,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path description: Consent agreement ID required: true @@ -209,7 +209,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status': + '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/status': post: tags: - service @@ -230,7 +230,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -274,7 +274,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -292,7 +292,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}': + '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}': patch: tags: - service @@ -313,7 +313,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -2345,7 +2345,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v1/organisations/{orgId}/data-agreements/{purposeId}': + '/v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}': delete: tags: - config @@ -2356,7 +2356,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -2405,7 +2405,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -2445,7 +2445,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -2473,7 +2473,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v1/organisations/{orgId}/templates': + '/v1/organisations/{orgId}/data-attributes': post: tags: - config @@ -2489,10 +2489,10 @@ paths: application/json: schema: required: - - templates + - data-attributes type: object properties: - templates: + data-attributes: type: array items: $ref: '#/components/schemas/DataAttribute' @@ -2548,7 +2548,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v1/organisations/{orgId}/data-agreements/{purposeId}/templates': + '/v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}/data-attributes': delete: tags: - config @@ -2559,7 +2559,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -2582,7 +2582,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v1/organisations/{orgId}/templates/{templateID}': + '/v1/organisations/{orgId}/data-attributes/{dataAttributeId}': get: tags: - config @@ -2593,7 +2593,7 @@ paths: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -2629,7 +2629,7 @@ paths: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -2678,7 +2678,7 @@ paths: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -3363,7 +3363,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users': + '/v1/organisations/{orgId}/data-agreements/{dataAgreementId}/attributes/{attributeID}/consented/users': get: tags: - onboard @@ -3374,7 +3374,7 @@ paths: required: true schema: type: string - - name: purposeID + - name: dataAgreementId in: path required: true schema: @@ -3421,7 +3421,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users': + '/v1/organisations/{orgId}/data-agreements/{dataAgreementId}/consented/users': get: tags: - onboard @@ -3432,7 +3432,7 @@ paths: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -4199,7 +4199,7 @@ paths: - consentID - days - organisationID - - purposeID + - dataAgreementId - timestamp - userID type: object @@ -4215,7 +4215,7 @@ paths: format: int32 organisationID: type: string - purposeID: + dataAgreementId: type: string timestamp: type: string diff --git a/openapi/v2023.8.2/index.yaml b/openapi/v2023.8.2/index.yaml index 22bef20..a6ff415 100644 --- a/openapi/v2023.8.2/index.yaml +++ b/openapi/v2023.8.2/index.yaml @@ -53,15 +53,15 @@ paths: $ref: "./paths/audit/getOrgLogs.yaml" /v1/users/{userId}/consenthistory: $ref: "./paths/service/getConsentHistory.yaml" - /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}: + /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}: $ref: "./paths/service/getConsentsByConsentAgreementId.yaml" /v1/organisations/{orgId}/users/{userId}/consents/{consentId}: $ref: "./paths/service/getConsentsForAllConsentAgreements.yaml" /v1/organisations/{orgId}/users/{userId}/consents: $ref: "./paths/service/getConsents.yaml" - /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status: + /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/status: $ref: "./paths/service/updateConsentForConsentAgreement.yaml" - /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}: + /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}: $ref: "./paths/service/updateConsentForDataAttribute.yaml" /v1/user/organisations/{orgId}/data-status: $ref: "./paths/service/dataRequests/listAllDataRequests.yaml" @@ -147,13 +147,13 @@ paths: $ref: "./paths/config/dataAgreements/globalPolicyConfigurations/getAndUpdateGlobalPolicyConfiguration.yaml" /v1/organisations/{orgId}/data-agreements: $ref: "./paths/config/dataAgreements/getAndAddConsentAgreements.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeId}: + /v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}: $ref: "./paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml" - /v1/organisations/{orgId}/templates: + /v1/organisations/{orgId}/data-attributes: $ref: "./paths/config/dataAttributes/getAndAddDataAttributes.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeId}/templates: + /v1/organisations/{orgId}/config/data-agreements/{dataAgreementId}/data-attributes: $ref: "./paths/config/dataAttributes/deleteMultipleDataAttributes.yaml" - /v1/organisations/{orgId}/templates/{templateID}: + /v1/organisations/{orgId}/data-attributes/{dataAttributeId}: $ref: "./paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml" /v1/organisations/{orgId}/idp/open-id: $ref: "./paths/onboard/manageIndividuals/subscription/addGetUpdateAndDeleteIdentityProvider.yaml" @@ -177,9 +177,9 @@ paths: $ref: "./paths/onboard/manageIndividuals/addAndGetOrganisationUsers.yaml" /v1/organisations/{orgId}/users/{userId}: $ref: "./paths/onboard/manageIndividuals/deleteUserFromOrganisation.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users: + /v1/organisations/{orgId}/data-agreements/{dataAgreementId}/attributes/{attributeID}/consented/users: $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml" - /v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users: + /v1/organisations/{orgId}/data-agreements/{dataAgreementId}/consented/users: $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml" /v1/organisations/data-requests: $ref: "./paths/onboard/dataRequests/getAvailableDataRequestStatuses.yaml" diff --git a/openapi/v2023.8.2/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml b/openapi/v2023.8.2/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml index 8e397fb..2af5041 100644 --- a/openapi/v2023.8.2/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml +++ b/openapi/v2023.8.2/paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml @@ -8,7 +8,7 @@ delete: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -57,7 +57,7 @@ put: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple @@ -97,7 +97,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true style: simple diff --git a/openapi/v2023.8.2/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml b/openapi/v2023.8.2/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml index 3d5dae0..d90d5ac 100644 --- a/openapi/v2023.8.2/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml +++ b/openapi/v2023.8.2/paths/config/dataAttributes/deleteMultipleDataAttributes.yaml @@ -8,7 +8,7 @@ delete: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.2/paths/config/dataAttributes/getAndAddDataAttributes.yaml b/openapi/v2023.8.2/paths/config/dataAttributes/getAndAddDataAttributes.yaml index 1c73e22..9acfed1 100644 --- a/openapi/v2023.8.2/paths/config/dataAttributes/getAndAddDataAttributes.yaml +++ b/openapi/v2023.8.2/paths/config/dataAttributes/getAndAddDataAttributes.yaml @@ -13,10 +13,10 @@ post: application/json: schema: required: - - templates + - data-attributes type: object properties: - templates: + data-attributes: type: array items: $ref: "../../../definitions/config/DataAttribute.yaml" diff --git a/openapi/v2023.8.2/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml b/openapi/v2023.8.2/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml index c2089a4..5a82f9e 100644 --- a/openapi/v2023.8.2/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml +++ b/openapi/v2023.8.2/paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -44,7 +44,7 @@ put: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: @@ -93,7 +93,7 @@ delete: required: true schema: type: string - - name: templateID + - name: dataAttributeId in: path required: true schema: diff --git a/openapi/v2023.8.2/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml b/openapi/v2023.8.2/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml index 9153965..e6deeb0 100644 --- a/openapi/v2023.8.2/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml +++ b/openapi/v2023.8.2/paths/config/webhooks/getRecentWebhookDeliveryByID.yaml @@ -85,7 +85,7 @@ get: - consentID - days - organisationID - - purposeID + - dataAgreementId - timestamp - userID type: object @@ -101,7 +101,7 @@ get: format: int32 organisationID: type: string - purposeID: + dataAgreementId: type: string timestamp: type: string diff --git a/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml b/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml index e87f126..b73de22 100644 --- a/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml +++ b/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml b/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml index 91c1d7d..427bed7 100644 --- a/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml +++ b/openapi/v2023.8.2/paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: purposeID + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.2/paths/service/getConsentsByConsentAgreementId.yaml b/openapi/v2023.8.2/paths/service/getConsentsByConsentAgreementId.yaml index 7fbded7..c41d5f5 100644 --- a/openapi/v2023.8.2/paths/service/getConsentsByConsentAgreementId.yaml +++ b/openapi/v2023.8.2/paths/service/getConsentsByConsentAgreementId.yaml @@ -21,7 +21,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path description: "Consent agreement ID" required: true diff --git a/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml b/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml index c2726a3..205717a 100644 --- a/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml +++ b/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml @@ -18,7 +18,7 @@ post: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: @@ -62,7 +62,7 @@ get: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: diff --git a/openapi/v2023.8.2/paths/service/updateConsentForDataAttribute.yaml b/openapi/v2023.8.2/paths/service/updateConsentForDataAttribute.yaml index 16e0b38..09fec8f 100644 --- a/openapi/v2023.8.2/paths/service/updateConsentForDataAttribute.yaml +++ b/openapi/v2023.8.2/paths/service/updateConsentForDataAttribute.yaml @@ -18,7 +18,7 @@ patch: required: true schema: type: string - - name: purposeId + - name: dataAgreementId in: path required: true schema: