updating swagger to match ARM API for DirectLineSpeechChannel (Azure#…

…14317) * updating swagger to match ARM API for DirectLineSpeechChannel * addressing auto-comments * typo * tagging cognitiveSubscriptionKey as x-ms-secret * updating examples * removing cognitiveSubscriptionKey from responses Co-authored-by: Vanshika Sinha <vasinha@microsoft.com>
handonMS · May 13, 2021 · d4e95e1 · d4e95e1
1 parent 138df5f
commit d4e95e1
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 10 deletions.
diff --git a/...cation/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json b/...cation/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json
@@ -1982,9 +1982,14 @@
     },
     "DirectLineSpeechChannelProperties": {
       "properties": {
-        "cognitiveServicesSubscriptionId": {
+        "cognitiveServiceRegion": {
           "type": "string",
-          "description": "The cognitive service subscription ID to use with this channel registration."
+          "description": "The cognitive service region with this channel registration."
+        },
+        "cognitiveServiceSubscriptionKey": {
+          "x-ms-secret": true,
+          "type": "string",
+          "description": "The cognitive service subscription key to use with this channel registration."
         },
         "isEnabled": {
           "type": "boolean",
@@ -2005,7 +2010,8 @@
       },
       "description": "The parameters to provide for the DirectLine Speech channel.",
       "required": [
-        "cognitiveServicesSubscriptionId"
+        "cognitiveServiceRegion",
+        "cognitiveServiceSubscriptionKey"
       ]
     },
     "ChannelResponseList": {

diff --git a/...e-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json b/...e-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json
@@ -13,7 +13,7 @@
         "properties": {
           "channelName": "DirectLineSpeechChannel",
           "properties": {
-            "cognitiveServicesSubscriptionId": "Cognitive services subscription ID",
+            "cognitiveServiceRegion": "Cognitive service region",
             "customVoiceDeploymentId": "Custom voice deployment ID",
             "customSpeechModelId": "Custom speech model ID",
             "isDefaultBotForCogSvcAccount": true,

diff --git a/...e-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json b/...e-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json
@@ -10,7 +10,8 @@
       "properties": {
         "channelName": "DirectLineSpeechChannel",
         "properties": {
-          "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",
+          "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+          "cognitiveServiceSubscriptionKey": "XcognitiveServiceSubscriptionKeyX",
           "isEnabled": true
         }
       }
@@ -23,7 +24,7 @@
         "properties": {
           "channelName": "DirectLineSpeechChannel",
           "properties": {
-            "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",
+            "cognitiveServiceRegion": "XcognitiveServiceRegionX",
             "isEnabled": true
           }
         }
@@ -35,7 +36,7 @@
         "properties": {
           "channelName": "DirectLineSpeechChannel",
           "properties": {
-            "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",
+            "cognitiveServiceRegion": "XcognitiveServiceRegionX",
             "isEnabled": true
           }
         }

diff --git a/...anager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json b/...anager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json
@@ -10,7 +10,8 @@
       "properties": {
         "channelName": "DirectLineSpeechChannel",
         "properties": {
-          "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",
+          "cognitiveServiceRegion": "XcognitiveServiceRegionX",
+          "cognitiveServiceSubscriptionKey": "XcognitiveServiceSubscriptionKeyX",
           "isEnabled": true
         }
       }
@@ -23,7 +24,7 @@
         "properties": {
           "channelName": "DirectLineSpeechChannel",
           "properties": {
-            "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",
+            "cognitiveServiceRegion": "XcognitiveServiceRegionX",
             "isEnabled": true
           }
         }
@@ -35,7 +36,7 @@
         "properties": {
           "channelName": "DirectLineSpeechChannel",
           "properties": {
-            "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",
+            "cognitiveServiceRegion": "XcognitiveServiceRegionX",
             "isEnabled": true
           }
         }