From a46efaa11277351abd78fe87574b9934711ebbc6 Mon Sep 17 00:00:00 2001 From: DX-Bandwidth Date: Thu, 12 Oct 2023 20:50:28 +0000 Subject: [PATCH] Add Code Snippets to Spec Files --- site/specs/ai-bridge.yml | 101 ++++++++++++--------------------------- 1 file changed, 30 insertions(+), 71 deletions(-) diff --git a/site/specs/ai-bridge.yml b/site/specs/ai-bridge.yml index e168fc250..dd6418a93 100644 --- a/site/specs/ai-bridge.yml +++ b/site/specs/ai-bridge.yml @@ -893,7 +893,6 @@ components: $ref: '#/components/examples/googleEsProviderExample' required: - displayName - - description - type - googleProvider googleCxProviderRequestData: @@ -922,7 +921,6 @@ components: $ref: '#/components/examples/googleCxProviderExample' required: - displayName - - description - type - googleProvider botRequestData: @@ -960,7 +958,6 @@ components: required: - provider - displayName - - description - botFailover - sipHeadersToBot - dtmfCollect @@ -990,7 +987,6 @@ components: $ref: '#/components/schemas/awsProvider' required: - displayName - - description - type - awsProvider example: @@ -1017,7 +1013,6 @@ components: $ref: '#/components/schemas/cognigyProvider' required: - displayName - - description - type - role - cognigyProvider @@ -1258,12 +1253,6 @@ components: $ref: '#/components/examples/roleExample' googleProvider: $ref: '#/components/schemas/googleEsProvider' - required: - - displayName - - description - - type - - role - - googleProvider updateGoogleCxProvider: type: object properties: @@ -1282,12 +1271,6 @@ components: $ref: '#/components/examples/roleExample' googleProvider: $ref: '#/components/schemas/googleEsProvider' - required: - - displayName - - description - - type - - role - - googleProvider updateBot: type: object properties: @@ -1334,12 +1317,6 @@ components: $ref: '#/components/examples/roleExample' awsProvider: $ref: '#/components/schemas/awsProvider' - required: - - displayName - - description - - type - - role - - awsProvider updateCognigyProvider: type: object properties: @@ -1356,12 +1333,6 @@ components: $ref: '#/components/examples/roleExample' cognigyProvider: $ref: '#/components/schemas/cognigyProvider' - required: - - displayName - - description - - type - - role - - cognigyProvider id: required: - id @@ -1521,11 +1492,6 @@ components: description: Defines a provider to function as a bot integration example: bot googleEsProvider: - required: - - region - - location - - environment - - projectId description: Google Provider is required properties: region: @@ -1538,6 +1504,11 @@ components: $ref: '#/components/schemas/projectId' googleCredentials: $ref: '#/components/schemas/googleProviderCredentials' + required: + - region + - location + - environment + - projectId googleCxProvider: required: - region @@ -1600,39 +1571,29 @@ components: googleCredentials: $ref: '#/components/schemas/googleProviderCredentials' googleSpeechToTextBot: - required: - - provider - - language description: Google Bot is required properties: provider: $ref: '#/components/schemas/provider' - language: - $ref: '#/components/schemas/language' - googleTextToSpeechBot: required: - provider - - language + googleTextToSpeechBot: description: Google Bot is required properties: provider: $ref: '#/components/schemas/provider' - language: - $ref: '#/components/schemas/language' - awsSpeechToTextBot: required: - provider - description: Google Bot is required + awsSpeechToTextBot: + description: Aws Bot is required properties: provider: $ref: '#/components/schemas/provider' - language: - $ref: '#/components/schemas/language' + required: + - provider awsTextToSpeechBot: required: - provider - - voiceName - - language description: Google Bot is required properties: provider: @@ -1918,11 +1879,11 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5422cacd3f0f - language: en-US ttsProvider: provider: provider: a6dj3d72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US - id: b64b5e72-a850-4f38-98d4-5022cacd3f0r displayName: Bot provider: @@ -1933,15 +1894,14 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - language: en-US ttsProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US errors: null googleEsProviderExample: summary: An example of a Google-ES provider value: - name: googleProvider displayName: Google Provider type: GOOGLE_ES description: Google provider description @@ -1960,7 +1920,6 @@ components: googleCxProviderExample: summary: An example of a Google-CX provider value: - name: googleProvider displayName: Google Provider type: GOOGLE_CX description: Google provider description @@ -1989,10 +1948,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - language: en-US ttsProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US googleBotExample: summary: An example of a Google bot value: @@ -2005,10 +1964,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5422cacd3f0f - language: en-US ttsProvider: provider: a6dj3d72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US googleBotResponseExample: summary: An example of a Google bot value: @@ -2021,10 +1980,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5422cacd3f0f - language: en-US ttsProvider: provider: a6dj3d72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US googleEsProviderGetResponseExample: summary: An example of a Google-ES provider get response value: @@ -2124,10 +2083,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - language: en-US ttsProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + language: en-US + voiceName: Jill errors: [] googleEsProviderPostResponseExample: summary: An example of a Google-ES provider post response @@ -2200,10 +2159,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - language: en-US ttsProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US errors: [] googleEsProviderPutResponseExample: summary: An example of a provider put response @@ -2353,10 +2312,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5422cacd3f0f - language: en-US ttsProvider: provider: a6dj3d72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US awsProviderGetResponseExample: summary: An example of an AWS provider get response value: @@ -2739,10 +2698,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5422cacd3f0f - language: en-US ttsProvider: provider: a6dj3d72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US - id: b64b5e72-a850-4f38-98d4-5022cacd3f0r displayName: Bot provider: @@ -2753,10 +2712,10 @@ components: transferTarget: tel:+19195554321 sttProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - language: en-US ttsProvider: provider: a6dj3e72-a850-4f38-98d4-5022cacd3f0f - voiceName: Jill + voiceName: Jill + language: en-US roleExample: summary: >- An array of roles that say what function(s) an AIBridge Integration can