Azure
Release botservice microsoft.bot service 2022 09 15
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
Changelog
Add a changelog entry for this PR by answering the following questions:
- What's the purpose of the update?
- [ ] new service onboarding
- [X] new API version
- [ ] update existing version for new feature
- [X] update existing version to fix swagger quality issue in s360
- [ ] Other, please clarify
- When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. Sep/2022
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. Sep/2022
- By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
Contribution checklist (MS Employees Only):
- [ ] I commit to follow the Breaking Change Policy of "no breaking changes"
- [X] I have reviewed the documentation for the workflow.
- [X] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Applicability: :warning:
If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.
- Change to data plane APIs
- Adding new properties
- All removals
Otherwise your PR may be subject to ARM review requirements. Complete the following:
-
[X] Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version -[X] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
-
[X] Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
-
[ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.
NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)
Please follow the link to find more details on PR review process.
Hi, @thatChang Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Hi, @thatChang your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Swagger Validation Report
️❌BreakingChange: 101 Errors, 12 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| botservice.json | 2021-05-01-preview(c0b556f) | 2021-05-01-preview(main) |
| privatelinks.json | 2021-05-01-preview(c0b556f) | 2021-05-01-preview(main) |
| botservice.json | 2022-06-15-preview(c0b556f) | 2022-06-15-preview(main) |
| privatelinks.json | 2022-06-15-preview(c0b556f) | 2022-06-15-preview(main) |
| botservice.json | 2021-03-01(c0b556f) | 2021-03-01(main) |
Only 17 items are listed, please refer to log for more details.
️❌Breaking Change(Cross-Version): 19 Errors, 20 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| botservice.json | 2022-09-15(c0b556f) | 2021-03-01(main) |
| botservice.json | 2022-09-15(c0b556f) | 2022-06-15-preview(main) |
| privatelinks.json | 2022-09-15(c0b556f) | 2022-06-15-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 17 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 20 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-06 | package-preview-2022-06(c0b556f) | package-preview-2022-06(main) |
| package-preview-2021-05 | package-preview-2021-05(c0b556f) | package-preview-2021-05(main) |
| package-2021-03-01 | package-2021-03-01(c0b556f) | package-2021-03-01(main) |
| package-2022-09 | package-2022-09(c0b556f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
Only 17 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L31 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1864 |
|
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2630 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2673 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2817 |
|
| :warning: PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L31 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L1986 |
|
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2752 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2795 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/preview/2022-06-15-preview/botservice.json#L2939 |
|
| :warning: PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L31 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L1591 |
|
| :warning: AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L2366 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L2409 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L2553 |
|
| :warning: PutRequestResponseScheme | A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'Bots_Create' Request Model: 'parameters[2].schema' Response Model: 'responses[200].schema' Location: Microsoft.BotService/stable/2022-09-15/botservice.json#L31 |
|
| :warning: EnumInsteadOfBoolean | Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.BotService/stable/2022-09-15/botservice.json#L1986 |
The following errors/warnings exist before current PR submission:
Only 17 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L104 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L104 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L104 |
|
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L304 |
|
The 'channelName' already appears in the path, please don't repeat it in the request body. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L335 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L405 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L405 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L405 |
|
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L556 |
|
The resource name parameter 'channelName' should be defined with a 'pattern' restriction. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L646 |
|
The response schema of operations API '/providers/Microsoft.BotService/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L765 |
|
Tracked resource 'ConnectionSetting' must have patch operation that at least supports the update of tags. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L818 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L943 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L943 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L943 |
|
The get operation should only return 200. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1178 |
|
A 202 response should include an Location response header. Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1178 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
Tag package-2022-09; Prod region: Not deployed; Canary region: Not deployed
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️⌛ApiDocPreview pending [Detail]
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-go - sdk/resourcemanager/botservice/armbotservice - 1.0.0+ Field `CallingWebHook` of struct `MsTeamsChannelProperties` has been removed + Field `ID` of struct `ConnectionSettingProperties` has been removed + Field `Name` of struct `ConnectionSettingProperties` has been removed
❌azure-sdk-for-python-track2 - track2_azure-mgmt-botservice - 2.0.0b4+ Model BotProperties no longer has parameter is_isolated + Model DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_id + Model MsTeamsChannelProperties no longer has parameter calling_web_hook + Model WebChatSite has a new required parameter is_webchat_preview_enabled + Model WebChatSite no longer has parameter enable_preview
❌azure-sdk-for-python - track2_azure-mgmt-botservice - 2.0.0b4+ Model BotProperties no longer has parameter is_isolated + Model DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_id + Model MsTeamsChannelProperties no longer has parameter calling_web_hook + Model WebChatSite has a new required parameter is_webchat_preview_enabled + Model WebChatSite no longer has parameter enable_preview
️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. SDK Automation 14.0.0command pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json command pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
️✔️Azure.ResourceManager.BotService [View full logs] [Preview SDK Changes]info [Changelog]
️⚠️ azure-sdk-for-python warning [Detail]
⚠️Warning [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.2.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-botservice [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group EmailOperations info [Changelog] - Added operation group OperationResultsOperations info [Changelog] - Added operation group PrivateEndpointConnectionsOperations info [Changelog] - Added operation group PrivateLinkResourcesOperations info [Changelog] - Added operation group QnAMakerEndpointKeysOperations info [Changelog] - Model AlexaChannel has a new parameter etag info [Changelog] - Model AlexaChannel has a new parameter location info [Changelog] - Model AlexaChannel has a new parameter provisioning_state info [Changelog] - Model Bot has a new parameter zones info [Changelog] - Model BotChannel has a new parameter zones info [Changelog] - Model BotProperties has a new parameter all_settings info [Changelog] - Model BotProperties has a new parameter app_password_hint info [Changelog] - Model BotProperties has a new parameter cmek_encryption_status info [Changelog] - Model BotProperties has a new parameter disable_local_auth info [Changelog] - Model BotProperties has a new parameter is_developer_app_insights_api_key_set info [Changelog] - Model BotProperties has a new parameter is_streaming_supported info [Changelog] - Model BotProperties has a new parameter manifest_url info [Changelog] - Model BotProperties has a new parameter migration_token info [Changelog] - Model BotProperties has a new parameter msa_app_msi_resource_id info [Changelog] - Model BotProperties has a new parameter msa_app_tenant_id info [Changelog] - Model BotProperties has a new parameter msa_app_type info [Changelog] - Model BotProperties has a new parameter open_with_hint info [Changelog] - Model BotProperties has a new parameter parameters info [Changelog] - Model BotProperties has a new parameter private_endpoint_connections info [Changelog] - Model BotProperties has a new parameter provisioning_state info [Changelog] - Model BotProperties has a new parameter public_network_access info [Changelog] - Model BotProperties has a new parameter publishing_credentials info [Changelog] - Model BotProperties has a new parameter storage_resource_id info [Changelog] - Model BotProperties has a new parameter tenant_id info [Changelog] - Model Channel has a new parameter etag info [Changelog] - Model Channel has a new parameter location info [Changelog] - Model Channel has a new parameter provisioning_state info [Changelog] - Model CheckNameAvailabilityResponseBody has a new parameter abs_code info [Changelog] - Model ConnectionSetting has a new parameter zones info [Changelog] - Model ConnectionSettingProperties has a new parameter provisioning_state info [Changelog] - Model DirectLineChannel has a new parameter etag info [Changelog] - Model DirectLineChannel has a new parameter location info [Changelog] - Model DirectLineChannel has a new parameter provisioning_state info [Changelog] - Model DirectLineChannelProperties has a new parameter direct_line_embed_code info [Changelog] - Model DirectLineChannelProperties has a new parameter extension_key1 info [Changelog] - Model DirectLineChannelProperties has a new parameter extension_key2 info [Changelog] - Model DirectLineSite has a new parameter is_block_user_upload_enabled info [Changelog] - Model DirectLineSpeechChannel has a new parameter etag info [Changelog] - Model DirectLineSpeechChannel has a new parameter location info [Changelog] - Model DirectLineSpeechChannel has a new parameter provisioning_state info [Changelog] - Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_region info [Changelog] - Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_resource_id info [Changelog] - Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_subscription_key info [Changelog] - Model EmailChannel has a new parameter etag info [Changelog] - Model EmailChannel has a new parameter location info [Changelog] - Model EmailChannel has a new parameter provisioning_state info [Changelog] - Model EmailChannelProperties has a new parameter auth_method info [Changelog] - Model EmailChannelProperties has a new parameter magic_code info [Changelog] - Model FacebookChannel has a new parameter etag info [Changelog] - Model FacebookChannel has a new parameter location info [Changelog] - Model FacebookChannel has a new parameter provisioning_state info [Changelog] - Model KikChannel has a new parameter etag info [Changelog] - Model KikChannel has a new parameter location info [Changelog] - Model KikChannel has a new parameter provisioning_state info [Changelog] - Model LineChannel has a new parameter etag info [Changelog] - Model LineChannel has a new parameter location info [Changelog] - Model LineChannel has a new parameter provisioning_state info [Changelog] - Model MsTeamsChannel has a new parameter etag info [Changelog] - Model MsTeamsChannel has a new parameter location info [Changelog] - Model MsTeamsChannel has a new parameter provisioning_state info [Changelog] - Model MsTeamsChannelProperties has a new parameter accepted_terms info [Changelog] - Model MsTeamsChannelProperties has a new parameter calling_webhook info [Changelog] - Model MsTeamsChannelProperties has a new parameter deployment_environment info [Changelog] - Model MsTeamsChannelProperties has a new parameter incoming_call_route info [Changelog] - Model Resource has a new parameter zones info [Changelog] - Model ServiceProviderParameter has a new parameter metadata info [Changelog] - Model SkypeChannel has a new parameter etag info [Changelog] - Model SkypeChannel has a new parameter location info [Changelog] - Model SkypeChannel has a new parameter provisioning_state info [Changelog] - Model SkypeChannelProperties has a new parameter incoming_call_route info [Changelog] - Model SlackChannel has a new parameter etag info [Changelog] - Model SlackChannel has a new parameter location info [Changelog] - Model SlackChannel has a new parameter provisioning_state info [Changelog] - Model SlackChannelProperties has a new parameter scopes info [Changelog] - Model SmsChannel has a new parameter etag info [Changelog] - Model SmsChannel has a new parameter location info [Changelog] - Model SmsChannel has a new parameter provisioning_state info [Changelog] - Model TelegramChannel has a new parameter etag info [Changelog] - Model TelegramChannel has a new parameter location info [Changelog] - Model TelegramChannel has a new parameter provisioning_state info [Changelog] - Model WebChatChannel has a new parameter etag info [Changelog] - Model WebChatChannel has a new parameter location info [Changelog] - Model WebChatChannel has a new parameter provisioning_state info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model BotProperties no longer has parameter is_isolated info [Changelog] - Model DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_id info [Changelog] - Model MsTeamsChannelProperties no longer has parameter calling_web_hook info [Changelog] - Model WebChatSite has a new required parameter is_webchat_preview_enabled info [Changelog] - Model WebChatSite no longer has parameter enable_preview
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.2.0 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-botservice [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation group EmailOperations info [Changelog] - Added operation group OperationResultsOperations info [Changelog] - Added operation group PrivateEndpointConnectionsOperations info [Changelog] - Added operation group PrivateLinkResourcesOperations info [Changelog] - Added operation group QnAMakerEndpointKeysOperations info [Changelog] - Model AlexaChannel has a new parameter etag info [Changelog] - Model AlexaChannel has a new parameter location info [Changelog] - Model AlexaChannel has a new parameter provisioning_state info [Changelog] - Model Bot has a new parameter zones info [Changelog] - Model BotChannel has a new parameter zones info [Changelog] - Model BotProperties has a new parameter all_settings info [Changelog] - Model BotProperties has a new parameter app_password_hint info [Changelog] - Model BotProperties has a new parameter cmek_encryption_status info [Changelog] - Model BotProperties has a new parameter disable_local_auth info [Changelog] - Model BotProperties has a new parameter is_developer_app_insights_api_key_set info [Changelog] - Model BotProperties has a new parameter is_streaming_supported info [Changelog] - Model BotProperties has a new parameter manifest_url info [Changelog] - Model BotProperties has a new parameter migration_token info [Changelog] - Model BotProperties has a new parameter msa_app_msi_resource_id info [Changelog] - Model BotProperties has a new parameter msa_app_tenant_id info [Changelog] - Model BotProperties has a new parameter msa_app_type info [Changelog] - Model BotProperties has a new parameter open_with_hint info [Changelog] - Model BotProperties has a new parameter parameters info [Changelog] - Model BotProperties has a new parameter private_endpoint_connections info [Changelog] - Model BotProperties has a new parameter provisioning_state info [Changelog] - Model BotProperties has a new parameter public_network_access info [Changelog] - Model BotProperties has a new parameter publishing_credentials info [Changelog] - Model BotProperties has a new parameter storage_resource_id info [Changelog] - Model BotProperties has a new parameter tenant_id info [Changelog] - Model Channel has a new parameter etag info [Changelog] - Model Channel has a new parameter location info [Changelog] - Model Channel has a new parameter provisioning_state info [Changelog] - Model CheckNameAvailabilityResponseBody has a new parameter abs_code info [Changelog] - Model ConnectionSetting has a new parameter zones info [Changelog] - Model ConnectionSettingProperties has a new parameter provisioning_state info [Changelog] - Model DirectLineChannel has a new parameter etag info [Changelog] - Model DirectLineChannel has a new parameter location info [Changelog] - Model DirectLineChannel has a new parameter provisioning_state info [Changelog] - Model DirectLineChannelProperties has a new parameter direct_line_embed_code info [Changelog] - Model DirectLineChannelProperties has a new parameter extension_key1 info [Changelog] - Model DirectLineChannelProperties has a new parameter extension_key2 info [Changelog] - Model DirectLineSite has a new parameter is_block_user_upload_enabled info [Changelog] - Model DirectLineSpeechChannel has a new parameter etag info [Changelog] - Model DirectLineSpeechChannel has a new parameter location info [Changelog] - Model DirectLineSpeechChannel has a new parameter provisioning_state info [Changelog] - Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_region info [Changelog] - Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_resource_id info [Changelog] - Model DirectLineSpeechChannelProperties has a new parameter cognitive_service_subscription_key info [Changelog] - Model EmailChannel has a new parameter etag info [Changelog] - Model EmailChannel has a new parameter location info [Changelog] - Model EmailChannel has a new parameter provisioning_state info [Changelog] - Model EmailChannelProperties has a new parameter auth_method info [Changelog] - Model EmailChannelProperties has a new parameter magic_code info [Changelog] - Model FacebookChannel has a new parameter etag info [Changelog] - Model FacebookChannel has a new parameter location info [Changelog] - Model FacebookChannel has a new parameter provisioning_state info [Changelog] - Model KikChannel has a new parameter etag info [Changelog] - Model KikChannel has a new parameter location info [Changelog] - Model KikChannel has a new parameter provisioning_state info [Changelog] - Model LineChannel has a new parameter etag info [Changelog] - Model LineChannel has a new parameter location info [Changelog] - Model LineChannel has a new parameter provisioning_state info [Changelog] - Model MsTeamsChannel has a new parameter etag info [Changelog] - Model MsTeamsChannel has a new parameter location info [Changelog] - Model MsTeamsChannel has a new parameter provisioning_state info [Changelog] - Model MsTeamsChannelProperties has a new parameter accepted_terms info [Changelog] - Model MsTeamsChannelProperties has a new parameter calling_webhook info [Changelog] - Model MsTeamsChannelProperties has a new parameter deployment_environment info [Changelog] - Model MsTeamsChannelProperties has a new parameter incoming_call_route info [Changelog] - Model Resource has a new parameter zones info [Changelog] - Model ServiceProviderParameter has a new parameter metadata info [Changelog] - Model SkypeChannel has a new parameter etag info [Changelog] - Model SkypeChannel has a new parameter location info [Changelog] - Model SkypeChannel has a new parameter provisioning_state info [Changelog] - Model SkypeChannelProperties has a new parameter incoming_call_route info [Changelog] - Model SlackChannel has a new parameter etag info [Changelog] - Model SlackChannel has a new parameter location info [Changelog] - Model SlackChannel has a new parameter provisioning_state info [Changelog] - Model SlackChannelProperties has a new parameter scopes info [Changelog] - Model SmsChannel has a new parameter etag info [Changelog] - Model SmsChannel has a new parameter location info [Changelog] - Model SmsChannel has a new parameter provisioning_state info [Changelog] - Model TelegramChannel has a new parameter etag info [Changelog] - Model TelegramChannel has a new parameter location info [Changelog] - Model TelegramChannel has a new parameter provisioning_state info [Changelog] - Model WebChatChannel has a new parameter etag info [Changelog] - Model WebChatChannel has a new parameter location info [Changelog] - Model WebChatChannel has a new parameter provisioning_state info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Model BotProperties no longer has parameter is_isolated info [Changelog] - Model DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_id info [Changelog] - Model MsTeamsChannelProperties no longer has parameter calling_web_hook info [Changelog] - Model WebChatSite has a new required parameter is_webchat_preview_enabled info [Changelog] - Model WebChatSite no longer has parameter enable_preview
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
️✔️sdk/resourcemanager/botservice/armbotservice [View full logs] [Preview SDK Changes] Breaking Change Detectedinfo [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Field `ID` of struct `ConnectionSettingProperties` has been removed info [Changelog] - Field `Name` of struct `ConnectionSettingProperties` has been removed info [Changelog] - Field `CallingWebHook` of struct `MsTeamsChannelProperties` has been removed info [Changelog] info [Changelog] ### Features Added info [Changelog] info [Changelog] - New value `ChannelNameOmnichannel`, `ChannelNameTelephonyChannel` added to type alias `ChannelName` info [Changelog] - New type alias `EmailChannelAuthMethod` with values `EmailChannelAuthMethodGraph`, `EmailChannelAuthMethodPassword` info [Changelog] - New function `NewEmailClient(string, azcore.TokenCredential, *arm.ClientOptions) (*EmailClient, error)` info [Changelog] - New function `*EmailClient.CreateSignInURL(context.Context, string, string, *EmailClientCreateSignInURLOptions) (EmailClientCreateSignInURLResponse, error)` info [Changelog] - New function `*Omnichannel.GetChannel() *Channel` info [Changelog] - New function `*OutlookChannel.GetChannel() *Channel` info [Changelog] - New function `NewQnAMakerEndpointKeysClient(string, azcore.TokenCredential, *arm.ClientOptions) (*QnAMakerEndpointKeysClient, error)` info [Changelog] - New function `*QnAMakerEndpointKeysClient.Get(context.Context, QnAMakerEndpointKeysRequestBody, *QnAMakerEndpointKeysClientGetOptions) (QnAMakerEndpointKeysClientGetResponse, error)` info [Changelog] - New function `*TelephonyChannel.GetChannel() *Channel` info [Changelog] - New struct `CreateEmailSignInURLResponse` info [Changelog] - New struct `CreateEmailSignInURLResponseProperties` info [Changelog] - New struct `EmailClient` info [Changelog] - New struct `Omnichannel` info [Changelog] - New struct `OutlookChannel` info [Changelog] - New struct `QnAMakerEndpointKeysClient` info [Changelog] - New struct `QnAMakerEndpointKeysRequestBody` info [Changelog] - New struct `QnAMakerEndpointKeysResponse` info [Changelog] - New struct `TelephonyChannel` info [Changelog] - New struct `TelephonyChannelProperties` info [Changelog] - New struct `TelephonyChannelResourceAPIConfiguration` info [Changelog] - New struct `TelephonyPhoneNumbers` info [Changelog] - New field `TenantID` in struct `BotProperties` info [Changelog] - New field `RequireTermsAgreement` in struct `ChannelSettings` info [Changelog] - New field `AbsCode` in struct `CheckNameAvailabilityResponseBody` info [Changelog] - New field `ExtensionKey1` in struct `DirectLineChannelProperties` info [Changelog] - New field `ExtensionKey2` in struct `DirectLineChannelProperties` info [Changelog] - New field `AppID` in struct `DirectLineSite` info [Changelog] - New field `ETag` in struct `DirectLineSite` info [Changelog] - New field `IsDetailedLoggingEnabled` in struct `DirectLineSite` info [Changelog] - New field `IsEndpointParametersEnabled` in struct `DirectLineSite` info [Changelog] - New field `IsNoStorageEnabled` in struct `DirectLineSite` info [Changelog] - New field `IsTokenEnabled` in struct `DirectLineSite` info [Changelog] - New field `IsWebChatSpeechEnabled` in struct `DirectLineSite` info [Changelog] - New field `IsWebchatPreviewEnabled` in struct `DirectLineSite` info [Changelog] - New field `TenantID` in struct `DirectLineSite` info [Changelog] - New field `CognitiveServiceResourceID` in struct `DirectLineSpeechChannelProperties` info [Changelog] - New field `AuthMethod` in struct `EmailChannelProperties` info [Changelog] - New field `MagicCode` in struct `EmailChannelProperties` info [Changelog] - New field `CallingWebhook` in struct `MsTeamsChannelProperties` info [Changelog] - New field `GroupIDs` in struct `PrivateEndpointConnectionProperties` info [Changelog] - New field `AppID` in struct `Site` info [Changelog] - New field `IsDetailedLoggingEnabled` in struct `Site` info [Changelog] - New field `IsEndpointParametersEnabled` in struct `Site` info [Changelog] - New field `IsNoStorageEnabled` in struct `Site` info [Changelog] - New field `IsWebChatSpeechEnabled` in struct `Site` info [Changelog] - New field `TenantID` in struct `Site` info [Changelog] - New field `AppID` in struct `WebChatSite` info [Changelog] - New field `ETag` in struct `WebChatSite` info [Changelog] - New field `IsBlockUserUploadEnabled` in struct `WebChatSite` info [Changelog] - New field `IsDetailedLoggingEnabled` in struct `WebChatSite` info [Changelog] - New field `IsEndpointParametersEnabled` in struct `WebChatSite` info [Changelog] - New field `IsNoStorageEnabled` in struct `WebChatSite` info [Changelog] - New field `IsSecureSiteEnabled` in struct `WebChatSite` info [Changelog] - New field `IsTokenEnabled` in struct `WebChatSite` info [Changelog] - New field `IsV1Enabled` in struct `WebChatSite` info [Changelog] - New field `IsV3Enabled` in struct `WebChatSite` info [Changelog] - New field `IsWebChatSpeechEnabled` in struct `WebChatSite` info [Changelog] - New field `TenantID` in struct `WebChatSite` info [Changelog] - New field `TrustedOrigins` in struct `WebChatSite` info [Changelog] info [Changelog] Total 2 breaking change(s), 47 additive change(s).
️⚠️ azure-resource-manager-schemas warning [Detail]
⚠️Warning [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. Schema Automation 14.0.0command .sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json cmderr [initScript.sh] WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm, cmderr [initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry. cmderr [initScript.sh] npm WARN old lockfile cmderr [initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient... cmderr [initScript.sh] npm WARN old lockfile warn File azure-resource-manager-schemas_tmp/initOutput.json not found to read command .sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
️✔️botservice [View full logs] [Preview Schema Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
️✔️@azure/arm-botservice [View full logs] [Preview SDK Changes]info [Changelog] error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from 1264d3d873df397022056f88573de255b34938e3. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
❌Az.botservice [View full logs] [Preview SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/botservice/armbotservice | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| .Net | Azure.ResourceManager.BotService | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| JavaScript | @azure/arm-botservice | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
Hi @thatChang, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.
Hi @thatChang, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
"x-nullable": true
is this a secret ? Should it have x-ms secret ?
Refers to: specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json:2753 in fea3625. [](commit_id = fea362581836bd57e58a743fce1c2d2b6ec067e1, deletion_comment = False)
It's not secret. The content will return at response.
"description": "Direct Line embed code of the resource"
update descriptions please
Refers to: specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json:2772 in fea3625. [](commit_id = fea362581836bd57e58a743fce1c2d2b6ec067e1, deletion_comment = False)
Done
"description": "Direct Line embed code of the resource"
consider using enums instead of booleans as explained here :
https://armwiki.azurewebsites.net/rp_onboarding/process/api_review_best_practices.html#common-issues-found-in-review Replace boolean/switch properties with better enum A Boolean will forever have two valid values (true or false). A string enum type is always preferred. Also, properties should always provide better values just than True and False. For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType]. Even if you still believe [True, False] are the correct values for a property, you should use a string enum with values [True, False] instead of boolean. Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [True, False, Unknown].
Refers to: specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json:2772 in fea3625. [](commit_id = fea362581836bd57e58a743fce1c2d2b6ec067e1, deletion_comment = False)
In current stage we could't make this enum. Will add to team agenda
"default": false
can this be enum ?
Refers to: specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json:2909 in fea3625. [](commit_id = fea362581836bd57e58a743fce1c2d2b6ec067e1, deletion_comment = False)
In current stage we could't make this enum.
"x-nullable": true
x-ms-secret ?
Refers to: specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json:2968 in fea3625. [](commit_id = fea362581836bd57e58a743fce1c2d2b6ec067e1, deletion_comment = False)
It will appear at response. Not a secret.
"x-nullable": true
use enums where applicable instead of string
Refers to: specification/botservice/resource-manager/Microsoft.BotService/stable/2022-09-15/botservice.json:2998 in fea3625. [](commit_id = fea362581836bd57e58a743fce1c2d2b6ec067e1, deletion_comment = False)
This is a third-party resource. The type is completely managed by the third party, which means they could change the possible value without notification at any time. We could not pre-define the type but need to follow their update. String provides such convenient.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
Hi, @thatChang. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Hi, @thatChang, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline
@thatChang - Couple of things:
- This PR has been off of ARM review's radar because you didn't remove the ARMChangesRequested label (comment here; https://github.com/Azure/azure-rest-api-specs/pull/20803#issuecomment-1273856308). Please remove the label in future to facilitate ARM review.
- New API version PRs must have a base commit that includes all files from the current API version so reviewers can see what's getting changed. Can you submit a new PR that starts with current swagger files (copied unchanged to the new API version folder) and adds changes for the new API version in subsequent commits?
- It's not recommended to update existing API versions with new stuff from the new API version. It's recommended that customers needing the new stuff move to the new API version. Can you explain why you want to add new properties and other changes back to 3 older API versions?
I've re-reviewed the breaking changes report and while there appear to be a few new issues reported these all appear to be benign.
@thatChang - I didn't see any response to my comments: https://github.com/Azure/azure-rest-api-specs/pull/20803#issuecomment-1370277643. Note, at minimum before your new API can be reviewed by ARM you will need to provide a PR that has the correct base commit for the new API being added.
@mentat9 I have a new PR https://github.com/Azure/azure-rest-api-specs/pull/22077 with the base required. For the reason why the old versions were edited. It's because S360 reports issues from multiple versions, including new and old ones. To resolve the issues, we have to do so. The S360 issues were detected from live site requests, we cannot control what version to be used by customer but update anything involved. However, we are continuing working on reduce usage of old version.
@mentat9 I have a new PR #22077 with the base required. For the reason why the old versions were edited. It's because S360 reports issues from multiple versions, including new and old ones. To resolve the issues, we have to do so. The S360 issues were detected from live site requests, we cannot control what version to be used by customer but update anything involved. However, we are continuing working on reduce usage of old version.
Thank-you @thatChang - I will follow up on that PR.