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

ssss141414 · 2021-01-14T15:10:48Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
- SDK of .NET (need service team to ensure code readiness)
- SDK of Python
- SDK of Java
- SDK of Js
- SDK of Go
- PowerShell
- CLI
- Terraform
- No, no need to refresh for updates in this PR

Contribution checklist:

I commit to follow the Breaking Change Policy of “no breaking changes
I have reviewed the documentation for the workflow.
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

Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
- Adding new API(s)
- Adding a new API version
- Adding a new service
Please 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 there are following updates in the PR, ensure to request an approval from API Review Board as defined in the Breaking Change Policy.

Removing API(s) in stable version
Removing properties in stable version
Removing API version(s) in stable version
Updating API in stable version with Breaking Change Validation errors
Updating API(s) in preview over 1 year

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.

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2021-01-14T15:10:52Z

Hi, @ssss141414 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com

openapi-pipeline-app · 2021-01-14T15:10:53Z

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]

Compared Swaggers (Based on Oad v0.8.5)
- original: stable/2020-06-02/botservice.json <---> new: stable/2020-06-02/botservice.json

Rule	Message
`❌` 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}/listWithSecrets' removed or restructured? New: azure-rest-api-specs/blob/3679452a5db7ceb6d19450e7679a700244ae668c/ Old: Microsoft.BotService/stable/2020-06-02/botservice.json#L809:5
`❌` 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}' removed or restructured? New: azure-rest-api-specs/blob/3679452a5db7ceb6d19450e7679a700244ae668c/ Old: Microsoft.BotService/stable/2020-06-02/botservice.json#L854:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.BotService/stable/2020-06-02/botservice.json#L809:5
`❌` 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Microsoft.BotService/stable/2020-06-02/botservice.json#L854:5

️⚠️LintDiff: 4 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- botservice/resource-manager/readme.md tag:package-2020-06-02
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- botservice/resource-manager/readme.md tag:package-2020-06-02

Rule	Message
⚠️ R3010 - TrackedResourceListByImmediateParent	The child tracked resource, 'connections' with immediate parent 'Bot', must have a list by immediate parent operation. New: Microsoft.BotService/stable/2020-06-02/botservice.json#L1104
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update Connection Setting New: Microsoft.BotService/stable/2020-06-02/botservice.json#L919
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update Connection Setting New: Microsoft.BotService/stable/2020-06-02/botservice.json#L975
⚠️ R4030 - UniqueXmsExample	Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Update Connection Setting New: Microsoft.BotService/stable/2020-06-02/botservice.json#L1020

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2021-01-14T15:10:54Z

Swagger Generation Artifacts

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4ac3bbf. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/botservice/resource-manager/readme.md

️✔️@azure/arm-botservice [View full logs] [Release SDK Changes]

azure-arm-botservice-2.0.0.tgz

cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/azureBotService.js → ./dist/arm-botservice.js...
cmderr	[npmPack] created ./dist/arm-botservice.js in 336ms

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4ac3bbf. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️preview/botservice/mgmt/2018-07-12/botservice [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/botservice/mgmt/2017-12-01/botservice [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4ac3bbf. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6351 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/botservice/resource-manager/readme.md

️✔️botservice [View full logs] [Release Schema Changes]

cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
cmderr	[resource-manager]  ERR! code ELIFECYCLE
cmderr	[resource-manager] npm ERR! errno 3
cmderr	[resource-manager] ERR! template-schema-validation-tools@1.0.0 test: `mocha -r ts-node/register tests.ts`
cmderr	[resource-manager] npm ERR! Exit status 3
cmderr	[resource-manager] npm ERR!
cmderr	[resource-manager] npm ERR! Failed at the template-schema-validation-tools@1.0.0 test script.
cmderr	[resource-manager] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
cmderr	[resource-manager]  A complete log of this run can be found in:
cmderr	[resource-manager] npm ERR!     /home/vsts/.npm/_logs/2021-01-19T08_06_23_845Z-debug.log
cmderr	[resource-manager] Error: Command failed: npm run test --prefix tools
cmderr	[resource-manager]     at checkExecSyncError (child_process.js:635:11)
cmderr	[resource-manager]     at Object.execSync (child_process.js:671:15)
cmderr	[resource-manager]     at Object.<anonymous> (/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas/sdkauto_afterscript.js:13:28)
cmderr	[resource-manager]     at Module._compile (internal/modules/cjs/loader.js:999:30)
cmderr	[resource-manager]     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
cmderr	[resource-manager]     at Module.load (internal/modules/cjs/loader.js:863:32)
cmderr	[resource-manager]     at Function.Module._load (internal/modules/cjs/loader.js:708:14)
cmderr	[resource-manager]     at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:60:12)
cmderr	[resource-manager]     at internal/main/run_main_module.js:17:47 {
cmderr	[resource-manager]   status: 3,
cmderr	[resource-manager]   signal: null,
cmderr	[resource-manager]   output: [ null, null, null ],
cmderr	[resource-manager]   pid: 3080,
cmderr	[resource-manager]   stdout: null,
cmderr	[resource-manager]   stderr: null
cmderr	[resource-manager] }

️️✔️ azure-sdk-for-python succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4ac3bbf. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	python3 -m venv venv
command	pip install --upgrade setuptools wheel pip
command	pip install pathlib jinja2 msrestazure
command	autorest --version=V2 --use=@microsoft.azure/autorest.python@~4.0.71 --python --python-mode=update --multiapi --keep-version-file --no-async --python-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-python/sdk ../azure-rest-api-specs/specification/botservice/resource-manager/readme.md

️✔️azure-mgmt-botservice [View full logs] [Release SDK Changes] Breaking Change Detected

cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-botservice
cmderr	[buildConf] INFO:packaging_tools.conf:Skipping default conf since the file exists
cmderr	[buildConf] INFO:packaging_tools:Skipping CHANGELOG.md template, since a previous one was found
cmderr	[buildConf] INFO:packaging_tools:Template done azure-mgmt-botservice
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.botservice
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.botservice
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.botservice
cmderr	[changelogReport] INFO:__main__:Report written to sdk/botservice/azure-mgmt-botservice/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-botservice on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0', '1.0.0b1']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 0.2.0 of azure-mgmt-botservice in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.botservice
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.botservice
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.botservice
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/botservice/azure-mgmt-botservice/code_reports/0.2.0/report.json
cmdout	[Changelog] Size of delta 22.787% size of original (original: 32247 chars, delta: 7348 chars)
cmdout	[Changelog] **Features**
cmdout	[Changelog]   - Model SlackChannelProperties has a new parameter signing_secret
cmdout	[Changelog]   - Model BotProperties has a new parameter is_cmek_enabled
cmdout	[Changelog]   - Model BotProperties has a new parameter cmek_key_vault_url
cmdout	[Changelog]   - Added operation group DirectLineOperations
cmdout	[Changelog] **Breaking changes**
cmdout	[Changelog]   - Removed operation group EnterpriseChannelsOperations
warn	Breaking change found in changelog

️❌ azure-sdk-for-net failed [Detail]

❌Failed [Logs]Release - Generate from 4ac3bbf. SDK Automation 14.0.0

warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/botservice/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied

❌Microsoft.Azure.Management.BotService [View full logs] [Release SDK Changes]

cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Tests/BotServiceTests.cs(51,99): error CS1503: Argument 2: cannot convert from 'string' to 'bool' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Microsoft.Azure.Management.BotService.Tests.csproj]
cmdout	[msbuild]      3>/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Tests/BotServiceTests.cs(51,115): error CS1503: Argument 3: cannot convert from 'bool' to 'string' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Microsoft.Azure.Management.BotService.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Tests/BotServiceTests.cs(51,99): error CS1503: Argument 2: cannot convert from 'string' to 'bool' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Microsoft.Azure.Management.BotService.Tests.csproj]
cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Tests/BotServiceTests.cs(51,115): error CS1503: Argument 3: cannot convert from 'bool' to 'string' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/tests/Microsoft.Azure.Management.BotService.Tests.csproj]
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet

️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-workflow-bot · 2021-01-14T15:13:51Z

Hi @ssss141414, 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.

openapi-workflow-bot · 2021-01-14T15:13:51Z

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.

openapi-workflow-bot · 2021-01-14T15:15:11Z

Hi @ssss141414, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

…n stable/2020-06-02 (Azure#12433) * fix live validation * remove R4010 * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress * suppress

fix live validation

51fba5d

openapi-assignment-bot bot assigned chunyu3 Jan 14, 2021

openapi-pipeline-app bot added BreakingChangeReviewRequired labels Jan 14, 2021

openapi-sdkautomation bot mentioned this pull request Jan 14, 2021

[AutoPR @azure/arm-botservice] [Hub Generated] Review request for Microsoft.BotService to add version stable/2020-06-02 AzureSDKAutomation/azure-sdk-for-js#3225

Closed

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 14, 2021

openapi-pipeline-app bot added the CI-BreakingChange-Python label Jan 14, 2021

openapi-sdkautomation bot mentioned this pull request Jan 14, 2021

[AutoPR Microsoft.Azure.Management.BotService] [Hub Generated] Review request for Microsoft.BotService to add version stable/2020-06-02 AzureSDKAutomation/azure-sdk-for-net#2878

Closed

remove R4010

559e8e0

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 15, 2021

JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 18, 2021

JeffreyRichter approved these changes Jan 18, 2021

View reviewed changes

suppress

96247f5

ssss141414 requested a review from lirenhe as a code owner January 19, 2021 03:15