Upd: Add webhook endpoints

Signed-off-by: George J Padayatti <[email protected]>

openapi/v2023.8.2/definitions/Webhook.yaml

@@ -0,0 +1,30 @@
+required:
+  - payloadUrl
+  - contentType
+  - subscribedEvents
+  - disabled
+  - secretKey
+  - skipSslVerification
+  - timestamp
+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

openapi/v2023.8.2/definitions/WebhookEventType.yaml

@@ -0,0 +1,14 @@
+type: string
+title: WebhookEventType
+enum:
+  - 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

openapi/v2023.8.2/index.yaml

@@ -1,5 +1,7 @@
 components:
   schemas:
+    Webhook:
+      $ref: "./definitions/Webhook.yaml"
     Pagination:
       $ref: "./definitions/Pagination.yaml"
     DataAgreement:
@@ -92,7 +94,7 @@ paths:
       $ref: ./paths/configCreatePolicy.yaml
   /config/policy/{policyId}:
     get:
-        $ref: ./paths/configReadPolicy.yaml
+      $ref: ./paths/configReadPolicy.yaml
     put:
       $ref: ./paths/configUpdatePolicy.yaml
     delete:
@@ -103,6 +105,37 @@ paths:
   /config/policy/{policyId}/revisions:
     get:
       $ref: ./paths/configListPolicyRevisions.yaml
+  /config/webhooks/event-types:
+    get:
+      $ref: "./paths/configReadWebhookEventTypes.yaml"
+  /config/webhooks/payload/content-types:
+    get:
+      $ref: "./paths/getWebhookPayloadContentTypes.yaml"
+  /config/webhook:
+    post:
+      $ref: "./paths/configCreateWebhook.yaml"
+  /config/webhooks:
+    get:
+      $ref: "./paths/configListWebhooks.yaml"
+  /config/webhook/{webhookId}:
+    get:
+      $ref: "./paths/configReadWebhook.yaml"
+    delete:
+      $ref: "./paths/configDeleteWebhook.yaml"
+    put:
+      $ref: "./paths/configUpdateWebhook.yaml"
+  /config/webhook/{webhookId}/ping:
+    post:
+      $ref: "./paths/configPingWebhook.yaml"
+  /config/webhooks/{webhookId}/deliveries:
+    get:
+      $ref: "./paths/configListAllRecentWebhookDeliveries.yaml"
+  /config/webhooks/{webhookId}/delivery/{deliveryId}:
+    get:
+      $ref: "./paths/configReadRecentWebhookDelivery.yaml"
+  /config/webhooks/{webhookId}/delivery/{deliveryId}/redeliver:
+    post:
+      $ref: "./paths/configRedeliverWebhook.yaml"
   /onboard/admin/login:
     post:
       $ref: ./paths/loginOrganisationAdmin.yaml

openapi/v2023.8.2/paths/configCreateWebhook.yaml

@@ -0,0 +1,21 @@
+operationId: configCreateWebhook
+summary: CREATE - Create webhook
+description: Create webhook
+tags:
+  - config
+requestBody:
+  content:
+    application/json:
+      schema:
+        $ref: "../definitions/Webhook.yaml"
+  required: true
+responses:
+  "201":
+    description: Created
+    content:
+      application/json:
+        schema:
+          $ref: "../definitions/Webhook.yaml"
+deprecated: false
+security:
+  - BearerAuth: []

openapi/v2023.8.2/paths/configDeleteWebhook.yaml

@@ -0,0 +1,19 @@
+operationId: configDeleteWebhook
+summary: DELETE - Delete webhook
+description: Delete webhook
+tags:
+  - config
+parameters:
+  - name: webhookId
+    in: path
+    required: true
+    style: simple
+    schema:
+      type: string
+responses:
+  "204":
+    description: No Content
+    content: {}
+deprecated: false
+security:
+  - BearerAuth: []

openapi/v2023.8.2/paths/configListAllRecentWebhookDeliveries.yaml

@@ -0,0 +1,51 @@
+operationId: configListAllRecentWebhookDeliveries
+summary: Get recent webhook deliveries
+description: Get recent webhook deliveries
+tags:
+  - config
+parameters:
+  - name: webhookId
+    in: path
+    required: true
+    style: simple
+    schema:
+      type: string
+  - $ref: "../parameters/offset.yaml"
+  - $ref: "../parameters/limit.yaml"
+  - $ref: "../parameters/page.yaml"
+responses:
+  "200":
+    description: OK
+    content:
+      application/json:
+        schema:
+          required:
+            - webhookDeliveries
+            - pagination
+          type: object
+          properties:
+            webhookDeliveries:
+              type: array
+              items:
+                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
+            pagination:
+              $ref: "../definitions/Pagination.yaml"
+deprecated: false
+security:
+  - BearerAuth: []

openapi/v2023.8.2/paths/configListWebhooks.yaml

@@ -0,0 +1,34 @@
+operationId: configListWebhooks
+summary: Get all webhooks for an organisation
+description: Get all webhooks for an organisation
+tags:
+  - config
+responses:
+  "200":
+    description: OK
+    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
+deprecated: false
+security:
+  - BearerAuth: []

openapi/v2023.8.2/paths/configPingWebhook.yaml

@@ -0,0 +1,43 @@
+operationId: configPingWebhook
+summary: Ping webhook
+description: Ping webhook
+tags:
+  - config
+parameters:
+  - name: webhookId
+    in: path
+    required: true
+    style: simple
+    schema:
+      type: string
+responses:
+  "200":
+    description: OK
+    content:
+      application/json:
+        schema:
+          required:
+            - ResponseStatusCode
+            - ResponseStatusStr
+            - ExecutionStartTimeStamp
+            - ExecutionEndTimeStamp
+            - Status
+            - StatusDescription
+          type: object
+          properties:
+            ResponseStatusCode:
+              type: integer
+              format: int32
+            ResponseStatusStr:
+              type: string
+            ExecutionStartTimeStamp:
+              type: string
+            ExecutionEndTimeStamp:
+              type: string
+            Status:
+              type: string
+            StatusDescription:
+              type: string
+deprecated: false
+security:
+  - BearerAuth: []