chore: Fix Slack notification API docs (#3485)

theopensystemslab · Aug 1, 2024 · 15962de · 15962de
1 parent 04be3f4
commit 15962de
Showing 1 changed file with 31 additions and 40 deletions.
diff --git a/api.planx.uk/modules/webhooks/docs.yaml b/api.planx.uk/modules/webhooks/docs.yaml
@@ -17,26 +17,23 @@ components:
     BopsSubmission:
       type: object
       properties:
-        body:
+        event:
           type: object
           properties:
-            event:
+            data:
               type: object
               properties:
-                data:
+                new:
                   type: object
                   properties:
-                    new:
-                      type: object
-                      properties:
-                        session_id:
-                          type: string
-                        bops_id:
-                          type: string
-                        destination_url:
-                          type: string
+                    session_id:
+                      type: string
+                    bops_id:
+                      type: string
+                    destination_url:
+                      type: string
       required:
-        - body
+        - event
     UniformSubmission:
       type: object
       properties:
@@ -66,53 +63,47 @@ components:
     EmailSubmission:
       type: object
       properties:
-        body:
+        event:
           type: object
           properties:
-            event:
+            data:
               type: object
               properties:
-                data:
+                new:
                   type: object
                   properties:
-                    new:
+                    session_id:
+                      type: string
+                    team_slug:
+                      type: string
+                    request:
                       type: object
                       properties:
-                        session_id:
-                          type: string
-                        team_slug:
-                          type: string
-                        request:
+                        personalisation:
                           type: object
                           properties:
-                            personalisation:
-                              type: object
-                              properties:
-                                serviceName:
-                                  type: string
+                            serviceName:
+                              type: string
       required:
-        - body
+        - event
     S3Submission:
       type: object
       properties:
-        body:
+        event:
           type: object
           properties:
-            event:
+            data:
               type: object
               properties:
-                data:
+                new:
                   type: object
                   properties:
-                    new:
-                      type: object
-                      properties:
-                        session_id:
-                          type: string
-                        team_slug:
-                          type: string
+                    session_id:
+                      type: string
+                    team_slug:
+                      type: string
       required:
-        - body
+        - event
     SendSlackNotification:
       oneOf:
         - $ref: "#/components/schemas/BopsSubmission"
@@ -253,7 +244,7 @@ components:
                 type: string
                 description: A message returned to the client
 paths:
-  /webhooks/hasura/sendSlackNotification:
+  /webhooks/hasura/send-slack-notification:
     post:
       tags: ["webhooks"]
       security: