DX-2779 (#693)

* Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files * Add Code Snippets to Spec Files
Bandwidth · Sep 2, 2022 · e899047 · e899047
1 parent df1404c
commit e899047
Show file tree

Hide file tree

Showing 2 changed files with 115 additions and 38 deletions.
diff --git a/site/specs/messaging.yml b/site/specs/messaging.yml
@@ -1466,7 +1466,7 @@ components:
       description: >-
         The start of the date range to search in ISO 8601 format. Uses the
         message receive time. The date range to search in is currently 14 days.
-      example: 2016-09-14T18:20:16.000Z
+      example: 2022-09-14T18:20:16.000Z
       schema:
         type: string
     toDateTime:
@@ -1476,7 +1476,7 @@ components:
       description: >-
         The end of the date range to search in ISO 8601 format. Uses the message
         receive time. The date range to search in is currently 14 days.
-      example: 2016-09-14T18:20:16.000Z
+      example: 2022-09-14T18:20:16.000Z
       schema:
         type: string
     sort:
@@ -1616,6 +1616,7 @@ components:
           example: 2020-04-07T14:03:07.000Z
         carrierName:
           type: string
+          nullable: true
           description: >-
             The name of the carrier. Not currently supported for MMS coming
             soon.
@@ -1737,7 +1738,7 @@ components:
         time:
           type: string
           description: The datetime stamp of the message in ISO 8601
-          example: 2016-09-14T18:20:16.000Z
+          example: 2022-09-14T18:20:16.000Z
         segmentCount:
           type: integer
           description: >-

diff --git a/site/specs/voice.yml b/site/specs/voice.yml
@@ -5009,18 +5009,6 @@ components:
         complete
 
         and will include its result.
-    username:
-      type: string
-      nullable: true
-      description: Basic auth username.
-      maxLength: 1024
-      example: mySecretUsername
-    password:
-      type: string
-      nullable: true
-      description: Basic auth password.
-      maxLength: 1024
-      example: mySecretPassword1!
     createCall:
       type: object
       required:
@@ -5089,9 +5077,17 @@ components:
         answerMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         username:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         password:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         answerFallbackUrl:
           nullable: true
           type: string
@@ -5109,9 +5105,17 @@ components:
         answerFallbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         fallbackUsername:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         fallbackPassword:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         disconnectUrl:
           nullable: true
           type: string
@@ -5284,13 +5288,29 @@ components:
           example: https://myServer.com/bandwidth/webhooks/disconnect
           description: URL to deliver the `disconnect` event webhook.
         username:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         password:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         fallbackUsername:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         fallbackPassword:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         priority:
           nullable: true
           type: number
@@ -5508,9 +5528,17 @@ components:
         redirectMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         username:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         password:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         redirectFallbackUrl:
           nullable: true
           type: string
@@ -5522,9 +5550,17 @@ components:
         redirectFallbackMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         fallbackUsername:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         fallbackPassword:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         tag:
           nullable: true
           type: string
@@ -5673,9 +5709,17 @@ components:
         redirectMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         username:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         password:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         redirectFallbackUrl:
           nullable: true
           type: string
@@ -5691,9 +5735,17 @@ components:
         redirectFallbackMethod:
           $ref: '#/components/schemas/redirectMethodEnum'
         fallbackUsername:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         fallbackPassword:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
     conferenceMember:
       type: object
       properties:
@@ -5926,9 +5978,17 @@ components:
         callbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         username:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         password:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         fallbackUrl:
           nullable: true
           type: string
@@ -5946,9 +6006,17 @@ components:
         fallbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         fallbackUsername:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         fallbackPassword:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
     transcribeRecording:
       type: object
       properties:
@@ -5970,9 +6038,17 @@ components:
         callbackMethod:
           $ref: '#/components/schemas/callbackMethodEnum'
         username:
-          $ref: '#/components/schemas/username'
+          type: string
+          nullable: true
+          description: Basic auth username.
+          maxLength: 1024
+          example: mySecretUsername
         password:
-          $ref: '#/components/schemas/password'
+          type: string
+          nullable: true
+          description: Basic auth password.
+          maxLength: 1024
+          example: mySecretPassword1!
         tag:
           $ref: '#/components/schemas/tag'
         callbackTimeout:
@@ -7068,7 +7144,7 @@ components:
         originatingId:
           type: string
           description: (optional) A unique origination identifier.
-          example: null
+          example: 99759086-1335-11ed-9bcf-5f7d464e91af
   parameters:
     accountId:
       name: accountId