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

Commit

Permalink
Add Code Snippets to Spec Files
Browse files Browse the repository at this point in the history
  • Loading branch information
DX-Bandwidth committed Feb 22, 2023
1 parent 18fcc22 commit 9a3463c
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 25 deletions.
58 changes: 34 additions & 24 deletions site/specs/messaging-tfverify-athena.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -428,10 +442,6 @@ components:
responses:
verifyPostResponse:
description: Accepted
content:
application/json:
schema:
$ref: '#/components/schemas/tfvPostResponseBody'
verifyStatusResponse:
description: OK
content:
Expand All @@ -449,7 +459,7 @@ components:
content:
application/json:
schema:
$ref: '#/components/schemas/verificationRequestError'
$ref: '#/components/schemas/badRequestError'
unauthorizedResponse:
description: Unauthorized
content:
Expand Down
2 changes: 1 addition & 1 deletion site/specs/voice.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 9a3463c

Please sign in to comment.