updating swagger to match ARM API for DirectLineSpeechChannel (#14317)

vanshu86 · Vanshika Sinha · web-flow · commit d4e95e17c30a · 2021-05-13T11:08:41.000+08:00
* 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 &lt;vasinha@microsoft.com&gt;
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/botservice.json b/specification/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/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/GetDirectLineSpeechChannel.json b/specification/botservice/resource-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/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/PutDirectLineSpeechChannel.json b/specification/botservice/resource-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/specification/botservice/resource-manager/Microsoft.BotService/stable/2021-03-01/examples/UpdateDirectLineSpeechChannel.json b/specification/botservice/resource-manager/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
           }
         }

Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,8 @@`
`10`	`10`	`"properties": {`
`11`	`11`	`"channelName": "DirectLineSpeechChannel",`
`12`	`12`	`"properties": {`
`13`		`- "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",`
	`13`	`+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",`
	`14`	`+ "cognitiveServiceSubscriptionKey": "XcognitiveServiceSubscriptionKeyX",`
`14`	`15`	`"isEnabled": true`
`15`	`16`	`}`
`16`	`17`	`}`
`@@ -23,7 +24,7 @@`
`23`	`24`	`"properties": {`
`24`	`25`	`"channelName": "DirectLineSpeechChannel",`
`25`	`26`	`"properties": {`
`26`		`- "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",`
	`27`	`+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",`
`27`	`28`	`"isEnabled": true`
`28`	`29`	`}`
`29`	`30`	`}`
`@@ -35,7 +36,7 @@`
`35`	`36`	`"properties": {`
`36`	`37`	`"channelName": "DirectLineSpeechChannel",`
`37`	`38`	`"properties": {`
`38`		`- "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX",`
	`39`	`+ "cognitiveServiceRegion": "XcognitiveServiceRegionX",`
`39`	`40`	`"isEnabled": true`
`40`	`41`	`}`
`41`	`42`	`}`