Style updates, typo updates, added consitency with naming (#18)

Author: ShreyaThapa

README.md

@@ -5,7 +5,8 @@ An OpenAPI specification for the Dwolla API. https://developers.dwolla.com
 ## Mock Server With Prism
 
 Dwolla uses this OpenAPI spec to spin up a local mock server and test request and responses. Dwolla
-uses [Prism](https://stoplight.io/open-source/prism) from [Stoplight](https://stoplight.io/) to spin up the mock server.
+uses [Prism](https://stoplight.io/open-source/prism) from [Stoplight](https://stoplight.io/) to spin
+up the mock server.
 
 Follow these steps to spin up your own Dwolla mock server with Prism:
 

specs/resources/accounts/listAccountMassPayments.yml

@@ -77,4 +77,4 @@ get:
                 example: notFound
               message:
                 type: string
-                example: Account not found.
+                example: Account not found.

specs/resources/accounts/listAndSearchAccountTransfers.yml

@@ -1,8 +1,8 @@
 get:
   tags:
     - account
-  summary: List and search transers for an account
-  description: List and search transers for an account
+  summary: List and search transfers for an account
+  description: List and search transfers for an account
   operationId: listAndSearchAccountTransfers
   parameters:
     - name: id

specs/resources/accounts/retrieveAccount.yml

@@ -39,4 +39,4 @@ get:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/common.yml#/components/schemas/NotFoundError'
+            $ref: '../../schemas/common.yml#/components/schemas/NotFoundError'

specs/resources/customers/retrieveBusinessClassification.yml

@@ -32,4 +32,4 @@ get:
                 example: not_found
               message:
                 type: string
-                example: not found.
+                example: not found.

specs/resources/documents/createListCustomerDocument.yml

@@ -68,7 +68,7 @@ post:
         application/vnd.dwolla.v1.hal+json:
           schema:
             oneOf:
-              - $ref: '../../schemas/common.yml#/components/schemas/InvalidResourceState'
+              - $ref: '../../schemas/common.yml#/components/schemas/InvalidResourceStateSchema'
               - $ref: '../../schemas/common.yml#/components/schemas/NotAuthorizedSchema'
     '404':
       description: not found

specs/resources/documents/retrieveDocument.yml

@@ -18,4 +18,4 @@ get:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/documents/Document.yml#/Document'
+            $ref: '../../schemas/documents/Document.yml#/Document'

specs/resources/events/listEvents.yml

@@ -23,7 +23,6 @@ get:
         application/vnd.dwolla.v1.hal+json:
           schema:
             $ref: '../../schemas/events/Events.yml#/Events'
-            
     '404':
       description: not found
       headers: {}

specs/resources/exchanges/listCreateExchangeForAccount.yml

@@ -56,4 +56,4 @@ post:
                 example: InvalidExchange
               message:
                 type: string
-                example: The exchange is no longer active.
+                example: The exchange is no longer active.

specs/resources/exchanges/listCreateExchangeForCustomer.yml

@@ -98,4 +98,4 @@ post:
                 example: NotFound
               message:
                 type: string
-                example: The requested resource was not found.
+                example: The requested resource was not found.

specs/resources/funding-sources/createListCustomerFundingSources.yml

@@ -100,4 +100,3 @@ post:
             oneOf:
               - $ref: '../../schemas/funding-sources/CreateCustomerFundingSource.yml#/NotAuthorizedToCreateFundingSourceError'
               - $ref: '../../schemas/funding-sources/CreateCustomerFundingSource.yml#/VANSNotEnabledError'
-    

specs/resources/funding-sources/retrieveInitiateVerifyMicroDeposit.yml

@@ -26,6 +26,7 @@ get:
                   $ref: '../../schemas/common.yml#/components/schemas/HalLink'
               created:
                 type: string
+                format: date-time
                 example: '2022-12-30T20:56:53.000Z'
               status:
                 type: string
@@ -55,7 +56,7 @@ post:
   parameters:
     - name: id
       in: path
-      description: The ID of the FS to initiate or veriify micro-deposit
+      description: The ID of the FS to initiate or verify micro-deposit
       required: true
       schema:
         type: string
@@ -86,4 +87,4 @@ post:
                 example: notFound
               message:
                 type: string
-                example: Funding source not found
+                example: Funding source not found

specs/resources/funding-sources/retrieveUpdateRemoveFundingSource.yml

@@ -90,4 +90,4 @@ post:
                 example: InvalidResourceState
               message:
                 type: string
-                example: A removed bank cannot be updated.
+                example: A removed bank cannot be updated.

specs/resources/kba/initiateKba.yml

@@ -31,5 +31,5 @@ post:
         application/vnd.dwolla.v1.hal+json:
           schema:
             oneOf:
-              - $ref: '../../schemas/common.yml#/components/schemas/InvalidResourceState'
-              - $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError'
+              - $ref: '../../schemas/common.yml#/components/schemas/InvalidResourceStateSchema'
+              - $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError'

specs/resources/kba/verifyRetrieveKba.yml

@@ -161,4 +161,7 @@ post:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError'
+            oneOf:
+              - $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError'
+              - $ref: '../../schemas/kba/VerifyKba.yml#/InvalidKbaSessionError'
+              - $ref: '../../schemas/kba/VerifyKba.yml#/ExpiredKbaSessionError'

specs/resources/labels/createListCustomerLabel.yml

@@ -67,4 +67,4 @@ post:
       description: create
       headers:
         Location:
-          $ref: '../../schemas/common.yml#/components/headers/Location'
+          $ref: '../../schemas/common.yml#/components/headers/Location'

specs/resources/labels/createlistLabelLedgerEntry.yml specs/resources/labels/createListLabelLedgerEntry.yml

@@ -65,4 +65,4 @@ post:
       description: created
       headers:
         Location:
-          $ref: '../../schemas/common.yml#/components/headers/Location'
+          $ref: '../../schemas/common.yml#/components/headers/Location'

specs/resources/labels/retrieveLabelLedgerEntry.yml

@@ -18,4 +18,4 @@ get:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/labels/LabelLedgerEntries.yml#/LabelLedgerEntries'
+            $ref: '../../schemas/labels/LabelLedgerEntry.yml#/LabelLedgerEntry'

specs/resources/labels/retrieveLabelReallocation.yml

@@ -61,4 +61,5 @@ get:
                         example: ledger-entry
               created:
                 type: string
-                example: 2022-05-16T13:41:31.036Z
+                format: date-time
+                example: '2022-05-16T13:41:31.036Z'

specs/resources/labels/retrieveRemoveLabel.yml

@@ -53,4 +53,4 @@ delete:
                 example: InvalidResourceState
               message:
                 type: string
-                example: Amount must be zero to remove label.
+                example: Amount must be zero to remove label.

specs/resources/mass-payments/listMassPaymentItems.yml

@@ -66,3 +66,7 @@ get:
                     type: array
                     items:
                       $ref: '../../schemas/mass-payments/MassPaymentItem.yml#/MassPaymentItem'
+              total:
+                type: integer
+                format: int32
+                example: 3

specs/resources/mass-payments/listMassPaymentsForCustomer.yml

@@ -36,4 +36,4 @@ get:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/webhook-subscriptions/WebhookSubscription.yml#/WebhookSubscription'
+            $ref: '../../schemas/mass-payments/MassPayments.yml#/MassPayments'

specs/resources/mass-payments/retrieveMassPaymentItem.yml

@@ -18,4 +18,4 @@ get:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/mass-payments/MassPaymentItem.yml#/MassPaymentItem'
+            $ref: '../../schemas/mass-payments/MassPaymentItem.yml#/MassPaymentItem'

specs/resources/mass-payments/retrieveUpdateMassPayment.yml

@@ -51,4 +51,4 @@ post:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/mass-payments/MassPayment.yml#/MassPayment'
+            $ref: '../../schemas/mass-payments/MassPayment.yml#/MassPayment'

specs/resources/root.yml

@@ -6,7 +6,7 @@ get:
   operationId: root
   responses:
     '200':
-      description: sucessful operation
+      description: successful operation
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:

specs/resources/transfers/createOnDemandTransferAuthorization.yml

@@ -18,4 +18,4 @@ post:
       content:
         application/vnd.dwolla.v1.hal+json:
           schema:
-            $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError'
+            $ref: '../../schemas/common.yml#/components/schemas/ForbiddenError'