Add Code Snippets to Spec Files

Author: DX-Bandwidth

site/specs/messaging-tfverify-athena.yml

@@ -302,25 +302,6 @@ components:
           $ref: '#/components/schemas/nullableString'
         webhookUrl:
           $ref: '#/components/schemas/webhookUrl'
-    tfvPostResponseBody:
-      type: object
-      properties:
-        accountId:
-          type: string
-          description: Bandwidth account ID
-          example: '9900910'
-        errors:
-          type: object
-          description: >-
-            Listing of errors from your request, relevant for a partial success
-            or complete failure
-          example:
-            type: bad request
-            description: cannot process request
-            errors:
-              useCase:
-                - useCase must not be blank
-                - useCase cannot be more than 500 characters
     tfvStatus:
       type: object
       properties:
@@ -371,6 +352,39 @@ components:
       required:
         - type
         - description
+    badRequestError:
+      title: BadRequestError
+      type: object
+      properties:
+        type:
+          type: string
+          example: bad request
+        description:
+          type: string
+          example: cannot process request
+        errors:
+          type: object
+          description: >-
+            Each key of this errors object refers to a field of the submitted
+            object (using dot notation for nested objects), with the field being
+            a key to an array of one or more errors for that field.
+          example:
+            name:
+              - is required
+            email:
+              - is not a valid email address
+              - is longer than 100 characters
+          additionalProperties:
+            type: array
+            items:
+              type: string
+              example: is required
+            example:
+              - is not a valid email address
+              - is longer than 100 characters
+      required:
+        - type
+        - description
     accountId:
       type: integer
       description: Your Bandwidth Account ID
@@ -428,10 +442,6 @@ components:
   responses:
     verifyPostResponse:
       description: Accepted
-      content:
-        application/json:
-          schema:
-            $ref: '#/components/schemas/tfvPostResponseBody'
     verifyStatusResponse:
       description: OK
       content:
@@ -449,7 +459,7 @@ components:
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/verificationRequestError'
+            $ref: '#/components/schemas/badRequestError'
     unauthorizedResponse:
       description: Unauthorized
       content:

site/specs/voice.yml

@@ -6364,7 +6364,7 @@ components:
           $ref: '#/components/schemas/tag'
         status:
           $ref: '#/components/schemas/status'
-    disconenctCallback:
+    disconnectCallback:
       type: object
       description: The Disconnect event is fired when a call ends, for any reason.
       properties: