[Hub Generated] Review request for Microsoft.BotService to add version stable/2020-06-02 (#11976)

ssss141414 · web-flow · commit afbf096bf6cf · 2020-12-16T17:49:06.000+08:00
* update swagger api

* add custom words

* remove secret in examples

* test validation

* test validation

* test validation

* suppress verifyToken

* suppress verifyToken

* suppress verifyToken

* suppress verifyToken

* suppress verifyToken

* suppress verifyToken

* suppress verifyToken
diff --git a/custom-words.txt b/custom-words.txt
@@ -335,6 +335,7 @@ cloudsimple
 clustermonitoring
 clustername
 CMAF
+CMEK
 Cmdkey
 cmdlet
 CMMI
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json
@@ -1277,6 +1277,14 @@
         "luisKey": {
           "type": "string",
           "description": "The LUIS Key"
+        },
+        "isCmekEnabled": {
+          "type": "boolean",
+          "description": "Whether Cmek is enabled"
+        },
+        "cmekKeyVaultUrl": {
+          "type": "string",
+          "description": "The CMK Url"
         }
       },
       "description": "The parameters to provide for the Bot.",
@@ -1428,7 +1436,6 @@
       "description": "The parameters to provide for the Facebook channel.",
       "required": [
         "appId",
-        "appSecret",
         "isEnabled"
       ]
     },
@@ -1446,8 +1453,7 @@
       },
       "description": "A Facebook page for Facebook channel registration",
       "required": [
-        "id",
-        "accessToken"
+        "id"
       ]
     },
     "EmailChannel": {
@@ -1484,7 +1490,6 @@
       "description": "The parameters to provide for the Email channel.",
       "required": [
         "emailAddress",
-        "password",
         "isEnabled"
       ]
     },
@@ -1622,7 +1627,6 @@
       "description": "The parameters to provide for the Kik channel.",
       "required": [
         "userName",
-        "apiKey",
         "isEnabled"
       ]
     },
@@ -1724,7 +1728,6 @@
       },
       "description": "The parameters to provide for the Telegram channel.",
       "required": [
-        "accessToken",
         "isEnabled"
       ]
     },
@@ -1772,7 +1775,6 @@
       "required": [
         "phone",
         "accountSID",
-        "authToken",
         "isEnabled"
       ]
     },
@@ -1844,9 +1846,6 @@
       },
       "description": "The parameters to provide for the Slack channel.",
       "required": [
-        "clientId",
-        "clientSecret",
-        "verificationToken",
         "isEnabled"
       ]
     },
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CreateBot.json
@@ -28,7 +28,9 @@
           "luisappid2"
         ],
         "luisKey": "luiskey",
-        "msaAppId": "exampleappid"
+        "msaAppId": "exampleappid",
+        "isCmekEnabled": true,
+        "cmekKeyVaultUrl": "https://myCmekKey"
       }
     }
   },
@@ -64,7 +66,9 @@
           ],
           "enabledChannels": [
             "facebook"
-          ]
+          ],
+          "isCmekEnabled": true,
+          "cmekKeyVaultUrl": "https://myCmekKey"
         }
       }
     },
@@ -97,7 +101,9 @@
           ],
           "enabledChannels": [
             "facebook"
-          ]
+          ],
+          "isCmekEnabled": true,
+          "cmekKeyVaultUrl": "https://myCmekKey"
         }
       }
     }
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetBot.json
@@ -37,7 +37,9 @@
           ],
           "enabledChannels": [
             "facebook"
-          ]
+          ],
+          "isCmekEnabled": true,
+          "cmekKeyVaultUrl": "https://myCmekKey"
         }
       }
     }
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetConnection.json
@@ -15,7 +15,7 @@
         "name": "sampleConnection",
         "properties": {
           "clientId": "sampleclientid",
-          "clientSecret": "samplesecret",
+          "clientSecret": null,
           "scopes": "samplescope",
           "serviceProviderId": "serviceproviderid",
           "serviceProviderDisplayName": "serviceProviderDisplayName",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetLineChannel.json
@@ -16,8 +16,8 @@
             "lineRegistrations": [
               {
                 "generatedId": "id",
-                "channelSecret": "channelSecret",
-                "channelAccessToken": "channelAccessToken"
+                "channelSecret": null,
+                "channelAccessToken": null
               }
             ],
             "callbackUrl": "http://callbackUrl",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsByResourceGroup.json
@@ -38,7 +38,9 @@
               ],
               "enabledChannels": [
                 "facebook"
-              ]
+              ],
+              "isCmekEnabled": true,
+              "cmekKeyVaultUrl": "https://myCmekKey"
             }
           }
         ]
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsBySubscription.json
@@ -37,7 +37,9 @@
               ],
               "enabledChannels": [
                 "facebook"
-              ]
+              ],
+              "isCmekEnabled": true,
+              "cmekKeyVaultUrl": "https://myCmekKey"
             }
           }
         ]
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannelsByBotService.json
@@ -27,12 +27,12 @@
               "properties": {
                 "verifyToken": "othertoken",
                 "appId": "id",
-                "appSecret": "secret",
+                "appSecret": null,
                 "callbackUrl": "appid",
                 "isEnabled": true,
                 "pages": [
                   {
-                    "accessToken": "token",
+                    "accessToken": null,
                     "id": "id"
                   }
                 ]
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListConnectionsByBotService.json
@@ -13,7 +13,7 @@
             "name": "sampleConnection",
             "properties": {
               "clientId": "sampleclientid",
-              "clientSecret": "samplesecret",
+              "clientSecret": null,
               "scopes": "samplescope",
               "serviceProviderId": "serviceproviderid",
               "parameters": [
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutConnection.json
@@ -35,7 +35,7 @@
         "name": "sampleConnection",
         "properties": {
           "clientId": "sampleclientid",
-          "clientSecret": "samplesecret",
+          "clientSecret": null,
           "scopes": "samplescope",
           "serviceProviderId": "serviceproviderid",
           "serviceProviderDisplayName": "serviceProviderDisplayName",
@@ -60,7 +60,7 @@
         "name": "sampleConnection",
         "properties": {
           "clientId": "sampleclientid",
-          "clientSecret": "samplesecret",
+          "clientSecret": null,
           "scopes": "samplescope",
           "serviceProviderId": "serviceproviderid",
           "serviceProviderDisplayName": "serviceProviderDisplayName",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutLineChannel.json
@@ -30,8 +30,8 @@
             "lineRegistrations": [
               {
                 "generatedId": "id",
-                "channelSecret": "channelSecret",
-                "channelAccessToken": "channelAccessToken"
+                "channelSecret": null,
+                "channelAccessToken": null
               }
             ],
             "callbackUrl": "http://callbackUrl",
@@ -49,8 +49,8 @@
             "lineRegistrations": [
               {
                 "generatedId": "id",
-                "channelSecret": "channelSecret",
-                "channelAccessToken": "channelAccessToken"
+                "channelSecret": null,
+                "channelAccessToken": null
               }
             ],
             "callbackUrl": "http://callbackUrl",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateBot.json
@@ -28,7 +28,9 @@
           "luisappid2"
         ],
         "luisKey": "luiskey",
-        "msaAppId": "msaappid"
+        "msaAppId": "msaappid",
+        "isCmekEnabled": true,
+        "cmekKeyVaultUrl": "https://myCmekKey"
       }
     }
   },
@@ -64,7 +66,9 @@
           ],
           "enabledChannels": [
             "facebook"
-          ]
+          ],
+          "isCmekEnabled": true,
+          "cmekKeyVaultUrl": "https://myCmekKey"
         }
       }
     },
@@ -99,7 +103,9 @@
           ],
           "enabledChannels": [
             "facebook"
-          ]
+          ],
+          "isCmekEnabled": true,
+          "cmekKeyVaultUrl": "https://myCmekKey"
         }
       }
     }
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateConnection.json
@@ -35,7 +35,7 @@
         "name": "sampleConnection",
         "properties": {
           "clientId": "sampleclientid",
-          "clientSecret": "samplesecret",
+          "clientSecret": null,
           "scopes": "samplescope",
           "serviceProviderId": "serviceproviderid",
           "serviceProviderDisplayName": "serviceProviderDisplayName",
@@ -60,7 +60,7 @@
         "name": "sampleConnection",
         "properties": {
           "clientId": "sampleclientid",
-          "clientSecret": "samplesecret",
+          "clientSecret": null,
           "scopes": "samplescope",
           "serviceProviderId": "serviceproviderid",
           "serviceProviderDisplayName": "serviceProviderDisplayName",
diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateLineChannel.json
@@ -30,8 +30,8 @@
             "lineRegistrations": [
               {
                 "generatedId": "id",
-                "channelSecret": "channelSecret",
-                "channelAccessToken": "channelAccessToken"
+                "channelSecret": null,
+                "channelAccessToken": null
               }
             ],
             "callbackUrl": "http://callbackUrl",
@@ -49,8 +49,8 @@
             "lineRegistrations": [
               {
                 "generatedId": "id",
-                "channelSecret": "channelSecret",
-                "channelAccessToken": "channelAccessToken"
+                "channelSecret": null,
+                "channelAccessToken": null
               }
             ],
             "callbackUrl": "http://callbackUrl",
diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md
@@ -38,6 +38,8 @@ These settings apply only when `--tag=package-2020-06-02` is specified on the co
 input-file:
   - Microsoft.BotService/stable/2020-06-02/botservice.json
 ```
+
+
 ### Tag: package-2018-07-12
 
 These settings apply only when `--tag=package-2018-07-12` is specified on the command line.
@@ -102,6 +104,19 @@ swagger-to-sdk:
   - repo: azure-sdk-for-js
 ```
 
+
+## Suppression
+```
+directive:
+  - suppress: SECRET_PROPERTY
+    from:
+      - Microsoft.BotService/stable/2020-06-02/botservice.json
+    where:
+      - $.definitions.FacebookChannelProperties.properties.verifyToken
+    reason: We do need to return verifyToken in FacebookChannelProperties.
+```
+
+
 ## C#
 
 These settings apply only when `--csharp` is specified on the command line.

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,9 @@`
`28`	`28`	`"luisappid2"`
`29`	`29`	`],`
`30`	`30`	`"luisKey": "luiskey",`
`31`		`- "msaAppId": "exampleappid"`
	`31`	`+ "msaAppId": "exampleappid",`
	`32`	`+ "isCmekEnabled": true,`
	`33`	`+ "cmekKeyVaultUrl": "https://myCmekKey"`
`32`	`34`	`}`
`33`	`35`	`}`
`34`	`36`	`},`
`@@ -64,7 +66,9 @@`
`64`	`66`	`],`
`65`	`67`	`"enabledChannels": [`
`66`	`68`	`"facebook"`
`67`		`- ]`
	`69`	`+ ],`
	`70`	`+ "isCmekEnabled": true,`
	`71`	`+ "cmekKeyVaultUrl": "https://myCmekKey"`
`68`	`72`	`}`
`69`	`73`	`}`
`70`	`74`	`},`
`@@ -97,7 +101,9 @@`
`97`	`101`	`],`
`98`	`102`	`"enabledChannels": [`
`99`	`103`	`"facebook"`
`100`		`- ]`
	`104`	`+ ],`
	`105`	`+ "isCmekEnabled": true,`
	`106`	`+ "cmekKeyVaultUrl": "https://myCmekKey"`
`101`	`107`	`}`
`102`	`108`	`}`
`103`	`109`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,9 @@`
`37`	`37`	`],`
`38`	`38`	`"enabledChannels": [`
`39`	`39`	`"facebook"`
`40`		`- ]`
	`40`	`+ ],`
	`41`	`+ "isCmekEnabled": true,`
	`42`	`+ "cmekKeyVaultUrl": "https://myCmekKey"`
`41`	`43`	`}`
`42`	`44`	`}`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@`
`16`	`16`	`"lineRegistrations": [`
`17`	`17`	`{`
`18`	`18`	`"generatedId": "id",`
`19`		`- "channelSecret": "channelSecret",`
`20`		`- "channelAccessToken": "channelAccessToken"`
	`19`	`+ "channelSecret": null,`
	`20`	`+ "channelAccessToken": null`
`21`	`21`	`}`
`22`	`22`	`],`
`23`	`23`	`"callbackUrl": "http://callbackUrl",`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,9 @@`
`38`	`38`	`],`
`39`	`39`	`"enabledChannels": [`
`40`	`40`	`"facebook"`
`41`		`- ]`
	`41`	`+ ],`
	`42`	`+ "isCmekEnabled": true,`
	`43`	`+ "cmekKeyVaultUrl": "https://myCmekKey"`
`42`	`44`	`}`
`43`	`45`	`}`
`44`	`46`	`]`
Original file line number	Diff line number	Diff line change
`@@ -27,12 +27,12 @@`
`27`	`27`	`"properties": {`
`28`	`28`	`"verifyToken": "othertoken",`
`29`	`29`	`"appId": "id",`
`30`		`- "appSecret": "secret",`
	`30`	`+ "appSecret": null,`
`31`	`31`	`"callbackUrl": "appid",`
`32`	`32`	`"isEnabled": true,`
`33`	`33`	`"pages": [`
`34`	`34`	`{`
`35`		`- "accessToken": "token",`
	`35`	`+ "accessToken": null,`
`36`	`36`	`"id": "id"`
`37`	`37`	`}`
`38`	`38`	`]`