Skip to content
This repository was archived by the owner on Nov 29, 2023. It is now read-only.

Commit e899047

Browse files
DX-BandwidthDX-Bandwidth
authored
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
1 parent df1404c commit e899047

File tree

2 files changed

+115
-38
lines changed

2 files changed

+115
-38
lines changed

‎site/specs/messaging.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1466,7 +1466,7 @@ components:
14661466
description: >-
14671467
The start of the date range to search in ISO 8601 format. Uses the
14681468
message receive time. The date range to search in is currently 14 days.
1469-
example: 2016-09-14T18:20:16.000Z
1469+
example: 2022-09-14T18:20:16.000Z
14701470
schema:
14711471
type: string
14721472
toDateTime:
@@ -1476,7 +1476,7 @@ components:
14761476
description: >-
14771477
The end of the date range to search in ISO 8601 format. Uses the message
14781478
receive time. The date range to search in is currently 14 days.
1479-
example: 2016-09-14T18:20:16.000Z
1479+
example: 2022-09-14T18:20:16.000Z
14801480
schema:
14811481
type: string
14821482
sort:
@@ -1616,6 +1616,7 @@ components:
16161616
example: 2020-04-07T14:03:07.000Z
16171617
carrierName:
16181618
type: string
1619+
nullable: true
16191620
description: >-
16201621
The name of the carrier. Not currently supported for MMS coming
16211622
soon.
@@ -1737,7 +1738,7 @@ components:
17371738
time:
17381739
type: string
17391740
description: The datetime stamp of the message in ISO 8601
1740-
example: 2016-09-14T18:20:16.000Z
1741+
example: 2022-09-14T18:20:16.000Z
17411742
segmentCount:
17421743
type: integer
17431744
description: >-

‎site/specs/voice.yml

Lines changed: 111 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -5009,18 +5009,6 @@ components:
50095009
complete
50105010
50115011
and will include its result.
5012-
username:
5013-
type: string
5014-
nullable: true
5015-
description: Basic auth username.
5016-
maxLength: 1024
5017-
example: mySecretUsername
5018-
password:
5019-
type: string
5020-
nullable: true
5021-
description: Basic auth password.
5022-
maxLength: 1024
5023-
example: mySecretPassword1!
50245012
createCall:
50255013
type: object
50265014
required:
@@ -5089,9 +5077,17 @@ components:
50895077
answerMethod:
50905078
$ref: '#/components/schemas/callbackMethodEnum'
50915079
username:
5092-
$ref: '#/components/schemas/username'
5080+
type: string
5081+
nullable: true
5082+
description: Basic auth username.
5083+
maxLength: 1024
5084+
example: mySecretUsername
50935085
password:
5094-
$ref: '#/components/schemas/password'
5086+
type: string
5087+
nullable: true
5088+
description: Basic auth password.
5089+
maxLength: 1024
5090+
example: mySecretPassword1!
50955091
answerFallbackUrl:
50965092
nullable: true
50975093
type: string
@@ -5109,9 +5105,17 @@ components:
51095105
answerFallbackMethod:
51105106
$ref: '#/components/schemas/callbackMethodEnum'
51115107
fallbackUsername:
5112-
$ref: '#/components/schemas/username'
5108+
type: string
5109+
nullable: true
5110+
description: Basic auth username.
5111+
maxLength: 1024
5112+
example: mySecretUsername
51135113
fallbackPassword:
5114-
$ref: '#/components/schemas/password'
5114+
type: string
5115+
nullable: true
5116+
description: Basic auth password.
5117+
maxLength: 1024
5118+
example: mySecretPassword1!
51155119
disconnectUrl:
51165120
nullable: true
51175121
type: string
@@ -5284,13 +5288,29 @@ components:
52845288
example: https://myServer.com/bandwidth/webhooks/disconnect
52855289
description: URL to deliver the `disconnect` event webhook.
52865290
username:
5287-
$ref: '#/components/schemas/username'
5291+
type: string
5292+
nullable: true
5293+
description: Basic auth username.
5294+
maxLength: 1024
5295+
example: mySecretUsername
52885296
password:
5289-
$ref: '#/components/schemas/password'
5297+
type: string
5298+
nullable: true
5299+
description: Basic auth password.
5300+
maxLength: 1024
5301+
example: mySecretPassword1!
52905302
fallbackUsername:
5291-
$ref: '#/components/schemas/username'
5303+
type: string
5304+
nullable: true
5305+
description: Basic auth username.
5306+
maxLength: 1024
5307+
example: mySecretUsername
52925308
fallbackPassword:
5293-
$ref: '#/components/schemas/password'
5309+
type: string
5310+
nullable: true
5311+
description: Basic auth password.
5312+
maxLength: 1024
5313+
example: mySecretPassword1!
52945314
priority:
52955315
nullable: true
52965316
type: number
@@ -5508,9 +5528,17 @@ components:
55085528
redirectMethod:
55095529
$ref: '#/components/schemas/redirectMethodEnum'
55105530
username:
5511-
$ref: '#/components/schemas/username'
5531+
type: string
5532+
nullable: true
5533+
description: Basic auth username.
5534+
maxLength: 1024
5535+
example: mySecretUsername
55125536
password:
5513-
$ref: '#/components/schemas/password'
5537+
type: string
5538+
nullable: true
5539+
description: Basic auth password.
5540+
maxLength: 1024
5541+
example: mySecretPassword1!
55145542
redirectFallbackUrl:
55155543
nullable: true
55165544
type: string
@@ -5522,9 +5550,17 @@ components:
55225550
redirectFallbackMethod:
55235551
$ref: '#/components/schemas/redirectMethodEnum'
55245552
fallbackUsername:
5525-
$ref: '#/components/schemas/username'
5553+
type: string
5554+
nullable: true
5555+
description: Basic auth username.
5556+
maxLength: 1024
5557+
example: mySecretUsername
55265558
fallbackPassword:
5527-
$ref: '#/components/schemas/password'
5559+
type: string
5560+
nullable: true
5561+
description: Basic auth password.
5562+
maxLength: 1024
5563+
example: mySecretPassword1!
55285564
tag:
55295565
nullable: true
55305566
type: string
@@ -5673,9 +5709,17 @@ components:
56735709
redirectMethod:
56745710
$ref: '#/components/schemas/redirectMethodEnum'
56755711
username:
5676-
$ref: '#/components/schemas/username'
5712+
type: string
5713+
nullable: true
5714+
description: Basic auth username.
5715+
maxLength: 1024
5716+
example: mySecretUsername
56775717
password:
5678-
$ref: '#/components/schemas/password'
5718+
type: string
5719+
nullable: true
5720+
description: Basic auth password.
5721+
maxLength: 1024
5722+
example: mySecretPassword1!
56795723
redirectFallbackUrl:
56805724
nullable: true
56815725
type: string
@@ -5691,9 +5735,17 @@ components:
56915735
redirectFallbackMethod:
56925736
$ref: '#/components/schemas/redirectMethodEnum'
56935737
fallbackUsername:
5694-
$ref: '#/components/schemas/username'
5738+
type: string
5739+
nullable: true
5740+
description: Basic auth username.
5741+
maxLength: 1024
5742+
example: mySecretUsername
56955743
fallbackPassword:
5696-
$ref: '#/components/schemas/password'
5744+
type: string
5745+
nullable: true
5746+
description: Basic auth password.
5747+
maxLength: 1024
5748+
example: mySecretPassword1!
56975749
conferenceMember:
56985750
type: object
56995751
properties:
@@ -5926,9 +5978,17 @@ components:
59265978
callbackMethod:
59275979
$ref: '#/components/schemas/callbackMethodEnum'
59285980
username:
5929-
$ref: '#/components/schemas/username'
5981+
type: string
5982+
nullable: true
5983+
description: Basic auth username.
5984+
maxLength: 1024
5985+
example: mySecretUsername
59305986
password:
5931-
$ref: '#/components/schemas/password'
5987+
type: string
5988+
nullable: true
5989+
description: Basic auth password.
5990+
maxLength: 1024
5991+
example: mySecretPassword1!
59325992
fallbackUrl:
59335993
nullable: true
59345994
type: string
@@ -5946,9 +6006,17 @@ components:
59466006
fallbackMethod:
59476007
$ref: '#/components/schemas/callbackMethodEnum'
59486008
fallbackUsername:
5949-
$ref: '#/components/schemas/username'
6009+
type: string
6010+
nullable: true
6011+
description: Basic auth username.
6012+
maxLength: 1024
6013+
example: mySecretUsername
59506014
fallbackPassword:
5951-
$ref: '#/components/schemas/password'
6015+
type: string
6016+
nullable: true
6017+
description: Basic auth password.
6018+
maxLength: 1024
6019+
example: mySecretPassword1!
59526020
transcribeRecording:
59536021
type: object
59546022
properties:
@@ -5970,9 +6038,17 @@ components:
59706038
callbackMethod:
59716039
$ref: '#/components/schemas/callbackMethodEnum'
59726040
username:
5973-
$ref: '#/components/schemas/username'
6041+
type: string
6042+
nullable: true
6043+
description: Basic auth username.
6044+
maxLength: 1024
6045+
example: mySecretUsername
59746046
password:
5975-
$ref: '#/components/schemas/password'
6047+
type: string
6048+
nullable: true
6049+
description: Basic auth password.
6050+
maxLength: 1024
6051+
example: mySecretPassword1!
59766052
tag:
59776053
$ref: '#/components/schemas/tag'
59786054
callbackTimeout:
@@ -7068,7 +7144,7 @@ components:
70687144
originatingId:
70697145
type: string
70707146
description: (optional) A unique origination identifier.
7071-
example: null
7147+
example: 99759086-1335-11ed-9bcf-5f7d464e91af
70727148
parameters:
70737149
accountId:
70747150
name: accountId

0 commit comments

Comments
 (0)