Merge pull request #54 from firefinancialservices/SmallFixes

Small fixes

src/fire-business-api-v1.yaml

@@ -75,6 +75,7 @@ paths:
   /v2/webhooks: 
     $ref: ./v2/paths/apps/webhook-events.yaml
 
+
   /v2/batches/{batchUuid}/newpayees:
     $ref: ./v2/paths/batches/newpayees-batch.yaml  
 
@@ -372,6 +373,10 @@ components:
       $ref: 'v1/schemas/bank-pay-refund-request.yaml'
     BankPayRefundResponse: 
       $ref: 'v1/schemas/bank-pay-refund-response.yaml'
+    Events: 
+      $ref: 'v2/schemas/events.yaml'
+    WebhookEvents:
+      $ref: 'v2/schemas/webhookEvents.yaml'
 
 security:
   - bearerAuth: []

src/v2/paths/apps/webhook-events.yaml

@@ -6,10 +6,10 @@ get:
   operationId: getWebhookEvents
   responses:
         '200':
-          description: An array of webhook objects
+          description: An object of information about your webhooks
           content:
             application/json:
               schema:
-                $ref: '../../schemas/webhookEvents.yaml'
+                $ref: '../../schemas/listAllWebhooks.yaml'
         '401':
           $ref: '../../responses/unauthorised-error.yaml'

src/v2/schemas/events.yaml

@@ -0,0 +1,17 @@
+title: events
+type: array
+items:
+  type: string
+  enum: 
+    - LODGEMENT_RECEIVED
+    - PAYMENT_RECEIVED
+    - PAYMENT_REQUEST_PAYMENT_RECEIVED
+    - ACCOUNT_CREATED
+    - CARD_CREATED
+    - CARD_AUTHORISATION
+    - CARD_SETTLEMENT
+    - PAYMENT_REQUEST_PAYMENT_AUTHORISED
+    - PIS_LODGEMENT_RECEIVE
+  example: CARD_AUTHORISATION
+
+

src/v2/schemas/listAllWebhooks.yaml

@@ -0,0 +1,5 @@
+title: listAllWebhooks
+type: object
+properties:
+  webhookEvents: 
+    $ref: '#/components/schemas/WebhookEvents'

src/v2/schemas/webhookEvent.yaml

@@ -4,10 +4,7 @@ properties:
   webhook: 
     $ref: '#/components/schemas/Webhook'
   events:
-    type: array
-    items:
-      type: string
-      example: "LODGEMENT_RECIEVED"
+    $ref: '#/components/schemas/Events'
 
 
 

src/v2/schemas/webhookEvents.yaml

@@ -1,4 +1,4 @@
 Title: webhookEvents
 Type: array
 items:
-  - $ref: '#/components/schemas/WebhookEvent'
+  $ref: '#/components/schemas/WebhookEvent'

src/webhooks/Webhooks.yaml

@@ -1,4 +1,5 @@
 post:
+  title: Sample webhook response
   description: Webhooks allow you to be notified of events as they happen on your Fire accounts. The below sample response shows how a webhook from Fire will arrive at your server. See our 'API and webhooks' guide for more detailed information.
   requestBody:
     required: true