Upd: Rename purposes to data-agreements

Signed-off-by: George J Padayatti <[email protected]>
decentralised-dataexchange · Sep 20, 2023 · e2c3579 · e2c3579
1 parent e20d2dc
commit e2c3579
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 32 deletions.
diff --git 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}/purposes/{purposeId}':
+  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}':
     get:
       tags:
         - service
@@ -194,7 +194,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/purposes/{purposeId}/status':
+  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status':
     post:
       tags:
         - service
@@ -236,7 +236,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/purposes/{purposeId}/attributes/{attributeId}':
+  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}':
     patch:
       tags:
         - service
@@ -2187,7 +2187,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/purposes':
+  '/v1/organisations/{orgId}/data-agreements':
     post:
       tags:
         - config
@@ -2256,7 +2256,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/purposes/{purposeId}':
+  '/v1/organisations/{orgId}/data-agreements/{purposeId}':
     delete:
       tags:
         - config
@@ -2444,7 +2444,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/purposes/{purposeId}/templates':
+  '/v1/organisations/{orgId}/data-agreements/{purposeId}/templates':
     delete:
       tags:
         - config
@@ -3205,7 +3205,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/purposes/{purposeID}/attributes/{attributeID}/consented/users':
+  '/v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users':
     get:
       tags:
         - onboard
@@ -3260,7 +3260,7 @@ paths:
       deprecated: false
       security:
         - BearerAuth: []
-  '/v1/organisations/{orgId}/purposes/{purposeId}/consented/users':
+  '/v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users':
     get:
       tags:
         - onboard

diff --git 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}/purposes/{purposeId}:
+  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}:
     $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}/purposes/{purposeId}/status:
+  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status:
     $ref: "./paths/service/updateConsentForConsentAgreement.yaml"
-  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/purposes/{purposeId}/attributes/{attributeId}:
+  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}:
     $ref: "./paths/service/updateConsentForDataAttribute.yaml"
   /v1/user/organisations/{orgId}/data-status:
     $ref: "./paths/service/dataRequests/listAllDataRequests.yaml"
@@ -143,13 +143,13 @@ paths:
     $ref: "./paths/onboard/developer/deleteAPIKey.yaml"
   /v1/organisations/{orgId}/config/policy:
     $ref: "./paths/config/dataAgreements/globalPolicyConfigurations/getAndUpdateGlobalPolicyConfiguration.yaml"
-  /v1/organisations/{orgId}/purposes:
+  /v1/organisations/{orgId}/data-agreements:
     $ref: "./paths/config/dataAgreements/getAndAddConsentAgreements.yaml"
-  /v1/organisations/{orgId}/purposes/{purposeId}:
+  /v1/organisations/{orgId}/data-agreements/{purposeId}:
     $ref: "./paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml"
   /v1/organisations/{orgId}/templates:
     $ref: "./paths/config/dataAttributes/getAndAddDataAttributes.yaml"
-  /v1/organisations/{orgId}/purposes/{purposeId}/templates:
+  /v1/organisations/{orgId}/data-agreements/{purposeId}/templates:
     $ref: "./paths/config/dataAttributes/deleteMultipleDataAttributes.yaml"
   /v1/organisations/{orgId}/templates/{templateID}:
     $ref: "./paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.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}/purposes/{purposeID}/attributes/{attributeID}/consented/users:
+  /v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users:
     $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml"
-  /v1/organisations/{orgId}/purposes/{purposeId}/consented/users:
+  /v1/organisations/{orgId}/data-agreements/{purposeId}/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/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}/purposes/{purposeId}':
+  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}':
     get:
       tags:
         - service
@@ -209,7 +209,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Individual'
-  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/purposes/{purposeId}/status':
+  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status':
     post:
       tags:
         - service
@@ -292,7 +292,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Individual'
-  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/purposes/{purposeId}/attributes/{attributeId}':
+  '/v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/attributes/{attributeId}':
     patch:
       tags:
         - service
@@ -2270,7 +2270,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Organisation admin'
-  '/v1/organisations/{orgId}/purposes':
+  '/v1/organisations/{orgId}/data-agreements':
     post:
       tags:
         - config
@@ -2345,7 +2345,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Organisation admin'
-  '/v1/organisations/{orgId}/purposes/{purposeId}':
+  '/v1/organisations/{orgId}/data-agreements/{purposeId}':
     delete:
       tags:
         - config
@@ -2548,7 +2548,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Organisation admin'
-  '/v1/organisations/{orgId}/purposes/{purposeId}/templates':
+  '/v1/organisations/{orgId}/data-agreements/{purposeId}/templates':
     delete:
       tags:
         - config
@@ -3363,7 +3363,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Organisation admin'
-  '/v1/organisations/{orgId}/purposes/{purposeID}/attributes/{attributeID}/consented/users':
+  '/v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users':
     get:
       tags:
         - onboard
@@ -3421,7 +3421,7 @@ paths:
       x-badges:
         - color: primary-color
           label: 'Authorised roles: Organisation admin'
-  '/v1/organisations/{orgId}/purposes/{purposeId}/consented/users':
+  '/v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users':
     get:
       tags:
         - onboard

diff --git 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}/purposes/{purposeId}:
+  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}:
     $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}/purposes/{purposeId}/status:
+  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/status:
     $ref: "./paths/service/updateConsentForConsentAgreement.yaml"
-  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/purposes/{purposeId}/attributes/{attributeId}:
+  /v1/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{purposeId}/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/onboard/developer/deleteAPIKey.yaml"
   /v1/organisations/{orgId}/config/policy:
     $ref: "./paths/config/dataAgreements/globalPolicyConfigurations/getAndUpdateGlobalPolicyConfiguration.yaml"
-  /v1/organisations/{orgId}/purposes:
+  /v1/organisations/{orgId}/data-agreements:
     $ref: "./paths/config/dataAgreements/getAndAddConsentAgreements.yaml"
-  /v1/organisations/{orgId}/purposes/{purposeId}:
+  /v1/organisations/{orgId}/data-agreements/{purposeId}:
     $ref: "./paths/config/dataAgreements/getDeleteUpdateConsentAgreementByID.yaml"
   /v1/organisations/{orgId}/templates:
     $ref: "./paths/config/dataAttributes/getAndAddDataAttributes.yaml"
-  /v1/organisations/{orgId}/purposes/{purposeId}/templates:
+  /v1/organisations/{orgId}/data-agreements/{purposeId}/templates:
     $ref: "./paths/config/dataAttributes/deleteMultipleDataAttributes.yaml"
   /v1/organisations/{orgId}/templates/{templateID}:
     $ref: "./paths/config/dataAttributes/getUpdateAndDeleteDataAttributeByID.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}/purposes/{purposeID}/attributes/{attributeID}/consented/users:
+  /v1/organisations/{orgId}/data-agreements/{purposeID}/attributes/{attributeID}/consented/users:
     $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAttribute.yaml"
-  /v1/organisations/{orgId}/purposes/{purposeId}/consented/users:
+  /v1/organisations/{orgId}/data-agreements/{purposeId}/consented/users:
     $ref: "./paths/onboard/manageIndividuals/consentAgreementRecords/getAllUsersConsentedToDataAgreement.yaml"
   /v1/organisations/data-requests:
     $ref: "./paths/onboard/dataRequests/getAvailableDataRequestStatuses.yaml"