Update swagger with new properties #11901

giladsu · 2020-12-02T12:36:46Z

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

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-pipeline-app · 2020-12-02T12:36:50Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.8.1)
- original: preview/2020-08-04-preview/ResourceHealthAlertRules.json <---> new: preview/2020-08-04-preview/ResourceHealthAlertRules.json

Rule	Message
`❌` 1020 - AddedEnumValue	The new version is adding enum value(s) 'GuestVmHealth' from the old version. New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L457:9 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L457:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L525:9 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L507:9
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L525:9 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L507:9
`❌` 1026 - TypeChanged	The new version has a different type 'integer' than the previous one 'string'. New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L525:9 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L507:9
`❌` 1026 - TypeChanged	The new version has a different type 'integer' than the previous one 'string'. New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L525:9 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L507:9
`❌` 1033 - RemovedProperty	The new version is missing a property found in the old version. Was 'healthMonitorName' renamed or removed? New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L482:7 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L482:7
`❌` 1034 - AddedRequiredProperty	The new version has new required property 'healthStates' that was not found in the old version. New: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L474:5 Old: Microsoft.AlertsManagement/preview/2020-08-04-preview/ResourceHealthAlertRules.json#L474:5

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

Linted configuring files (Based on source branch, openapi-validator v1.5.0 , classic-openapi-validator v1.1.4 )
- alertsmanagement/resource-manager/readme.md tag:package-2020-08-04-preview
Linted configuring files (Based on target branch, openapi-validator v1.5.0 , classic-openapi-validator v1.1.4 )
- alertsmanagement/resource-manager/readme.md tag:package-2020-08-04-preview

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/alertsmanagement/resource-manager/readme.md tag: specification/alertsmanagement/resource-manager/readme.md#tag-package-2019-06-preview

️️✔️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.

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

openapi-pipeline-app · 2020-12-02T12:36:51Z

Swagger Generation Artifacts

️⚠️ azure-sdk-for-net warning [Detail]

⚠️Warning [Logs]Release - Generate from f2af6b1. 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/alertsmanagement/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.AlertsManagement [View full logs] [Release SDK Changes]
- Microsoft.Azure.Management.AlertsManagement.0.9.2-preview.nupkg
- Microsoft.Azure.Management.AlertsManagement.0.9.2-preview.snupkg

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

️✔️Succeeded [Logs]Release - Generate from f2af6b1. 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/alertsmanagement/resource-manager/readme.md

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

cmderr	[buildConf] INFO:packaging_tools:Building template azure-mgmt-alertsmanagement
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-alertsmanagement
cmderr	[changelogSetup] WARNING: Skipping azure-nspkg as it is not installed.
cmderr	[changelogReport] INFO:__main__:Looking for Autorest generated package in azure.mgmt.alertsmanagement
cmderr	[changelogReport] INFO:__main__:Found azure.mgmt.alertsmanagement
cmderr	[changelogReport] INFO:__main__:Working on azure.mgmt.alertsmanagement
cmderr	[changelogReport] INFO:__main__:Report written to sdk/alertsmanagement/azure-mgmt-alertsmanagement/code_reports/latest/report.json
cmderr	[changelogReportLatest] INFO:__main__:Download versions of azure-mgmt-alertsmanagement on PyPI
cmderr	[changelogReportLatest] INFO:__main__:Got ['0.1.0', '0.2.0rc1', '0.2.0rc2', '1.0.0b1']
cmderr	[changelogReportLatest] INFO:__main__:Only keep last PyPI version
cmderr	[changelogReportLatest] INFO:__main__:Installing version 1.0.0b1 of azure-mgmt-alertsmanagement in a venv
cmderr	[changelogReportLatest] Cache entry deserialization failed, entry ignored
cmderr	[changelogReportLatest] INFO:__main__:Looking for Autorest generated package in azure.mgmt.alertsmanagement
cmderr	[changelogReportLatest] INFO:__main__:Found azure.mgmt.alertsmanagement
cmderr	[changelogReportLatest] INFO:__main__:Working on azure.mgmt.alertsmanagement
cmderr	[changelogReportLatest] INFO:__main__:Report written to sdk/alertsmanagement/azure-mgmt-alertsmanagement/code_reports/1.0.0b1/report.json
cmdout	[Changelog] Size of delta 20.708% size of original (original: 35165 chars, delta: 7282 chars)
cmdout	[Changelog] **Breaking changes**
cmdout	[Changelog]   - Parameter action_groups of model AlertRule is now required
cmdout	[Changelog]   - Parameter scope of model AlertRule is now required
cmdout	[Changelog]   - Parameter severity of model AlertRule is now required
cmdout	[Changelog]   - Parameter state of model AlertRule is now required
cmdout	[Changelog]   - Parameter frequency of model AlertRule is now required
cmdout	[Changelog]   - Parameter detector of model AlertRule is now required
cmdout	[Changelog]   - Operation SmartGroupsOperations.get_history has a new signature
cmdout	[Changelog]   - Operation SmartGroupsOperations.get_by_id has a new signature
cmdout	[Changelog]   - Operation SmartGroupsOperations.get_all has a new signature
cmdout	[Changelog]   - Operation SmartGroupsOperations.change_state has a new signature
cmdout	[Changelog]   - Operation SmartDetectorAlertRulesOperations.patch has a new signature
cmdout	[Changelog]   - Operation SmartDetectorAlertRulesOperations.list_by_resource_group has a new signature
cmdout	[Changelog]   - Operation SmartDetectorAlertRulesOperations.list has a new signature
cmdout	[Changelog]   - Operation SmartDetectorAlertRulesOperations.get has a new signature
cmdout	[Changelog]   - Operation SmartDetectorAlertRulesOperations.delete has a new signature
cmdout	[Changelog]   - Operation SmartDetectorAlertRulesOperations.create_or_update has a new signature
cmdout	[Changelog]   - Operation AlertsOperations.get_summary has a new signature
cmdout	[Changelog]   - Operation AlertsOperations.get_history has a new signature
cmdout	[Changelog]   - Operation AlertsOperations.get_by_id has a new signature
cmdout	[Changelog]   - Operation AlertsOperations.get_all has a new signature
cmdout	[Changelog]   - Operation AlertsOperations.change_state has a new signature
cmdout	[Changelog]   - Operation ActionRulesOperations.list_by_subscription has a new signature
cmdout	[Changelog]   - Operation ActionRulesOperations.list_by_resource_group has a new signature
cmdout	[Changelog]   - Operation ActionRulesOperations.get_by_name has a new signature
cmdout	[Changelog]   - Operation ActionRulesOperations.delete has a new signature
cmdout	[Changelog]   - Operation ActionRulesOperations.create_update has a new signature
cmdout	[Changelog]   - Operation Operations.list has a new signature
cmdout	[Changelog]   - Operation AlertsOperations.meta_data has a new signature
cmdout	[Changelog]   - Operation ActionRulesOperations.update has a new signature
warn	Breaking change found in changelog

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

️✔️Succeeded [Logs]Release - Generate from f2af6b1. 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/alertsmanagement/mgmt/2019-06-01-preview/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/alertsmanagement/mgmt/2019-05-05-preview/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️alertsmanagement/mgmt/2019-03-01/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️preview/alertsmanagement/mgmt/2018-05-05-preview/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️alertsmanagement/mgmt/2018-05-05/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

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

️✔️Succeeded [Logs]Release - Generate from f2af6b1. 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.6320 --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/alertsmanagement/resource-manager/readme.md

️✔️alertsmanagement [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]  SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.2 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.2: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

️️✔️[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 · 2020-12-02T13:09:15Z

Hi @giladsu, 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 think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ma/swaggerfeedback.

openapi-workflow-bot · 2020-12-02T14:57:51Z

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

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

giladsu · 2020-12-02T14:59:39Z

@fengzhou-msft this PR contains some breaking changes to a preview API that has no customers as of yet, and is currently only being used by our team for testing. Please let me know if I can elaborate on anything.

Update swagger with new properties

91d9cc1

giladsu requested review from ofirmanor and orieldar as code owners December 2, 2020 12:36

openapi-assignment-bot bot assigned fengzhou-msft Dec 2, 2020

giladsu added 2 commits December 2, 2020 14:53

Removed extra comma

c4f2957

Fixed syntax error

e6969d2

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Dec 2, 2020

giladsu added 11 commits December 2, 2020 15:26

Add format

302b548

Using new enum

b27af73

Updated example

cc75f59

Fixed enum

05357bb

Prettier fix

b148aaa

Prettier check fix

6bedf6b

Prettier fix

425679d

Prettier check

bf8bf3d

Fixed indent

13f3405

Fix prettier

969adfe

More prettier stuff

57353ac

fengzhou-msft added Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 and removed BreakingChangeReviewRequired labels Dec 7, 2020

fengzhou-msft approved these changes Dec 7, 2020

View reviewed changes

fengzhou-msft merged commit f2af6b1 into Azure:master Dec 11, 2020

DeMale pushed a commit to DeMale/azure-rest-api-specs that referenced this pull request Dec 11, 2020

Update swagger with new properties (Azure#11901)

b00e106

dabenhamMic pushed a commit to dabenhamMic/azure-rest-api-specs that referenced this pull request Dec 14, 2020

Update swagger with new properties (Azure#11901)

62bc3cb

giromm2ms pushed a commit to giromm2ms/azure-rest-api-specs that referenced this pull request Dec 20, 2020

Update swagger with new properties (Azure#11901)

e93d355

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update swagger with new properties #11901

Update swagger with new properties #11901

giladsu commented Dec 2, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

openapi-workflow-bot bot commented Dec 2, 2020

openapi-workflow-bot bot commented Dec 2, 2020

giladsu commented Dec 2, 2020

Update swagger with new properties #11901

Update swagger with new properties #11901

Conversation

giladsu commented Dec 2, 2020 • edited Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-pipeline-app bot commented Dec 2, 2020 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Dec 2, 2020 • edited Loading

Swagger Generation Artifacts

openapi-workflow-bot bot commented Dec 2, 2020

openapi-workflow-bot bot commented Dec 2, 2020

giladsu commented Dec 2, 2020

giladsu commented Dec 2, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading

openapi-pipeline-app bot commented Dec 2, 2020 •

edited

Loading