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

Commit d54e44b

Browse files
committed
Add Code Snippets to Spec Files
1 parent 430a4d3 commit d54e44b

File tree

1 file changed

+55
-63
lines changed

1 file changed

+55
-63
lines changed

site/specs/numbers.yml

Lines changed: 55 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1042,46 +1042,6 @@ components:
10421042
- $ref: '#/components/schemas/failureWebhookRequest'
10431043
description: Verification callback status of a toll-free phone number.
10441044
required: true
1045-
webhookSubscription:
1046-
content:
1047-
application/json:
1048-
schema:
1049-
properties:
1050-
accountId:
1051-
type: string
1052-
basicAuthentication:
1053-
properties:
1054-
password:
1055-
maxLength: 200
1056-
type: string
1057-
username:
1058-
maxLength: 100
1059-
type: string
1060-
required:
1061-
- username
1062-
- password
1063-
type: object
1064-
callbackUrl:
1065-
$ref: '#/components/schemas/webhookUrl'
1066-
createdDate:
1067-
format: date-time
1068-
type: string
1069-
id:
1070-
type: string
1071-
modifiedDate:
1072-
format: date-time
1073-
type: string
1074-
type:
1075-
enum:
1076-
- TOLLFREE_VERIFICATION_STATUS
1077-
type: string
1078-
required:
1079-
- callbackUrl
1080-
type: object
1081-
description: >-
1082-
Information about a webhook that Bandwidth should send upon the
1083-
completion of TFV verification.
1084-
required: true
10851045
webhookSubscriptionRequest:
10861046
content:
10871047
application/json:
@@ -1108,20 +1068,6 @@ components:
11081068
Information about a webhook that Bandwidth should send upon the
11091069
completion of TFV verification.
11101070
required: true
1111-
webhookSubscriptionsList:
1112-
content:
1113-
application/json:
1114-
schema:
1115-
properties:
1116-
data:
1117-
items:
1118-
$ref: '#/components/requestBodies/webhookSubscription'
1119-
type: array
1120-
type: object
1121-
description: >-
1122-
A list of all webhook subscriptions registered for this account ID for
1123-
this particular feature.
1124-
required: true
11251071
zipWhipTfvWebhookRequest:
11261072
content:
11271073
application/json:
@@ -1390,21 +1336,21 @@ components:
13901336
content:
13911337
application/json:
13921338
schema:
1393-
$ref: '#/components/requestBodies/webhookSubscription'
1339+
$ref: '#/components/schemas/webhookSubscription'
13941340
description: Created
13951341
webhookSubscriptionDeleted:
13961342
description: Deleted
13971343
webhookSubscriptionUpdated:
13981344
content:
13991345
application/json:
14001346
schema:
1401-
$ref: '#/components/requestBodies/webhookSubscription'
1347+
$ref: '#/components/schemas/webhookSubscription'
14021348
description: OK
14031349
webhookSubscriptionsList:
14041350
content:
14051351
application/json:
14061352
schema:
1407-
$ref: '#/components/requestBodies/webhookSubscriptionsList'
1353+
$ref: '#/components/schemas/webhookSubscriptionsListBody'
14081354
description: OK
14091355
schemas:
14101356
A2pClass:
@@ -14409,14 +14355,60 @@ components:
1440914355
status:
1441014356
$ref: '#/components/schemas/tfvCallbackStatus'
1441114357
type: object
14358+
webhookSubscription:
14359+
description: >-
14360+
Information about a webhook that Bandwidth should send upon the
14361+
completion of TFV verification.
14362+
properties:
14363+
accountId:
14364+
type: string
14365+
basicAuthentication:
14366+
properties:
14367+
password:
14368+
maxLength: 200
14369+
type: string
14370+
username:
14371+
maxLength: 100
14372+
type: string
14373+
required:
14374+
- username
14375+
- password
14376+
type: object
14377+
callbackUrl:
14378+
$ref: '#/components/schemas/webhookUrl'
14379+
createdDate:
14380+
format: date-time
14381+
type: string
14382+
id:
14383+
type: string
14384+
modifiedDate:
14385+
format: date-time
14386+
type: string
14387+
type:
14388+
enum:
14389+
- TOLLFREE_VERIFICATION_STATUS
14390+
type: string
14391+
required:
14392+
- callbackUrl
14393+
type: object
14394+
webhookSubscriptionsListBody:
14395+
description: >-
14396+
A list of all webhook subscriptions registered for this account ID for
14397+
this particular feature.
14398+
properties:
14399+
data:
14400+
items:
14401+
$ref: '#/components/schemas/webhookSubscription'
14402+
type: array
14403+
required:
14404+
- data
14405+
type: object
1441214406
webhookUrl:
1441314407
description: >-
14414-
Callback URL to receive status updates from Bandwidth. When this value
14415-
is registered with a validation request, it will be used for that
14416-
request (only) and it cannot be updated after submission. To register a
14417-
callback for all status updates, which can be updated through the API,
14418-
register a webhook subscription (which can also include basic
14419-
authentication credentials).
14408+
Callback URL to receive status updates from Bandwidth. When a webhook
14409+
subscription is registered with Bandwidth under a given account ID, it
14410+
will be used to send status updates for all requests submitted under
14411+
that account ID.
1442014412
example: https://www.example.com/path/to/resource
1442114413
maxLength: 2000
1442214414
minLength: 0

0 commit comments

Comments
 (0)