Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

new bot properties openWithHint and appPasswordHint #15456

Merged
merged 2 commits into from
Oct 9, 2021

Conversation

hailiu2586
Copy link
Member

@hailiu2586 hailiu2586 commented Jul 30, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. 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
  2. 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.
    2021-08
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    2021-08
  4. If updating an existing version, please select the specific langauge SDKs and CLIs that must be refreshed after the 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 refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

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

Only Adding new properties , below is NA.

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit (including refactoring) and then push new changes, including version updates, in separate commits.
  • 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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
Copy link

Hi, @hailiu2586 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-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 30, 2021

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
    Rule Message
    1045 - AddedOptionalProperty The new version has a new optional property 'openWithHint' that was not found in the old version.
    New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1535:7
    Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1535:7
    1045 - AddedOptionalProperty The new version has a new optional property 'appPasswordHint' that was not found in the old version.
    New: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1535:7
    Old: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1535:7
    1045 - AddedOptionalProperty The new version has a new optional property 'openWithHint' that was not found in the old version.
    New: Microsoft.BotService/stable/2021-03-01/botservice.json#L1259:7
    Old: Microsoft.BotService/stable/2021-03-01/botservice.json#L1259:7
    1045 - AddedOptionalProperty The new version has a new optional property 'appPasswordHint' that was not found in the old version.
    New: Microsoft.BotService/stable/2021-03-01/botservice.json#L1259:7
    Old: Microsoft.BotService/stable/2021-03-01/botservice.json#L1259:7
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    R4018 - OperationsApiResponseSchema 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#L742
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.BotService/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.BotService/stable/2021-03-01/botservice.json#L742
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1423
    R4037 - MissingTypeObject The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1467
    R4037 - MissingTypeObject The schema 'BotProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1534
    R4037 - MissingTypeObject The schema 'BotResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1665
    R4037 - MissingTypeObject The schema 'AlexaChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1727
    R4037 - MissingTypeObject The schema 'FacebookChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1770
    R4037 - MissingTypeObject The schema 'FacebookPage' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1810
    R4037 - MissingTypeObject The schema 'EmailChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1843
    R4037 - MissingTypeObject The schema 'MsTeamsChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1880
    R4037 - MissingTypeObject The schema 'SkypeChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1916
    R4037 - MissingTypeObject The schema 'KikChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L1976
    R4037 - MissingTypeObject The schema 'WebChatChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2017
    R4037 - MissingTypeObject The schema 'DirectLineChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2053
    R4037 - MissingTypeObject The schema 'TelegramChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2081
    R4037 - MissingTypeObject The schema 'SmsChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2118
    R4037 - MissingTypeObject The schema 'SlackChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2165
    R4037 - MissingTypeObject The schema 'LineChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2240
    R4037 - MissingTypeObject The schema 'LineRegistration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2265
    R4037 - MissingTypeObject The schema 'DirectLineSpeechChannelProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2304
    R4037 - MissingTypeObject The schema 'ChannelResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2338
    R4037 - MissingTypeObject The schema 'WebChatSite' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2355
    R4037 - MissingTypeObject The schema 'DirectLineSite' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2401
    R4037 - MissingTypeObject The schema 'ConnectionItemName' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2489
    R4037 - MissingTypeObject The schema 'ConnectionSettingParameter' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2499
    R4037 - MissingTypeObject The schema 'ConnectionSettingProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2512
    R4037 - MissingTypeObject The schema 'ConnectionSettingResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2565
    R4037 - MissingTypeObject The schema 'ServiceProviderResponseList' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2582
    R4037 - MissingTypeObject The schema 'ServiceProviderParameter' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.BotService/preview/2021-05-01-preview/botservice.json#L2599
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 30, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - botservice/mgmt/2021-03-01/botservice - v58.0.0
    ️✔️azure-sdk-for-go - preview/botservice/mgmt/2018-07-12/botservice - v58.0.0
    ️✔️azure-sdk-for-go - preview/botservice/mgmt/2017-12-01/botservice - v58.0.0
    azure-sdk-for-python-track2 - track2_azure-mgmt-botservice - 1.0.0
    ️❌ azure-sdk-for-net failed [Detail]
    • Failed [Logs]Release - Generate from c2da2d5. 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] /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]      2>/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      cmdout	[msbuild]          /home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Generated/OperationResultsOperations.cs(28,100): error CS0535: 'OperationResultsOperations' does not implement interface member 'IOperationResultsOperations.GetWithHttpMessagesAsync(string, Dictionary<string, List<string>>, CancellationToken)' [/home/vsts/work/1/s/azure-sdk-for-net/sdk/botservice/Microsoft.Azure.Management.BotService/src/Microsoft.Azure.Management.BotService.csproj]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-net]: dotnet
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c2da2d5. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] opencensus-ext-azure 1.1.0 requires azure-core<2.0.0,>=1.12.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      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
    • ️✔️azure-mgmt-botservice [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model BotProperties has a new parameter msa_app_msi_resource_id
      info	[Changelog]   - Model BotProperties has a new parameter disable_local_auth
      info	[Changelog]   - Model BotProperties has a new parameter app_password_hint
      info	[Changelog]   - Model BotProperties has a new parameter is_isolated
      info	[Changelog]   - Model BotProperties has a new parameter private_endpoint_connections
      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 schema_transformation_version
      info	[Changelog]   - Model BotProperties has a new parameter msa_app_tenant_id
      info	[Changelog]   - Model SlackChannelProperties has a new parameter scopes
      info	[Changelog]   - Added operation group PrivateEndpointConnectionsOperations
      info	[Changelog]   - Added operation group OperationResultsOperations
      info	[Changelog]   - Added operation group PrivateLinkResourcesOperations
      info	[Changelog]   - Added operation group HostSettingsOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_id
      info	[Changelog]   - Model DirectLineSpeechChannelProperties has a new required parameter cognitive_service_region
      info	[Changelog]   - Model DirectLineSpeechChannelProperties has a new required parameter cognitive_service_subscription_key
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c2da2d5. SDK Automation 14.0.0
      command	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
    • ️✔️track2_azure-mgmt-botservice [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model BotProperties has a new parameter msa_app_msi_resource_id
      info	[Changelog]   - Model BotProperties has a new parameter disable_local_auth
      info	[Changelog]   - Model BotProperties has a new parameter app_password_hint
      info	[Changelog]   - Model BotProperties has a new parameter msa_app_tenant_id
      info	[Changelog]   - Model BotProperties has a new parameter open_with_hint
      info	[Changelog]   - Model BotProperties has a new parameter private_endpoint_connections
      info	[Changelog]   - Model BotProperties has a new parameter msa_app_type
      info	[Changelog]   - Model SlackChannelProperties has a new parameter scopes
      info	[Changelog]   - Added operation group PrivateEndpointConnectionsOperations
      info	[Changelog]   - Added operation group PrivateLinkResourcesOperations
      info	[Changelog]   - Added operation group OperationResultsOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model DirectLineSpeechChannelProperties no longer has parameter cognitive_services_subscription_id
      info	[Changelog]   - Model DirectLineSpeechChannelProperties has a new required parameter cognitive_service_subscription_key
      info	[Changelog]   - Model DirectLineSpeechChannelProperties has a new required parameter cognitive_service_region
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2da2d5. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️botservice/mgmt/2021-03-01/botservice [View full logs]  [Release SDK Changes]
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New field `AppPasswordHint` in struct `BotProperties`
      info	[Changelog] - New field `OpenWithHint` in struct `BotProperties`
      info	[Changelog]
      info	[Changelog] Total 0 breaking change(s), 1 additive change(s).
      info	[Changelog]
    • ️✔️preview/botservice/mgmt/2018-07-12/botservice [View full logs
      info	[Changelog] No exported changes
    • ️✔️preview/botservice/mgmt/2017-12-01/botservice [View full logs
      info	[Changelog] No exported changes
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from c2da2d5. Schema Automation 14.0.0
      command	.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]  [Release Schema Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from c2da2d5. 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.7.0 --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]
      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 426ms
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    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.

    @zhenglaizhang
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @swagatmishra2007
    Copy link
    Contributor

    @hailiu2586 please update the latest version of the swagger (221-5-01-preview) with these properties too, since that will be GA'ed into a release version in a few weeks

    @swagatmishra2007 swagatmishra2007 added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 3, 2021
    @ghost
    Copy link

    ghost commented Aug 22, 2021

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

    @ghost ghost added the no-recent-activity label Aug 22, 2021
    @filizt
    Copy link
    Contributor

    filizt commented Sep 1, 2021

    This PR would require breaking changes approval or a new API version. Please see breaking changes task for failure details and this link for breaking changes process: https://microsoft.sharepoint.com/teams/azureecosystem/servicerings/Shared%20Documents/Breaking%20Changes/Azure%20Breaking%20Changes%20Program%20Definition-%20V1.2.pdf

    @ghost ghost removed the no-recent-activity label Sep 1, 2021
    @openapi-workflow-bot
    Copy link

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

    @weidongxu-microsoft
    Copy link
    Member

    Service requested for breaking changes review.

    @chiragg4u
    Copy link
    Contributor

    Please go through the contribution checklist added as part of the review and mark them completed. It will help you fix most of the issues and improve the quality of swagger and help close the PR faster. This is a requirement before review can be continued.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Sep 20, 2021
    @weidongxu-microsoft
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Copy link
    Member

    @weidongxu-microsoft weidongxu-microsoft left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    @chiragg4u
    As Jeffrey approved the breaking changes, you might want to revisit the PR.

    Personally I am not really sure about the meaning of openWithHint and appPasswordHint (how this relates to keyVault secret resourceId?)

    @luhan2017
    Copy link
    Contributor

    @chiragg4u As Jeffrey approved the breaking changes, you might want to revisit the PR.

    Personally I am not really sure about the meaning of openWithHint and appPasswordHint (how this relates to keyVault secret resourceId?)

    @weidongxu-microsoft , those two fields are optional parameters for a bot service, when those two fields are set, the bot service will have an extra link shown as following. I see there are still two checks failing, any idea how we can fix this and proceed?

    image

    @weidongxu-microsoft weidongxu-microsoft merged commit c2da2d5 into Azure:main Oct 9, 2021
    @weidongxu-microsoft weidongxu-microsoft removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Oct 9, 2021
    jovannikolov-msft pushed a commit to jovannikolov-msft/azure-rest-api-specs that referenced this pull request Dec 1, 2021
    * new bot properties openWithHint and appPasswordHint
    
    * add new properties to 2021-05-01-preview as well
    LeiWang3 pushed a commit to LeiWang3/azure-rest-api-specs that referenced this pull request Mar 31, 2022
    * new bot properties openWithHint and appPasswordHint
    
    * add new properties to 2021-05-01-preview as well
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Python
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    8 participants