From 33351ac02f0228c8cc29901c1b2f1cab5bd45d49 Mon Sep 17 00:00:00 2001 From: George J Padayatti Date: Fri, 22 Sep 2023 13:10:16 +0530 Subject: [PATCH] Upd: paths Signed-off-by: George J Padayatti --- openapi/v2023.8.2/bundled.yaml | 1434 ++++++++--------- openapi/v2023.8.2/index.yaml | 108 +- .../paths/config/createAndGetAllWebhooks.yaml | 14 - .../config/deleteMultipleDataAttributes.yaml | 33 - .../config/getAndAddConsentAgreements.yaml | 12 - .../paths/config/getAndAddDataAttributes.yaml | 12 - .../config/getDeleteAndUpdateWebhookByID.yaml | 18 - .../getDeleteUpdateConsentAgreementByID.yaml | 15 - .../config/getRecentWebhookDeliveries.yaml | 6 - .../config/getRecentWebhookDeliveryByID.yaml | 6 - .../getUpdateAndDeleteDataAttributeByID.yaml | 15 - .../v2023.8.2/paths/config/pingWebhook.yaml | 6 - .../paths/config/redeliverWebhook.yaml | 6 - .../onboard/deleteUserFromOrganisation.yaml | 2 +- .../paths/service/getConsentHistory.yaml | 2 +- .../v2023.8.2/paths/service/getConsents.yaml | 2 +- .../getConsentsByConsentAgreementId.yaml | 2 +- .../getConsentsForAllConsentAgreements.yaml | 2 +- .../updateConsentForConsentAgreement.yaml | 4 +- .../updateConsentForDataAttribute.yaml | 2 +- 20 files changed, 707 insertions(+), 994 deletions(-) delete mode 100644 openapi/v2023.8.2/paths/config/deleteMultipleDataAttributes.yaml diff --git a/openapi/v2023.8.2/bundled.yaml b/openapi/v2023.8.2/bundled.yaml index e0d7f86..7e987bc 100644 --- a/openapi/v2023.8.2/bundled.yaml +++ b/openapi/v2023.8.2/bundled.yaml @@ -126,7 +126,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/service/users/{userId}/consenthistory': + '/v2/service/individual/{individualId}/consenthistory': get: tags: - service @@ -146,7 +146,7 @@ paths: type: integer format: int32 example: 1024 - - name: userId + - name: individualId in: path description: Individual ID required: true @@ -166,7 +166,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}': + '/v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}/data-agreements/{dataAgreementId}': get: tags: - service @@ -178,7 +178,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path description: Individual ID required: true @@ -209,7 +209,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}': + '/v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}': get: tags: - service @@ -221,7 +221,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path description: Individual ID required: true @@ -246,7 +246,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/organisations/{orgId}/users/{userId}/consents': + '/v2/service/organisations/{orgId}/individual/{individualId}/consents': get: tags: - service @@ -257,7 +257,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: @@ -275,7 +275,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/status': + '/v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}/data-agreements/{dataAgreementId}/status': post: tags: - service @@ -286,7 +286,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: @@ -330,7 +330,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: @@ -358,7 +358,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}': + '/v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}': patch: tags: - service @@ -369,7 +369,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: @@ -408,7 +408,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-status': + '/v2/service/individual/organisations/{orgId}/data-status': get: tags: - service @@ -432,7 +432,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-delete': + '/v2/service/individual/organisations/{orgId}/data-delete': get: parameters: - name: orgId @@ -478,7 +478,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-delete/status': + '/v2/service/individual/organisations/{orgId}/data-delete/status': get: tags: - service @@ -502,7 +502,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-delete/{dataReqId}/cancel': + '/v2/service/individual/organisations/{orgId}/data-delete/{dataReqId}/cancel': post: tags: - service @@ -531,7 +531,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-download': + '/v2/service/individual/organisations/{orgId}/data-download': post: tags: - service @@ -583,7 +583,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-download/status': + '/v2/service/individual/organisations/{orgId}/data-download/status': get: tags: - service @@ -607,7 +607,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/service/user/organisations/{orgId}/data-download/{dataReqId}/cancel': + '/v2/service/individual/organisations/{orgId}/data-download/{dataReqId}/cancel': post: tags: - service @@ -691,7 +691,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - /v2/onboard/users/admin/login: + /v2/onboard/individual/admin/login: post: tags: - onboard @@ -755,7 +755,7 @@ paths: error: invalid_grant error_description: Invalid user credentials deprecated: false - /v2/onboard/users/login: + /v2/onboard/individual/login: post: tags: - onboard @@ -818,7 +818,7 @@ paths: error: invalid_grant error_description: Invalid user credentials deprecated: false - /v1.1/onboard/users/login: + /v1.1/onboard/individual/login: post: tags: - onboard @@ -956,7 +956,7 @@ paths: token_type: type: string deprecated: false - /v2/onboard/users/validate/email: + /v2/onboard/individual/validate/email: post: tags: - onboard @@ -993,7 +993,7 @@ paths: Message: Email address is valid and not in use in our system deprecated: false security: [] - /v2/onboard/users/validate/phone: + /v2/onboard/individual/validate/phone: post: tags: - onboard @@ -1032,7 +1032,7 @@ paths: Message: Phone number is in use deprecated: false security: [] - /v2/onboard/users/verify/phone: + /v2/onboard/individual/verify/phone: post: tags: - onboard @@ -1061,7 +1061,7 @@ paths: content: {} deprecated: false security: [] - /v2/onboard/users/verify/otp: + /v2/onboard/individual/verify/otp: post: tags: - onboard @@ -1104,7 +1104,7 @@ paths: Message: Otp validatiation Succeeded deprecated: false security: [] - /v2/onboard/user/password/reset: + /v2/onboard/individual/password/reset: put: tags: - onboard @@ -1144,7 +1144,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin, Individual' - /v2/onboard/user/password/forgot: + /v2/onboard/individual/password/forgot: put: tags: - onboard @@ -1181,7 +1181,7 @@ paths: Message: type: string deprecated: false - /v2/onboard/users/logout: + /v2/onboard/individual/logout: post: tags: - onboard @@ -1210,7 +1210,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin, Individual' - /v2/onboard/users/token: + /v2/onboard/individual/token: post: tags: - onboard @@ -1258,7 +1258,7 @@ paths: type: string deprecated: false security: [] - /v2/onboard/users/register: + /v2/onboard/individual/register: post: tags: - onboard @@ -1966,7 +1966,7 @@ paths: Role: type: string deprecated: false - /v2/onboard/users/unregister: + /v2/onboard/individual/unregister: post: tags: - onboard @@ -2005,7 +2005,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin, Individual' - /v2/onboard/user/register/android: + /v2/onboard/individual/register/android: post: tags: - onboard @@ -2040,7 +2040,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - /v2/onboard/user/register/ios: + /v2/onboard/individual/register/ios: post: tags: - onboard @@ -2075,7 +2075,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Individual' - '/v2/onboard/user/image/{imageId}': + '/v2/onboard/individual/image/{imageId}': delete: tags: - onboard @@ -2116,7 +2116,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin, Individual' - /v2/onboard/user/image: + /v2/onboard/individual/image: post: tags: - onboard @@ -2214,7 +2214,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin, Individual' - /v2/onboard/user/apikey: + /v2/onboard/individual/apikey: post: tags: - onboard @@ -2267,7 +2267,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - /v2/onboard/user/apikey/revoke: + /v2/onboard/individual/apikey/revoke: delete: tags: - onboard @@ -2734,7 +2734,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/onboard/organisations/{orgId}/users/count': + '/v2/onboard/organisations/{orgId}/individual/count': get: tags: - onboard @@ -2911,7 +2911,7 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/onboard/organisations/{orgId}/users/{userId}': + '/v2/onboard/organisations/{orgId}/individual/{individualId}': delete: tags: - onboard @@ -2922,7 +2922,7 @@ paths: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: @@ -3096,112 +3096,76 @@ paths: x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - /v2/config/organisations/webhooks/event-types: + /v2/config/policy: get: tags: - config - description: Get webhook event types + description: Get global policy configurations + parameters: + - name: orgId + in: path + required: true + schema: + type: string responses: '200': description: OK content: application/json: schema: - required: - - EventTypes - type: object - properties: - EventTypes: - type: array - items: - type: string - example: - EventTypes: - - data.update.initiated - - data.update.cancelled - - consent.allowed - - consent.disallowed - - consent.auto_expiry - - org.unsubscribed - - data.delete.initiated - - data.download.initiated - - data.delete.cancelled - - data.download.cancelled - - org.subscribed + $ref: '#/components/schemas/GlobalDataPolicyConfiguration' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - /v2/config/organisations/webhooks/payload/content-types: - get: + post: tags: - config - description: Get webhook payload content types + description: Update global policy configurations + parameters: + - name: orgId + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GlobalDataPolicyConfiguration' + required: true responses: '200': description: OK content: application/json: schema: - required: - - ContentTypes - type: object - properties: - ContentTypes: - type: array - items: - type: string - example: - ContentTypes: - - application/json - - application/x-www-form-urlencoded + $ref: '#/components/schemas/GlobalDataPolicyConfiguration' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/webhooks': + /v2/config/data-agreements: post: tags: - config - description: Create webhook - parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string + description: Add data agreement requestBody: content: application/json: schema: required: - - payloadurl - - subscribedevents - - contenttype - - secretkey - - disabled - - skipsslverification + - purposes type: object properties: - payloadurl: - type: string - subscribedevents: + purposes: type: array items: - type: string - contenttype: - type: string - secretkey: - type: string - disabled: - type: boolean - skipsslverification: - type: boolean + $ref: '#/components/schemas/DataAgreement' required: true responses: '201': @@ -3210,666 +3174,423 @@ paths: application/json: schema: required: - - ID + - Organization + type: object + properties: + Organization: + $ref: '#/components/schemas/Organisation' + deprecated: false + security: + - BearerAuth: [] + x-badges: + - color: primary-color + label: 'Authorised roles: Organisation admin' + get: + tags: + - config + description: Get data agreements + responses: + '201': + description: Created + content: + application/json: + schema: + required: - OrgID - - PayloadURL - - ContentType - - SubscribedEvents - - Disabled - - SecretKey - - SkipSSLVerification - - TimeStamp + - Purposes type: object properties: - ID: - type: string OrgID: type: string - PayloadURL: - type: string - ContentType: - type: string - SubscribedEvents: + Purposes: type: array items: - type: string - Disabled: - type: boolean - SecretKey: - type: string - SkipSSLVerification: - type: boolean - TimeStamp: - type: string + $ref: '#/components/schemas/DataAgreement' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - get: + '/v2/config/data-agreement/{dataAgreementId}': + delete: tags: - config - description: Get all webhooks for an organisation + description: Delete data agreement by id parameters: - - name: orgId + - name: dataAgreementId in: path required: true style: simple schema: type: string responses: - '200': - description: OK + '201': + description: Created content: application/json: schema: - type: array - items: - required: - - ID - - PayloadURL - - Disabled - - TimeStamp - - IsLastDeliverySuccess - type: object - properties: - ID: - type: string - PayloadURL: - type: string - Disabled: - type: boolean - TimeStamp: - type: string - IsLastDeliverySuccess: - type: boolean + required: + - Organization + type: object + properties: + Organization: + $ref: '#/components/schemas/Organisation' + '404': + description: Not Found + content: + application/json: + schema: + required: + - Code + - Message + type: object + properties: + Code: + type: integer + format: int32 + Message: + type: string deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/webhooks/{webhookId}': - get: + put: tags: - config - description: Get a webhook by ID + description: Update data agreement by id parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId + - name: dataAgreementId in: path required: true style: simple schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DataAgreement' + required: true responses: - '200': - description: OK + '201': + description: Created content: application/json: schema: required: - - ID - - OrgID - - PayloadURL - - ContentType - - SubscribedEvents - - Disabled - - SecretKey - - SkipSSLVerification - - TimeStamp + - Organization type: object properties: - ID: - type: string - OrgID: - type: string - PayloadURL: - type: string - ContentType: - type: string - SubscribedEvents: - type: array - items: - type: string - Disabled: - type: boolean - SecretKey: - type: string - SkipSSLVerification: - type: boolean - TimeStamp: - type: string + Organization: + $ref: '#/components/schemas/Organisation' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - delete: + get: tags: - config - description: Delete webhook + description: Get data agreement by id parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId + - name: dataAgreementId in: path required: true style: simple schema: type: string responses: - '204': - description: No Content - content: {} + '200': + description: OK + content: + application/json: + schema: + required: + - Purpose + - Templates + type: object + properties: + Purpose: + $ref: '#/components/schemas/DataAgreement' + Templates: + type: string + nullable: true deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - put: + /v2/config/data-attributes: + post: tags: - config - description: Update webhook - parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId - in: path - required: true - style: simple - schema: - type: string + description: Add data attributes requestBody: content: application/json: schema: required: - - payloadurl - - subscribedevents - - contenttype - - secretkey - - disabled - - skipsslverification + - data-attributes type: object properties: - payloadurl: - type: string - subscribedevents: + data-attributes: type: array items: - type: string - contenttype: - type: string - secretkey: - type: string - disabled: - type: boolean - skipsslverification: - type: boolean + $ref: '#/components/schemas/DataAttribute' required: true responses: - '200': - description: OK + '201': + description: Created + content: + application/json: + schema: + required: + - Organization + type: object + properties: + Organization: + $ref: '#/components/schemas/Organisation' + deprecated: false + security: + - BearerAuth: [] + x-badges: + - color: primary-color + label: 'Authorised roles: Organisation admin' + get: + tags: + - config + description: Get data attributes + responses: + '201': + description: Created content: application/json: schema: required: - - ID - OrgID - - PayloadURL - - ContentType - - SubscribedEvents - - Disabled - - SecretKey - - SkipSSLVerification - - TimeStamp + - Templates type: object properties: - ID: - type: string OrgID: type: string - PayloadURL: - type: string - ContentType: - type: string - SubscribedEvents: + Templates: type: array items: - type: string - Disabled: - type: boolean - SecretKey: - type: string - SkipSSLVerification: - type: boolean - TimeStamp: - type: string + $ref: '#/components/schemas/DataAttribute' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/webhooks/{webhookId}/ping': - post: + '/v2/config/data-attributes/{dataAttributeId}': + get: tags: - config - description: Ping webhook + description: Get data attribute by ID parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId + - name: dataAttributeId in: path required: true - style: simple schema: type: string responses: - '200': - description: OK + '201': + description: Created content: application/json: schema: required: - - ResponseStatusCode - - ResponseStatusStr - - ExecutionStartTimeStamp - - ExecutionEndTimeStamp - - Status - - StatusDescription + - OrgID + - Template type: object properties: - ResponseStatusCode: - type: integer - format: int32 - ResponseStatusStr: - type: string - ExecutionStartTimeStamp: - type: string - ExecutionEndTimeStamp: - type: string - Status: - type: string - StatusDescription: + OrgID: type: string + Template: + $ref: '#/components/schemas/DataAttribute' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/webhooks/{webhookId}/delivery': - get: + put: tags: - config - description: Get recent webhook deliveries + description: Update data attribute by id parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId + - name: dataAttributeId in: path required: true - style: simple schema: type: string + requestBody: + content: + application/json: + schema: + required: + - Consent + - PurposeIDs + type: object + properties: + Consent: + type: string + PurposeIDs: + type: array + items: + type: string + required: true responses: - '200': - description: OK + '201': + description: Created content: application/json: schema: required: - - WebhookDeliveries - - Links + - Organization type: object properties: - WebhookDeliveries: - type: array - items: - required: - - ID - - WebhookID - - ResponseStatusCode - - ResponseStatusStr - - TimeStamp - - Status - - StatusDescription - type: object - properties: - ID: - type: string - WebhookID: - type: string - ResponseStatusCode: - type: integer - format: int32 - ResponseStatusStr: - type: string - TimeStamp: - type: string - Status: - type: string - StatusDescription: - type: string - Links: - $ref: '#/components/schemas/Pagination' + Organization: + $ref: '#/components/schemas/Organisation' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/webhooks/{webhookId}/delivery/{deliveryId}': - get: + delete: tags: - config - description: Get recent webhook delivery by ID + description: Delete data attribute by id parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId - in: path - required: true - style: simple - schema: - type: string - - name: deliveryId + - name: dataAttributeId in: path required: true - style: simple schema: type: string responses: - '200': - description: OK + '201': + description: Created content: application/json: schema: required: - - ID - - RequestHeaders - - RequestPayload - - ResponseHeaders - - ResponseBody - - ResponseStatusCode - - ResponseStatusStr - - ExecutionStartTimeStamp - - ExecutionEndTimeStamp - - Status - - StatusDescription + - Organization type: object properties: - ID: - type: string - RequestHeaders: - required: - - Accept - - Content-Type - - User-Agent - - X-Igrant-Signature - type: object - properties: - Accept: - type: array - items: - type: string - Content-Type: - type: array - items: - type: string - User-Agent: - type: array - items: - type: string - X-Igrant-Signature: - type: array - items: - type: string - RequestPayload: - required: - - data - - deliveryid - - timestamp - - type - - webhookid - type: object - properties: - data: - required: - - attribute - - consentID - - days - - organisationID - - dataAgreementId - - timestamp - - userID - type: object - properties: - attribute: - type: array - items: - type: string - consentID: - type: string - days: - type: integer - format: int32 - organisationID: - type: string - dataAgreementId: - type: string - timestamp: - type: string - userID: - type: string - deliveryid: - type: string - timestamp: - type: string - type: - type: string - webhookid: - type: string - ResponseHeaders: - required: - - Cache-Control - - Content-Type - - Date - - Server - - Vary - - X-Request-Id - - X-Token-Id - type: object - properties: - Cache-Control: - type: array - items: - type: string - Content-Type: - type: array - items: - type: string - Date: - type: array - items: - type: string - Server: - type: array - items: - type: string - Vary: - type: array - items: - type: string - X-Request-Id: - type: array - items: - type: string - X-Token-Id: - type: array - items: - type: string - ResponseBody: - type: string - ResponseStatusCode: - type: integer - format: int32 - ResponseStatusStr: - type: string - ExecutionStartTimeStamp: - type: string - ExecutionEndTimeStamp: - type: string - Status: - type: string - StatusDescription: - type: string - deprecated: false - security: - - BearerAuth: [] - x-badges: - - color: primary-color - label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/webhooks/{webhookId}/delivery/{deliveryId}/redeliver': - post: - tags: - - config - description: Redeliver a webhook payload by delivery ID - parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - - name: webhookId - in: path - required: true - style: simple - schema: - type: string - - name: deliveryId - in: path - required: true - style: simple - schema: - type: string - responses: - '200': - description: OK - content: {} + Organization: + $ref: '#/components/schemas/Organisation' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/config/policy': + /v2/config/webhooks/event-types: get: tags: - config - description: Get global policy configurations - parameters: - - name: orgId - in: path - required: true - schema: - type: string + description: Get webhook event types responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/GlobalDataPolicyConfiguration' + required: + - EventTypes + type: object + properties: + EventTypes: + type: array + items: + type: string + example: + EventTypes: + - data.update.initiated + - data.update.cancelled + - consent.allowed + - consent.disallowed + - consent.auto_expiry + - org.unsubscribed + - data.delete.initiated + - data.download.initiated + - data.delete.cancelled + - data.download.cancelled + - org.subscribed deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - post: + /v2/config/webhooks/payload/content-types: + get: tags: - config - description: Update global policy configurations - parameters: - - name: orgId - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GlobalDataPolicyConfiguration' - required: true + description: Get webhook payload content types responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/GlobalDataPolicyConfiguration' + required: + - ContentTypes + type: object + properties: + ContentTypes: + type: array + items: + type: string + example: + ContentTypes: + - application/json + - application/x-www-form-urlencoded deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/data-agreements': + /v2/config/webhooks: post: tags: - config - description: Add data agreement - parameters: - - name: orgId - in: path - required: true - schema: - type: string + description: Create webhook requestBody: content: application/json: schema: required: - - purposes + - payloadurl + - subscribedevents + - contenttype + - secretkey + - disabled + - skipsslverification type: object properties: - purposes: + payloadurl: + type: string + subscribedevents: type: array items: - $ref: '#/components/schemas/DataAgreement' + type: string + contenttype: + type: string + secretkey: + type: string + disabled: + type: boolean + skipsslverification: + type: boolean required: true responses: '201': @@ -3878,187 +3599,165 @@ paths: application/json: schema: required: - - Organization - type: object - properties: - Organization: - $ref: '#/components/schemas/Organisation' - deprecated: false - security: - - BearerAuth: [] - x-badges: - - color: primary-color - label: 'Authorised roles: Organisation admin' - get: - tags: - - config - description: Get data agreements - parameters: - - name: orgId - in: path - required: true - schema: - type: string - responses: - '201': - description: Created - content: - application/json: - schema: - required: + - ID - OrgID - - Purposes + - PayloadURL + - ContentType + - SubscribedEvents + - Disabled + - SecretKey + - SkipSSLVerification + - TimeStamp type: object properties: + ID: + type: string OrgID: type: string - Purposes: - type: array - items: - $ref: '#/components/schemas/DataAgreement' + PayloadURL: + type: string + ContentType: + type: string + SubscribedEvents: + type: array + items: + type: string + Disabled: + type: boolean + SecretKey: + type: string + SkipSSLVerification: + type: boolean + TimeStamp: + type: string deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/config/data-agreements/{dataAgreementId}': - delete: + get: tags: - config - description: Delete data agreement by id - parameters: - - name: orgId - in: path - required: true - schema: - type: string - - name: dataAgreementId - in: path - required: true - style: simple - schema: - type: string + description: Get all webhooks for an organisation responses: - '201': - description: Created - content: - application/json: - schema: - required: - - Organization - type: object - properties: - Organization: - $ref: '#/components/schemas/Organisation' - '404': - description: Not Found + '200': + description: OK content: application/json: schema: - required: - - Code - - Message - type: object - properties: - Code: - type: integer - format: int32 - Message: - type: string + type: array + items: + required: + - ID + - PayloadURL + - Disabled + - TimeStamp + - IsLastDeliverySuccess + type: object + properties: + ID: + type: string + PayloadURL: + type: string + Disabled: + type: boolean + TimeStamp: + type: string + IsLastDeliverySuccess: + type: boolean deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - put: + '/v2/config/webhooks/{webhookId}': + get: tags: - config - description: Update data agreement by id + description: Get a webhook by ID parameters: - - name: orgId - in: path - required: true - schema: - type: string - - name: dataAgreementId + - name: webhookId in: path required: true style: simple schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DataAgreement' - required: true responses: - '201': - description: Created + '200': + description: OK content: application/json: schema: required: - - Organization + - ID + - OrgID + - PayloadURL + - ContentType + - SubscribedEvents + - Disabled + - SecretKey + - SkipSSLVerification + - TimeStamp type: object properties: - Organization: - $ref: '#/components/schemas/Organisation' + ID: + type: string + OrgID: + type: string + PayloadURL: + type: string + ContentType: + type: string + SubscribedEvents: + type: array + items: + type: string + Disabled: + type: boolean + SecretKey: + type: string + SkipSSLVerification: + type: boolean + TimeStamp: + type: string deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - get: + delete: tags: - config - description: Get data agreement by id + description: Delete webhook parameters: - - name: orgId - in: path - required: true - schema: - type: string - - name: dataAgreementId + - name: webhookId in: path required: true style: simple schema: type: string responses: - '200': - description: OK - content: - application/json: - schema: - required: - - Purpose - - Templates - type: object - properties: - Purpose: - $ref: '#/components/schemas/DataAgreement' - Templates: - type: string - nullable: true + '204': + description: No Content + content: {} deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/data-attributes': - post: + put: tags: - config - description: Add data attributes + description: Update webhook parameters: - - name: orgId + - name: webhookId in: path required: true + style: simple schema: type: string requestBody: @@ -4066,79 +3765,83 @@ paths: application/json: schema: required: - - data-attributes + - payloadurl + - subscribedevents + - contenttype + - secretkey + - disabled + - skipsslverification type: object properties: - data-attributes: + payloadurl: + type: string + subscribedevents: type: array items: - $ref: '#/components/schemas/DataAttribute' + type: string + contenttype: + type: string + secretkey: + type: string + disabled: + type: boolean + skipsslverification: + type: boolean required: true responses: - '201': - description: Created - content: - application/json: - schema: - required: - - Organization - type: object - properties: - Organization: - $ref: '#/components/schemas/Organisation' - deprecated: false - security: - - BearerAuth: [] - x-badges: - - color: primary-color - label: 'Authorised roles: Organisation admin' - get: - tags: - - config - description: Get data attributes - parameters: - - name: orgId - in: path - required: true - schema: - type: string - responses: - '201': - description: Created + '200': + description: OK content: application/json: schema: required: + - ID - OrgID - - Templates + - PayloadURL + - ContentType + - SubscribedEvents + - Disabled + - SecretKey + - SkipSSLVerification + - TimeStamp type: object properties: + ID: + type: string OrgID: type: string - Templates: + PayloadURL: + type: string + ContentType: + type: string + SubscribedEvents: type: array items: - $ref: '#/components/schemas/DataAttribute' + type: string + Disabled: + type: boolean + SecretKey: + type: string + SkipSSLVerification: + type: boolean + TimeStamp: + type: string deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/config/data-agreements/{dataAgreementId}/data-attributes': - delete: + '/v2/config/webhooks/{webhookId}/ping': + post: tags: - config - description: Delete multiple data attributes + description: Ping webhook parameters: - - name: orgId - in: path - required: true - schema: - type: string - - name: dataAgreementId + - name: webhookId in: path required: true + style: simple schema: type: string responses: @@ -4148,130 +3851,283 @@ paths: application/json: schema: required: - - Organization + - ResponseStatusCode + - ResponseStatusStr + - ExecutionStartTimeStamp + - ExecutionEndTimeStamp + - Status + - StatusDescription type: object properties: - Organization: - $ref: '#/components/schemas/Organisation' + ResponseStatusCode: + type: integer + format: int32 + ResponseStatusStr: + type: string + ExecutionStartTimeStamp: + type: string + ExecutionEndTimeStamp: + type: string + Status: + type: string + StatusDescription: + type: string deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - '/v2/config/organisations/{orgId}/data-attributes/{dataAttributeId}': + '/v2/config/webhooks/{webhookId}/delivery': get: tags: - config - description: Get data attribute by ID + description: Get recent webhook deliveries parameters: - - name: orgId - in: path - required: true - schema: - type: string - - name: dataAttributeId + - name: webhookId in: path required: true + style: simple schema: type: string responses: - '201': - description: Created + '200': + description: OK content: application/json: schema: required: - - OrgID - - Template + - WebhookDeliveries + - Links type: object properties: - OrgID: - type: string - Template: - $ref: '#/components/schemas/DataAttribute' + WebhookDeliveries: + type: array + items: + required: + - ID + - WebhookID + - ResponseStatusCode + - ResponseStatusStr + - TimeStamp + - Status + - StatusDescription + type: object + properties: + ID: + type: string + WebhookID: + type: string + ResponseStatusCode: + type: integer + format: int32 + ResponseStatusStr: + type: string + TimeStamp: + type: string + Status: + type: string + StatusDescription: + type: string + Links: + $ref: '#/components/schemas/Pagination' deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - put: + '/v2/config/webhooks/{webhookId}/delivery/{deliveryId}': + get: tags: - config - description: Update data attribute by id + description: Get recent webhook delivery by ID parameters: - - name: orgId + - name: webhookId in: path required: true + style: simple schema: type: string - - name: dataAttributeId + - name: deliveryId in: path required: true + style: simple schema: type: string - requestBody: - content: - application/json: - schema: - required: - - Consent - - PurposeIDs - type: object - properties: - Consent: - type: string - PurposeIDs: - type: array - items: - type: string - required: true responses: - '201': - description: Created + '200': + description: OK content: application/json: schema: required: - - Organization + - ID + - RequestHeaders + - RequestPayload + - ResponseHeaders + - ResponseBody + - ResponseStatusCode + - ResponseStatusStr + - ExecutionStartTimeStamp + - ExecutionEndTimeStamp + - Status + - StatusDescription type: object properties: - Organization: - $ref: '#/components/schemas/Organisation' + ID: + type: string + RequestHeaders: + required: + - Accept + - Content-Type + - User-Agent + - X-Igrant-Signature + type: object + properties: + Accept: + type: array + items: + type: string + Content-Type: + type: array + items: + type: string + User-Agent: + type: array + items: + type: string + X-Igrant-Signature: + type: array + items: + type: string + RequestPayload: + required: + - data + - deliveryid + - timestamp + - type + - webhookid + type: object + properties: + data: + required: + - attribute + - consentID + - days + - organisationID + - dataAgreementId + - timestamp + - userID + type: object + properties: + attribute: + type: array + items: + type: string + consentID: + type: string + days: + type: integer + format: int32 + organisationID: + type: string + dataAgreementId: + type: string + timestamp: + type: string + userID: + type: string + deliveryid: + type: string + timestamp: + type: string + type: + type: string + webhookid: + type: string + ResponseHeaders: + required: + - Cache-Control + - Content-Type + - Date + - Server + - Vary + - X-Request-Id + - X-Token-Id + type: object + properties: + Cache-Control: + type: array + items: + type: string + Content-Type: + type: array + items: + type: string + Date: + type: array + items: + type: string + Server: + type: array + items: + type: string + Vary: + type: array + items: + type: string + X-Request-Id: + type: array + items: + type: string + X-Token-Id: + type: array + items: + type: string + ResponseBody: + type: string + ResponseStatusCode: + type: integer + format: int32 + ResponseStatusStr: + type: string + ExecutionStartTimeStamp: + type: string + ExecutionEndTimeStamp: + type: string + Status: + type: string + StatusDescription: + type: string deprecated: false security: - BearerAuth: [] x-badges: - color: primary-color label: 'Authorised roles: Organisation admin' - delete: + '/v2/config/webhooks/{webhookId}/delivery/{deliveryId}/redeliver': + post: tags: - config - description: Delete data attribute by id + description: Redeliver a webhook payload by delivery ID parameters: - - name: orgId + - name: webhookId in: path required: true + style: simple schema: type: string - - name: dataAttributeId + - name: deliveryId in: path required: true + style: simple schema: type: string responses: - '201': - description: Created - content: - application/json: - schema: - required: - - Organization - type: object - properties: - Organization: - $ref: '#/components/schemas/Organisation' + '200': + description: OK + content: {} deprecated: false security: - BearerAuth: [] diff --git a/openapi/v2023.8.2/index.yaml b/openapi/v2023.8.2/index.yaml index dc06dc0..e2afe6a 100644 --- a/openapi/v2023.8.2/index.yaml +++ b/openapi/v2023.8.2/index.yaml @@ -58,59 +58,59 @@ paths: $ref: "./paths/audit/get_consent_record.yaml" # Service - /v2/service/users/{userId}/consenthistory: + /v2/service/individual/{individualId}/consenthistory: $ref: "./paths/service/getConsentHistory.yaml" - /v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}: + /v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}/data-agreements/{dataAgreementId}: $ref: "./paths/service/getConsentsByConsentAgreementId.yaml" - /v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}: + /v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}: $ref: "./paths/service/getConsentsForAllConsentAgreements.yaml" - /v2/service/organisations/{orgId}/users/{userId}/consents: + /v2/service/organisations/{orgId}/individual/{individualId}/consents: $ref: "./paths/service/getConsents.yaml" - /v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/status: + /v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}/data-agreements/{dataAgreementId}/status: $ref: "./paths/service/updateConsentForConsentAgreement.yaml" - /v2/service/organisations/{orgId}/users/{userId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}: + /v2/service/organisations/{orgId}/individual/{individualId}/consents/{consentId}/data-agreements/{dataAgreementId}/attributes/{attributeId}: $ref: "./paths/service/updateConsentForDataAttribute.yaml" - /v2/service/user/organisations/{orgId}/data-status: + /v2/service/individual/organisations/{orgId}/data-status: $ref: "./paths/service/listAllDataRequests.yaml" - /v2/service/user/organisations/{orgId}/data-delete: + /v2/service/individual/organisations/{orgId}/data-delete: $ref: "./paths/service/sendAndGetAllDeleteMyDataRequests.yaml" - /v2/service/user/organisations/{orgId}/data-delete/status: + /v2/service/individual/organisations/{orgId}/data-delete/status: $ref: "./paths/service/getDeleteMyDataRequestStatus.yaml" - /v2/service/user/organisations/{orgId}/data-delete/{dataReqId}/cancel: + /v2/service/individual/organisations/{orgId}/data-delete/{dataReqId}/cancel: $ref: "./paths/service/cancelDeleteMyDataRequest.yaml" - /v2/service/user/organisations/{orgId}/data-download: + /v2/service/individual/organisations/{orgId}/data-download: $ref: "./paths/service/sendAndGetAllDownloadMyDataRequests.yaml" - /v2/service/user/organisations/{orgId}/data-download/status: + /v2/service/individual/organisations/{orgId}/data-download/status: $ref: "./paths/service/getDownloadMyDataRequestStatus.yaml" - /v2/service/user/organisations/{orgId}/data-download/{dataReqId}/cancel: + /v2/service/individual/organisations/{orgId}/data-download/{dataReqId}/cancel: $ref: "./paths/service/cancelDownloadMyDataRequest.yaml" /v2/service/GetUserOrgsAndConsents: $ref: "./paths/service/getUserOrgAndConsent.yaml" # Onboard - /v2/onboard/users/admin/login: + /v2/onboard/individual/admin/login: $ref: "./paths/onboard/loginAsOrganisationAdmin.yaml" - /v2/onboard/users/login: + /v2/onboard/individual/login: $ref: "./paths/onboard/loginAsIndividual.yaml" - /v1.1/onboard/users/login: + /v1.1/onboard/individual/login: $ref: "./paths/onboard/loginAsIndividualV11.yaml" - /v2/onboard/users/validate/email: + /v2/onboard/individual/validate/email: $ref: "./paths/onboard/validateEmail.yaml" - /v2/onboard/users/validate/phone: + /v2/onboard/individual/validate/phone: $ref: "./paths/onboard/validatePhone.yaml" - /v2/onboard/users/verify/phone: + /v2/onboard/individual/verify/phone: $ref: "./paths/onboard/verifyPhone.yaml" - /v2/onboard/users/verify/otp: + /v2/onboard/individual/verify/otp: $ref: "./paths/onboard/verifyOTP.yaml" - /v2/onboard/user/password/reset: + /v2/onboard/individual/password/reset: $ref: "./paths/onboard/resetPassword.yaml" - /v2/onboard/user/password/forgot: + /v2/onboard/individual/password/forgot: $ref: "./paths/onboard/forgotPassword.yaml" - /v2/onboard/users/logout: + /v2/onboard/individual/logout: $ref: "./paths/onboard/logout.yaml" - /v2/onboard/users/token: + /v2/onboard/individual/token: $ref: "./paths/onboard/refreshToken.yaml" - /v2/onboard/users/register: + /v2/onboard/individual/register: $ref: "./paths/onboard/register.yaml" /v2/onboard/organisations/types: $ref: "./paths/onboard/getAndAddOrganisationTypes.yaml" @@ -136,21 +136,21 @@ paths: $ref: "./paths/onboard/addGetDeleteOrganisationAdmin.yaml" /v2/onboard/organisations/roles: $ref: "./paths/onboard/getOrganisationRoles.yaml" - /v2/onboard/users/unregister: + /v2/onboard/individual/unregister: $ref: "./paths/onboard/unregisterUser.yaml" - /v2/onboard/user/register/android: + /v2/onboard/individual/register/android: $ref: "./paths/onboard/userClientRegisterAndroid.yaml" - /v2/onboard/user/register/ios: + /v2/onboard/individual/register/ios: $ref: "./paths/onboard/userClientRegisteriOS.yaml" - /v2/onboard/user/image/{imageId}: + /v2/onboard/individual/image/{imageId}: $ref: "./paths/onboard/getAndDeleteUserImageByID.yaml" - /v2/onboard/user/image: + /v2/onboard/individual/image: $ref: "./paths/onboard/updateUserImage.yaml" /v2/onboard/user: $ref: "./paths/onboard/getAndUpdateUserProfile.yaml" - /v2/onboard/user/apikey: + /v2/onboard/individual/apikey: $ref: "./paths/onboard/getAndCreateAPIKey.yaml" - /v2/onboard/user/apikey/revoke: + /v2/onboard/individual/apikey/revoke: $ref: "./paths/onboard/deleteAPIKey.yaml" /v2/onboard/organisations/{orgId}/idp/open-id: $ref: "./paths/onboard/addGetUpdateAndDeleteIdentityProvider.yaml" @@ -166,13 +166,13 @@ paths: $ref: "./paths/onboard/getCurrentSubscriptionKey.yaml" /v2/onboard/organisations/{orgId}/subscribe-key/renew: $ref: "./paths/onboard/renewSubscriptionKey.yaml" - /v2/onboard/organisations/{orgId}/users/count: + /v2/onboard/organisations/{orgId}/individual/count: $ref: "./paths/onboard/getOrganisationUsersCount.yaml" /v2/onboard/organisations/{orgId}/subscription: $ref: "./paths/onboard/getOrganisationSubscriptionStatus.yaml" /v2/onboard/organisations/{orgId}/users: $ref: "./paths/onboard/addAndGetOrganisationUsers.yaml" - /v2/onboard/organisations/{orgId}/users/{userId}: + /v2/onboard/organisations/{orgId}/individual/{individualId}: $ref: "./paths/onboard/deleteUserFromOrganisation.yaml" /v2/onboard/organisations/data-requests: $ref: "./paths/onboard/getAvailableDataRequestStatuses.yaml" @@ -182,34 +182,34 @@ paths: $ref: "./paths/onboard/getAndUpdateDataRequestByID.yaml" # Config - /v2/config/organisations/webhooks/event-types: + /v2/config/policy: + $ref: "./paths/config/getAndUpdateGlobalPolicyConfiguration.yaml" + /v2/config/data-agreements: + $ref: "./paths/config/getAndAddConsentAgreements.yaml" + /v2/config/data-agreement/{dataAgreementId}: + $ref: "./paths/config/getDeleteUpdateConsentAgreementByID.yaml" + /v2/config/data-attributes: + $ref: "./paths/config/getAndAddDataAttributes.yaml" + /v2/config/data-attributes/{dataAttributeId}: + $ref: "./paths/config/getUpdateAndDeleteDataAttributeByID.yaml" + /v2/config/webhooks/event-types: $ref: "./paths/config/getAvailableWebhookEventTypes.yaml" - /v2/config/organisations/webhooks/payload/content-types: + /v2/config/webhooks/payload/content-types: $ref: "./paths/config/getAvailableWebhookPayloadTypes.yaml" - /v2/config/organisations/{orgId}/webhooks: + /v2/config/webhooks: $ref: "./paths/config/createAndGetAllWebhooks.yaml" - /v2/config/organisations/{orgId}/webhooks/{webhookId}: + /v2/config/webhooks/{webhookId}: $ref: "./paths/config/getDeleteAndUpdateWebhookByID.yaml" - /v2/config/organisations/{orgId}/webhooks/{webhookId}/ping: + /v2/config/webhooks/{webhookId}/ping: $ref: "./paths/config/pingWebhook.yaml" - /v2/config/organisations/{orgId}/webhooks/{webhookId}/delivery: + /v2/config/webhooks/{webhookId}/delivery: $ref: "./paths/config/getRecentWebhookDeliveries.yaml" - /v2/config/organisations/{orgId}/webhooks/{webhookId}/delivery/{deliveryId}: + /v2/config/webhooks/{webhookId}/delivery/{deliveryId}: $ref: "./paths/config/getRecentWebhookDeliveryByID.yaml" - /v2/config/organisations/{orgId}/webhooks/{webhookId}/delivery/{deliveryId}/redeliver: + /v2/config/webhooks/{webhookId}/delivery/{deliveryId}/redeliver: $ref: "./paths/config/redeliverWebhook.yaml" - /v2/config/organisations/{orgId}/config/policy: - $ref: "./paths/config/getAndUpdateGlobalPolicyConfiguration.yaml" - /v2/config/organisations/{orgId}/data-agreements: - $ref: "./paths/config/getAndAddConsentAgreements.yaml" - /v2/config/organisations/{orgId}/config/data-agreements/{dataAgreementId}: - $ref: "./paths/config/getDeleteUpdateConsentAgreementByID.yaml" - /v2/config/organisations/{orgId}/data-attributes: - $ref: "./paths/config/getAndAddDataAttributes.yaml" - /v2/config/organisations/{orgId}/config/data-agreements/{dataAgreementId}/data-attributes: - $ref: "./paths/config/deleteMultipleDataAttributes.yaml" - /v2/config/organisations/{orgId}/data-attributes/{dataAttributeId}: - $ref: "./paths/config/getUpdateAndDeleteDataAttributeByID.yaml" + + components: schemas: Log: diff --git a/openapi/v2023.8.2/paths/config/createAndGetAllWebhooks.yaml b/openapi/v2023.8.2/paths/config/createAndGetAllWebhooks.yaml index 37b344a..b54d39f 100644 --- a/openapi/v2023.8.2/paths/config/createAndGetAllWebhooks.yaml +++ b/openapi/v2023.8.2/paths/config/createAndGetAllWebhooks.yaml @@ -2,13 +2,6 @@ post: tags: - config description: Create webhook - parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string requestBody: content: application/json: @@ -85,13 +78,6 @@ get: tags: - config description: Get all webhooks for an organisation - parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string responses: "200": description: OK diff --git a/openapi/v2023.8.2/paths/config/deleteMultipleDataAttributes.yaml b/openapi/v2023.8.2/paths/config/deleteMultipleDataAttributes.yaml deleted file mode 100644 index c224e5a..0000000 --- a/openapi/v2023.8.2/paths/config/deleteMultipleDataAttributes.yaml +++ /dev/null @@ -1,33 +0,0 @@ -delete: - tags: - - config - description: Delete multiple data attributes - parameters: - - name: orgId - in: path - required: true - schema: - type: string - - name: dataAgreementId - in: path - required: true - schema: - type: string - responses: - "200": - description: OK - content: - application/json: - schema: - required: - - Organization - type: object - properties: - Organization: - $ref: "../../definitions/Organisation.yaml" - deprecated: false - security: - - BearerAuth: [] - x-badges: - - color: primary-color # <<< Allowed values (red, green, orange, blue, primary-color) - label: 'Authorised roles: Organisation admin' diff --git a/openapi/v2023.8.2/paths/config/getAndAddConsentAgreements.yaml b/openapi/v2023.8.2/paths/config/getAndAddConsentAgreements.yaml index d91b960..c35983f 100644 --- a/openapi/v2023.8.2/paths/config/getAndAddConsentAgreements.yaml +++ b/openapi/v2023.8.2/paths/config/getAndAddConsentAgreements.yaml @@ -2,12 +2,6 @@ post: tags: - config description: Add data agreement - parameters: - - name: orgId - in: path - required: true - schema: - type: string requestBody: content: application/json: @@ -43,12 +37,6 @@ get: tags: - config description: Get data agreements - parameters: - - name: orgId - in: path - required: true - schema: - type: string responses: "201": description: Created diff --git a/openapi/v2023.8.2/paths/config/getAndAddDataAttributes.yaml b/openapi/v2023.8.2/paths/config/getAndAddDataAttributes.yaml index c8ca91f..1cb674e 100644 --- a/openapi/v2023.8.2/paths/config/getAndAddDataAttributes.yaml +++ b/openapi/v2023.8.2/paths/config/getAndAddDataAttributes.yaml @@ -2,12 +2,6 @@ post: tags: - config description: Add data attributes - parameters: - - name: orgId - in: path - required: true - schema: - type: string requestBody: content: application/json: @@ -43,12 +37,6 @@ get: tags: - config description: Get data attributes - parameters: - - name: orgId - in: path - required: true - schema: - type: string responses: "201": description: Created diff --git a/openapi/v2023.8.2/paths/config/getDeleteAndUpdateWebhookByID.yaml b/openapi/v2023.8.2/paths/config/getDeleteAndUpdateWebhookByID.yaml index ef3b975..1f949e5 100644 --- a/openapi/v2023.8.2/paths/config/getDeleteAndUpdateWebhookByID.yaml +++ b/openapi/v2023.8.2/paths/config/getDeleteAndUpdateWebhookByID.yaml @@ -3,12 +3,6 @@ get: - config description: Get a webhook by ID parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true @@ -64,12 +58,6 @@ delete: - config description: Delete webhook parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true @@ -91,12 +79,6 @@ put: - config description: Update webhook parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true diff --git a/openapi/v2023.8.2/paths/config/getDeleteUpdateConsentAgreementByID.yaml b/openapi/v2023.8.2/paths/config/getDeleteUpdateConsentAgreementByID.yaml index d1259f6..92ebdd6 100644 --- a/openapi/v2023.8.2/paths/config/getDeleteUpdateConsentAgreementByID.yaml +++ b/openapi/v2023.8.2/paths/config/getDeleteUpdateConsentAgreementByID.yaml @@ -3,11 +3,6 @@ delete: - config description: Delete data agreement by id parameters: - - name: orgId - in: path - required: true - schema: - type: string - name: dataAgreementId in: path required: true @@ -52,11 +47,6 @@ put: - config description: Update data agreement by id parameters: - - name: orgId - in: path - required: true - schema: - type: string - name: dataAgreementId in: path required: true @@ -92,11 +82,6 @@ get: - config description: Get data agreement by id parameters: - - name: orgId - in: path - required: true - schema: - type: string - name: dataAgreementId in: path required: true diff --git a/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveries.yaml b/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveries.yaml index c570d66..47204bb 100644 --- a/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveries.yaml +++ b/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveries.yaml @@ -3,12 +3,6 @@ get: - config description: Get recent webhook deliveries parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true diff --git a/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveryByID.yaml b/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveryByID.yaml index e6deeb0..713d986 100644 --- a/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveryByID.yaml +++ b/openapi/v2023.8.2/paths/config/getRecentWebhookDeliveryByID.yaml @@ -3,12 +3,6 @@ get: - config description: Get recent webhook delivery by ID parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true diff --git a/openapi/v2023.8.2/paths/config/getUpdateAndDeleteDataAttributeByID.yaml b/openapi/v2023.8.2/paths/config/getUpdateAndDeleteDataAttributeByID.yaml index 912e36f..2007999 100644 --- a/openapi/v2023.8.2/paths/config/getUpdateAndDeleteDataAttributeByID.yaml +++ b/openapi/v2023.8.2/paths/config/getUpdateAndDeleteDataAttributeByID.yaml @@ -3,11 +3,6 @@ get: - config description: Get data attribute by ID parameters: - - name: orgId - in: path - required: true - schema: - type: string - name: dataAttributeId in: path required: true @@ -39,11 +34,6 @@ put: - config description: Update data attribute by id parameters: - - name: orgId - in: path - required: true - schema: - type: string - name: dataAttributeId in: path required: true @@ -88,11 +78,6 @@ delete: - config description: Delete data attribute by id parameters: - - name: orgId - in: path - required: true - schema: - type: string - name: dataAttributeId in: path required: true diff --git a/openapi/v2023.8.2/paths/config/pingWebhook.yaml b/openapi/v2023.8.2/paths/config/pingWebhook.yaml index ea2d7f6..891f879 100644 --- a/openapi/v2023.8.2/paths/config/pingWebhook.yaml +++ b/openapi/v2023.8.2/paths/config/pingWebhook.yaml @@ -3,12 +3,6 @@ post: - config description: Ping webhook parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true diff --git a/openapi/v2023.8.2/paths/config/redeliverWebhook.yaml b/openapi/v2023.8.2/paths/config/redeliverWebhook.yaml index c6abb90..d61ae43 100644 --- a/openapi/v2023.8.2/paths/config/redeliverWebhook.yaml +++ b/openapi/v2023.8.2/paths/config/redeliverWebhook.yaml @@ -3,12 +3,6 @@ post: - config description: Redeliver a webhook payload by delivery ID parameters: - - name: orgId - in: path - required: true - style: simple - schema: - type: string - name: webhookId in: path required: true diff --git a/openapi/v2023.8.2/paths/onboard/deleteUserFromOrganisation.yaml b/openapi/v2023.8.2/paths/onboard/deleteUserFromOrganisation.yaml index c7ad6ef..cdef515 100644 --- a/openapi/v2023.8.2/paths/onboard/deleteUserFromOrganisation.yaml +++ b/openapi/v2023.8.2/paths/onboard/deleteUserFromOrganisation.yaml @@ -8,7 +8,7 @@ delete: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: diff --git a/openapi/v2023.8.2/paths/service/getConsentHistory.yaml b/openapi/v2023.8.2/paths/service/getConsentHistory.yaml index 1cdfb80..d53b3c8 100644 --- a/openapi/v2023.8.2/paths/service/getConsentHistory.yaml +++ b/openapi/v2023.8.2/paths/service/getConsentHistory.yaml @@ -17,7 +17,7 @@ get: type: integer format: int32 example: 1024 - - name: userId + - name: individualId in: path description: "Individual ID" required: true diff --git a/openapi/v2023.8.2/paths/service/getConsents.yaml b/openapi/v2023.8.2/paths/service/getConsents.yaml index 95f8e3f..d2a4f78 100644 --- a/openapi/v2023.8.2/paths/service/getConsents.yaml +++ b/openapi/v2023.8.2/paths/service/getConsents.yaml @@ -8,7 +8,7 @@ get: required: true schema: type: string - - name: userId + - name: individualId 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 0ba67f0..5e75a81 100644 --- a/openapi/v2023.8.2/paths/service/getConsentsByConsentAgreementId.yaml +++ b/openapi/v2023.8.2/paths/service/getConsentsByConsentAgreementId.yaml @@ -9,7 +9,7 @@ get: required: true schema: type: string - - name: userId + - name: individualId in: path description: "Individual ID" required: true diff --git a/openapi/v2023.8.2/paths/service/getConsentsForAllConsentAgreements.yaml b/openapi/v2023.8.2/paths/service/getConsentsForAllConsentAgreements.yaml index 3f1c05d..aaa659d 100644 --- a/openapi/v2023.8.2/paths/service/getConsentsForAllConsentAgreements.yaml +++ b/openapi/v2023.8.2/paths/service/getConsentsForAllConsentAgreements.yaml @@ -9,7 +9,7 @@ get: required: true schema: type: string - - name: userId + - name: individualId in: path description: "Individual ID" required: true diff --git a/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml b/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml index 0ee97cf..278940f 100644 --- a/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml +++ b/openapi/v2023.8.2/paths/service/updateConsentForConsentAgreement.yaml @@ -8,7 +8,7 @@ post: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: @@ -52,7 +52,7 @@ get: required: true schema: type: string - - name: userId + - name: individualId 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 9fed071..006489f 100644 --- a/openapi/v2023.8.2/paths/service/updateConsentForDataAttribute.yaml +++ b/openapi/v2023.8.2/paths/service/updateConsentForDataAttribute.yaml @@ -8,7 +8,7 @@ patch: required: true schema: type: string - - name: userId + - name: individualId in: path required: true schema: