Add Code Snippets to Spec Files

site/specs/ai-bridge.yml

@@ -465,7 +465,7 @@ components:
             googleEsProviderExample:
               $ref: '#/components/examples/googleEsProviderPatchResponseExample'
             googleCxProviderExample:
-              $ref: '#/components/examples/googleEsProviderPatchResponseExample'
+              $ref: '#/components/examples/googleCxProviderPatchResponseExample'
             awsProviderExample:
               $ref: '#/components/examples/awsProviderPatchResponseExample'
             cognigyProviderExample:
@@ -766,7 +766,7 @@ components:
         description:
           $ref: '#/components/schemas/description'
         type:
-          $ref: '#/components/schemas/googleEs'
+          $ref: '#/components/schemas/googleCx'
         displayName:
           $ref: '#/components/schemas/displayName'
         role:
@@ -791,8 +791,7 @@ components:
         id:
           $ref: '#/components/schemas/id'
         provider:
-          oneOf:
-            - $ref: '#/components/schemas/provider'
+          $ref: '#/components/schemas/provider'
         displayName:
           $ref: '#/components/schemas/displayName'
         description:
@@ -842,7 +841,7 @@ components:
           $ref: '#/components/schemas/awsProviderResponse'
       nullable: true
       example:
-        $ref: '#/components/examples/awsProviderExample'
+        $ref: '#/components/examples/awsProviderGetResponseExample'
     cognigyProviderResponseData:
       title: Cognigy Provider Response Data
       type: object
@@ -935,8 +934,6 @@ components:
           $ref: '#/components/schemas/displayName'
         description:
           $ref: '#/components/schemas/description'
-        botFailover:
-          $ref: '#/components/schemas/botFailover'
         transferTarget:
           $ref: '#/components/schemas/transferTarget'
         dtmfCollect:
@@ -990,7 +987,7 @@ components:
         - type
         - awsProvider
       example:
-        $ref: '#/components/examples/awsProviderExample'
+        $ref: '#/components/examples/awsProviderPostResponseExample'
     cognigyProviderRequestData:
       title: Cognigy Provider request Data
       type: object
@@ -1334,6 +1331,7 @@ components:
         cognigyProvider:
           $ref: '#/components/schemas/cognigyProvider'
     id:
+      type: string
       required:
         - id
       description: uuid
@@ -1533,6 +1531,8 @@ components:
     googleEsProviderResponse:
       description: Google Provider is required
       properties:
+        id:
+          $ref: '#/components/schemas/provider'
         region:
           $ref: '#/components/schemas/region'
         location:
@@ -1546,6 +1546,8 @@ components:
     googleCxProviderResponse:
       description: Google Provider is required
       properties:
+        id:
+          $ref: '#/components/schemas/provider'
         region:
           $ref: '#/components/schemas/region'
         location:
@@ -1559,76 +1561,71 @@ 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:
+          $ref: '#/components/schemas/voiceName'
       required:
         - provider
+        - voiceName
+    awsSpeechToTextBot:
       description: Google Bot is required
       properties:
         provider:
           $ref: '#/components/schemas/provider'
         language:
           $ref: '#/components/schemas/language'
-    awsTextToSpeechBot:
       required:
         - provider
-        - voiceName
-        - language
+    awsTextToSpeechBot:
       description: Google Bot is required
       properties:
         provider:
           $ref: '#/components/schemas/provider'
         voiceName:
           $ref: '#/components/schemas/voiceName'
-        language:
-          $ref: '#/components/schemas/language'
-        ttsEnhancedVoice:
-          $ref: '#/components/schemas/ttsEnhancedVoice'
-    awsProvider:
       required:
-        - region
-        - awsCredentials
+        - provider
+        - voiceName
+    awsProvider:
       description: Google Provider is required
       properties:
         region:
           $ref: '#/components/schemas/region'
         awsCredentials:
           $ref: '#/components/schemas/awsProviderCredentials'
-    awsProviderResponse:
       required:
-        - awsProvider
         - region
-      description: Google Provider is required
+        - awsCredentials
+    awsProviderResponse:
+      description: Aws Provider is required
       properties:
         region:
           $ref: '#/components/schemas/region'
         awsCredentials:
           $ref: '#/components/schemas/awsProviderCredentials'
-    cognigyProvider:
       required:
-        - botUrl
+        - awsProvider
+        - region
+    cognigyProvider:
       description: Cognigy Provider is required
       properties:
         botUrl:
           $ref: '#/components/schemas/botUrl'
+      required:
+        - botUrl
     error:
       title: Error
       type: object
@@ -2015,7 +2012,6 @@ components:
             location: us-east-1
             environment: Production
             projectId: myproject
-            agentId: myagent
         errors: []
     googleCxProviderGetResponseExample:
       summary: An example of a Google-CX provider get response