azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Azure Health Bot - New API 2022-08-08 - Secrets management using ARM
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
- [ ] 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. September 2022
- When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. September 2022
- If updating an existing version, please select the specific language 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:
- [x] 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 appy 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 -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. 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 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.
Hi, @guy-microsoft 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}
Swagger Validation Report
️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 36 Warnings warning [Detail]
| compared swaggers (via Oad v0.9.7)] | new version | base version |
|---|---|---|
| healthbot.json | 2022-08-08(ac6cf21) | 2021-08-24(main) |
| healthbot.json | 2022-08-08(ac6cf21) | 2020-12-08-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-08-08 | package-2022-08-08(ac6cf21) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| :warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L640 |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| :warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L606 |
| :warning: R2001 - AvoidNestedProperties | Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L862 |
| :warning: R3018 - EnumInsteadOfBoolean | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L850 |
| :warning: R4006 - DeprecatedXmsCodeGenerationSetting | The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L7 |
| :warning: R4021 - DescriptionAndTitleMissing | 'location' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.HealthBot/stable/2022-08-08/healthbot.json#L664 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ApiReadinessCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"code: InvalidResourceType, message: The resource type 'Operations' could not be found in the namespace 'Microsoft.HealthBot' for api version '2022-08-08'. The supported api-versions are '2020-12-08, 2021-08-24'." |
️❌~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"ResourceType 'healthBots' should be deployed in 'West Central US' on apiVersion '2022-08-08'.: expected [ Array(4) ] to satisfy [Function]" |
️❌~[Staging] TrafficValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
"ResourceType 'healthBots' should be deployed in 'West Central US' on apiVersion '2022-08-08'.: expected [ Array(4) ] to satisfy [Function]" |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
- "https://github.com/Azure/azure-rest-api-specs/blob/ac6cf21556da0dd413b7cdd81d0d3d923351656c/specification/healthbot/resource-manager/readme.md#tag-package-2022-08-08">healthbot/resource-manager/readme.md#package-2022-08-08
| Rule | Message |
|---|---|
| :warning: UnkownSecurityScheme | "readme":"healthbot/resource-manager/readme.md", "tag":"package-2022-08-08", "details":"Security scheme azure_auth is unknown and will not be processed. Only supported types are AADToken, AzureKey, Anonymous" |
️️✔️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.
![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 inProgress [Detail]
️❌SDK Breaking Change Tracking failed [Detail]
Breaking Changes Tracking
❌azure-sdk-for-python-track2 - track2_azure-mgmt-healthbot - Approved - 1.0.0b1+ Client name is changed from `Healthbot` to `HealthBotMgmtClient`
️⚠️ azure-sdk-for-python-track2 warning [Detail]
⚠️Warning [Logs]Release - Generate from e88242fc7da7860d36ab4a1700e3404a51d53eeb. 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] npm notice cmderr [automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice
️✔️track2_azure-mgmt-healthbot [View full logs] [Release SDK Changes] Breaking Change Detectedinfo [Changelog] ### Features Added info [Changelog] info [Changelog] - Added operation BotsOperations.list_secrets info [Changelog] - Added operation BotsOperations.regenerate_api_jwt_secret info [Changelog] - Model HealthBot has a new parameter identity info [Changelog] - Model HealthBotProperties has a new parameter key_vault_properties info [Changelog] - Model HealthBotUpdateParameters has a new parameter identity info [Changelog] - Model HealthBotUpdateParameters has a new parameter location info [Changelog] - Model HealthBotUpdateParameters has a new parameter properties info [Changelog] info [Changelog] ### Breaking Changes info [Changelog] info [Changelog] - Client name is changed from `Healthbot` to `HealthBotMgmtClient`
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from e88242fc7da7860d36ab4a1700e3404a51d53eeb. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
️✔️azure-resourcemanager-healthbot [View full logs] [Release SDK Changes]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from e88242fc7da7860d36ab4a1700e3404a51d53eeb. 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-healthbot [View full logs] [Release SDK Changes]info [Changelog] **Features** info [Changelog] info [Changelog] - Added operation Bots.listSecrets info [Changelog] - Added operation Bots.regenerateApiJwtSecret info [Changelog] - Added Interface BotsListSecretsOptionalParams info [Changelog] - Added Interface BotsRegenerateApiJwtSecretOptionalParams info [Changelog] - Added Interface HealthBot info [Changelog] - Added Interface HealthBotKey info [Changelog] - Added Interface HealthBotKeysResponse info [Changelog] - Added Interface KeyVaultProperties info [Changelog] - Added Interface TrackedResource info [Changelog] - Added Type Alias BotsListSecretsResponse info [Changelog] - Added Type Alias BotsRegenerateApiJwtSecretResponse info [Changelog] - Interface HealthBotProperties has a new optional parameter keyVaultProperties info [Changelog] - Interface HealthBotUpdateParameters has a new optional parameter properties error breakingChangeTracking is enabled, but version or changelogItem is not found in output.
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from e88242fc7da7860d36ab4a1700e3404a51d53eeb. 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/healthbot/armhealthbot [View full logs] [Release SDK Changes]info [Changelog] ### Features Added info [Changelog] info [Changelog] - New function `*BotsClient.ListSecrets(context.Context, string, string, *BotsClientListSecretsOptions) (BotsClientListSecretsResponse, error)` info [Changelog] - New function `*BotsClient.RegenerateAPIJwtSecret(context.Context, string, string, *BotsClientRegenerateAPIJwtSecretOptions) (BotsClientRegenerateAPIJwtSecretResponse, error)` info [Changelog] - New struct `BotsClientListSecretsOptions` info [Changelog] - New struct `BotsClientListSecretsResponse` info [Changelog] - New struct `BotsClientRegenerateAPIJwtSecretOptions` info [Changelog] - New struct `BotsClientRegenerateAPIJwtSecretResponse` info [Changelog] - New struct `Key` info [Changelog] - New struct `KeyVaultProperties` info [Changelog] - New struct `KeysResponse` info [Changelog] - New field `KeyVaultProperties` in struct `Properties` info [Changelog] - New field `Properties` in struct `UpdateParameters` info [Changelog] info [Changelog] Total 0 breaking change(s), 18 additive change(s).
️️✔️ azure-powershell succeeded [Detail] [Expand]
️✔️Succeeded [Logs]Release - Generate from e88242fc7da7860d36ab4a1700e3404a51d53eeb. 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.Healthbot [View full logs] [Release SDK Changes]
Generated ApiView
| Language | Package Name | ApiView Link |
|---|---|---|
| Go | sdk/resourcemanager/healthbot/armhealthbot | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Python | track2_azure-mgmt-healthbot | Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI. |
| Java | azure-resourcemanager-healthbot | 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-healthbot | 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, @guy-microsoft your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]).
Hi @guy-microsoft, 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 |
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
