Skip to content

Commit 010519f

Browse files
zhixzhanDanieladu
zhixzhan
and
Danieladu
authored
Review request for Microsoft.BotService to update version stable/2021-03-01 (#16882)
* fix api * add name property * update OP Channels_ListWithKeys * update type * mark the parameter value as x-ms-secret * allow null in value * ' * sync changes to 2021-05-01-preview Co-authored-by: FAREAST\hond <[email protected]>
1 parent 4cda81c commit 010519f

File tree

4 files changed

+332
-150
lines changed

4 files changed

+332
-150
lines changed

‎specification/botservice/resource-manager/Microsoft.BotService/preview/2021-05-01-preview/botservice.json

Lines changed: 114 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -583,7 +583,7 @@
583583
"200": {
584584
"description": "If resource is retrieved successfully, the service should return 200 (OK).",
585585
"schema": {
586-
"$ref": "#/definitions/BotChannel"
586+
"$ref": "#/definitions/ListChannelWithKeysResponse"
587587
}
588588
},
589589
"default": {
@@ -1456,7 +1456,8 @@
14561456
},
14571457
"kind": {
14581458
"$ref": "#/definitions/Kind",
1459-
"description": "Required. Gets or sets the Kind of the resource."
1459+
"description": "Required. Gets or sets the Kind of the resource.",
1460+
"x-nullable": true
14601461
},
14611462
"etag": {
14621463
"type": "string",
@@ -1690,6 +1691,10 @@
16901691
"type": "string",
16911692
"description": "The channel schema transformation version for the bot"
16921693
},
1694+
"storageResourceId": {
1695+
"type": "string",
1696+
"description": "The storage resourceId for the bot"
1697+
},
16931698
"privateEndpointConnections": {
16941699
"type": "array",
16951700
"readOnly": true,
@@ -1740,6 +1745,25 @@
17401745
},
17411746
"description": "The list of bot service operation response."
17421747
},
1748+
"ListChannelWithKeysResponse": {
1749+
"type": "object",
1750+
"description": "The ARM channel of list channel with keys operation response.",
1751+
"allOf": [
1752+
{
1753+
"$ref": "#/definitions/BotChannel"
1754+
}
1755+
],
1756+
"properties": {
1757+
"resource": {
1758+
"$ref": "#/definitions/Channel",
1759+
"description": "The set of properties specific to bot channel resource"
1760+
},
1761+
"setting": {
1762+
"$ref": "#/definitions/ChannelSettings",
1763+
"description": "Channel settings"
1764+
}
1765+
}
1766+
},
17431767
"BotChannel": {
17441768
"type": "object",
17451769
"description": "Bot channel resource definition",
@@ -1755,6 +1779,51 @@
17551779
}
17561780
}
17571781
},
1782+
"ChannelSettings": {
1783+
"type": "object",
1784+
"description": "Channel settings definition",
1785+
"properties": {
1786+
"extensionKey1": {
1787+
"type": "string",
1788+
"description": "The extensionKey1"
1789+
},
1790+
"extensionKey2": {
1791+
"type": "string",
1792+
"description": "The extensionKey2"
1793+
},
1794+
"sites": {
1795+
"type": "array",
1796+
"items": {
1797+
"$ref": "#/definitions/Site"
1798+
},
1799+
"description": "The list of sites"
1800+
},
1801+
"channelId": {
1802+
"type": "string",
1803+
"description": "The channel id"
1804+
},
1805+
"channelDisplayName": {
1806+
"type": "string",
1807+
"description": "The channel display name"
1808+
},
1809+
"botId": {
1810+
"type": "string",
1811+
"description": "The bot id"
1812+
},
1813+
"botIconUrl": {
1814+
"type": "string",
1815+
"description": "The bot icon url"
1816+
},
1817+
"isEnabled": {
1818+
"type": "boolean",
1819+
"description": "Whether this channel is enabled for the bot"
1820+
},
1821+
"disableLocalAuth": {
1822+
"type": "boolean",
1823+
"description": "Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication."
1824+
}
1825+
}
1826+
},
17581827
"Channel": {
17591828
"type": "object",
17601829
"description": "Channel definition",
@@ -1767,6 +1836,15 @@
17671836
"etag": {
17681837
"type": "string",
17691838
"description": "Entity Tag of the resource"
1839+
},
1840+
"provisioningState": {
1841+
"type": "string",
1842+
"readOnly": true,
1843+
"description": "Provisioning state of the resource"
1844+
},
1845+
"location": {
1846+
"description": "Specifies the location of the resource.",
1847+
"type": "string"
17701848
}
17711849
},
17721850
"required": [
@@ -1786,15 +1864,6 @@
17861864
"properties": {
17871865
"$ref": "#/definitions/AlexaChannelProperties",
17881866
"description": "The set of properties specific to Alexa channel resource"
1789-
},
1790-
"etag": {
1791-
"type": "string",
1792-
"description": "Entity Tag of the resource"
1793-
},
1794-
"provisioningState": {
1795-
"type": "string",
1796-
"readOnly": true,
1797-
"description": "Provisioning state of the resource"
17981867
}
17991868
}
18001869
},
@@ -1838,14 +1907,6 @@
18381907
"properties": {
18391908
"$ref": "#/definitions/FacebookChannelProperties",
18401909
"description": "The set of properties specific to bot facebook channel"
1841-
},
1842-
"provisioningState": {
1843-
"type": "string",
1844-
"description": "Provisioning state of the resource"
1845-
},
1846-
"location": {
1847-
"type": "string",
1848-
"description": "Location of the resource"
18491910
}
18501911
}
18511912
},
@@ -1919,14 +1980,6 @@
19191980
"properties": {
19201981
"$ref": "#/definitions/EmailChannelProperties",
19211982
"description": "The set of properties specific to email channel resource"
1922-
},
1923-
"etag": {
1924-
"type": "string",
1925-
"description": "Entity Tag of the resource"
1926-
},
1927-
"provisioningState": {
1928-
"type": "string",
1929-
"description": "Provisioning state of the resource"
19301983
}
19311984
}
19321985
},
@@ -1964,18 +2017,6 @@
19642017
"properties": {
19652018
"$ref": "#/definitions/MsTeamsChannelProperties",
19662019
"description": "The set of properties specific to Microsoft Teams channel resource"
1967-
},
1968-
"etag": {
1969-
"type": "string",
1970-
"description": "Entity Tag of the resource"
1971-
},
1972-
"provisioningState": {
1973-
"type": "string",
1974-
"description": "Provisioning state of the resource"
1975-
},
1976-
"location": {
1977-
"type": "string",
1978-
"description": "Location of the resource"
19792020
}
19802021
}
19812022
},
@@ -2024,10 +2065,6 @@
20242065
"properties": {
20252066
"$ref": "#/definitions/SkypeChannelProperties",
20262067
"description": "The set of properties specific to Skype channel resource"
2027-
},
2028-
"etag": {
2029-
"type": "string",
2030-
"description": "Entity Tag of the resource"
20312068
}
20322069
}
20332070
},
@@ -2133,18 +2170,6 @@
21332170
"properties": {
21342171
"$ref": "#/definitions/WebChatChannelProperties",
21352172
"description": "The set of properties specific to Web Chat channel resource"
2136-
},
2137-
"location": {
2138-
"type": "string",
2139-
"description": "Location of the resource"
2140-
},
2141-
"provisioningState": {
2142-
"type": "string",
2143-
"description": "Provisioning state of the resource"
2144-
},
2145-
"etag": {
2146-
"type": "string",
2147-
"description": "Entity Tag of the resource"
21482173
}
21492174
}
21502175
},
@@ -2181,18 +2206,6 @@
21812206
"properties": {
21822207
"$ref": "#/definitions/DirectLineChannelProperties",
21832208
"description": "The set of properties specific to Direct Line channel resource"
2184-
},
2185-
"etag": {
2186-
"type": "string",
2187-
"description": "Entity Tag of the resource"
2188-
},
2189-
"provisioningState": {
2190-
"type": "string",
2191-
"description": "Provisioning state of the resource"
2192-
},
2193-
"location": {
2194-
"type": "string",
2195-
"description": "Location of the resource"
21962209
}
21972210
}
21982211
},
@@ -2225,14 +2238,6 @@
22252238
"properties": {
22262239
"$ref": "#/definitions/TelegramChannelProperties",
22272240
"description": "The set of properties specific to Telegram channel resource"
2228-
},
2229-
"etag": {
2230-
"type": "string",
2231-
"description": "Entity Tag of the resource"
2232-
},
2233-
"provisioningState": {
2234-
"type": "string",
2235-
"description": "Provisioning state of the resource"
22362241
}
22372242
}
22382243
},
@@ -2270,10 +2275,6 @@
22702275
"properties": {
22712276
"$ref": "#/definitions/SmsChannelProperties",
22722277
"description": "The set of properties specific to Sms channel resource"
2273-
},
2274-
"etag": {
2275-
"type": "string",
2276-
"description": "Entity Tag of the resource"
22772278
}
22782279
}
22792280
},
@@ -2321,14 +2322,6 @@
23212322
"properties": {
23222323
"$ref": "#/definitions/SlackChannelProperties",
23232324
"description": "The set of properties specific to Slack channel resource"
2324-
},
2325-
"etag": {
2326-
"type": "string",
2327-
"description": "Entity Tag of the resource"
2328-
},
2329-
"location": {
2330-
"type": "string",
2331-
"description": "Location of the resource"
23322325
}
23332326
}
23342327
},
@@ -2468,14 +2461,6 @@
24682461
"properties": {
24692462
"$ref": "#/definitions/DirectLineSpeechChannelProperties",
24702463
"description": "The set of properties specific to DirectLine Speech channel resource"
2471-
},
2472-
"provisioningState": {
2473-
"type": "string",
2474-
"description": "Provisioning state of the resource"
2475-
},
2476-
"etag": {
2477-
"type": "string",
2478-
"description": "Entity Tag of the resource"
24792464
}
24802465
}
24812466
},
@@ -2566,7 +2551,8 @@
25662551
},
25672552
"isWebchatPreviewEnabled": {
25682553
"type": "boolean",
2569-
"description": "Whether this site is enabled for preview versions of Webchat"
2554+
"description": "Whether this site is enabled for preview versions of Webchat",
2555+
"default": false
25702556
}
25712557
},
25722558
"required": [
@@ -2642,6 +2628,28 @@
26422628
"siteName"
26432629
]
26442630
},
2631+
"Site": {
2632+
"type": "object",
2633+
"allOf": [
2634+
{
2635+
"$ref": "#/definitions/WebChatSite"
2636+
},
2637+
{
2638+
"$ref": "#/definitions/DirectLineSite"
2639+
}
2640+
],
2641+
"properties": {
2642+
"isTokenEnabled": {
2643+
"type": "boolean",
2644+
"description": "Whether this site is token enabled for channel"
2645+
},
2646+
"eTag": {
2647+
"type": "string",
2648+
"description": "Entity Tag"
2649+
}
2650+
},
2651+
"description": "A site for the channel"
2652+
},
26452653
"SiteInfo": {
26462654
"properties": {
26472655
"siteName": {
@@ -2686,13 +2694,22 @@
26862694
},
26872695
"value": {
26882696
"type": "string",
2689-
"description": "Value associated with the Connection Setting Parameter."
2697+
"description": "Value associated with the Connection Setting Parameter.",
2698+
"x-nullable": true
26902699
}
26912700
},
26922701
"description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties"
26932702
},
26942703
"ConnectionSettingProperties": {
26952704
"properties": {
2705+
"id": {
2706+
"type": "string",
2707+
"description": "Id associated with the Connection Setting."
2708+
},
2709+
"name": {
2710+
"type": "string",
2711+
"description": "Name associated with the Connection Setting."
2712+
},
26962713
"clientId": {
26972714
"type": "string",
26982715
"description": "Client Id associated with the Connection Setting."

0 commit comments

Comments
 (0)