[Hub Generated] Review request for Microsoft.AlertsManagement to add version preview/2021-01-01-preview #12748

dishonono · 2021-01-31T12:38:34Z

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.

…w/2020-08-04-preview to version 2021-01-01-preview

openapi-workflow-bot · 2021-01-31T12:38:37Z

Hi, @dishonono 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-31T12:38:39Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 1 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- alertsmanagement/resource-manager/readme.md tag:package-preview-2021-01
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- alertsmanagement/resource-manager/readme.md tag:default

Rule	Message
⚠️ R2066 - PostOperationIdContainsUrlVerb	OperationId should contain the verb: 'migratefromsmartdetection' in:'MigrateFromSmartDetection_StartMigration'. Consider updating the operationId Location: Microsoft.AlertsManagement/preview/2021-01-01-preview/MigrateFromSmartDetections.json#L36

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

Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2020-08-04-preview/AlertsManagement.json <---> new: preview/2021-01-01-preview/AlertsManagement.json

️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 35 Warnings warning [Detail]

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

Compared Swaggers (Based on Oad v0.8.6)
- original: stable/2019-03-01/AlertsManagement.json <---> new: preview/2021-01-01-preview/AlertsManagement.json

Rule	Message
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.AlertsManagement/alertsMetaData' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L55:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.AlertsManagement/alerts' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L91:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L181:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/changestate' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L221:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.AlertsManagement/alerts/{alertId}/history' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L260:5
⚠️ 1005 - RemovedPath	The new version is missing a path that was found in the old version. Was path '/{scope}/providers/Microsoft.AlertsManagement/alertsSummary' removed or restructured? Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L296:5
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'scope' removed or renamed? New: Microsoft.AlertsManagement/preview/2021-01-01-preview/AlertsManagement.json#L108:3 Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L366:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'subscriptionId' removed or renamed? New: Microsoft.AlertsManagement/preview/2021-01-01-preview/AlertsManagement.json#L108:3 Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L366:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'api-version' removed or renamed? New: Microsoft.AlertsManagement/preview/2021-01-01-preview/AlertsManagement.json#L108:3 Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L366:3
⚠️ 1007 - RemovedClientParameter	The new version is missing a client parameter that was found in the old version. Was 'alertId' removed or renamed? New: Microsoft.AlertsManagement/preview/2021-01-01-preview/AlertsManagement.json#L108:3 Old: Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json#L366:3

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

There is no credential detected.

️⚠️[Staging] SDK Track2 Validation: 5 Warnings warning [Detail]

The following tags are being changed in this PR

alertsmanagement/resource-manager/readme.md#package-preview-2021-01

Rule	Message
⚠️ PreCheck/SchemaMissingType	"readme":"alertsmanagement/resource-manager/readme.md", "tag":"package-preview-2021-01", "details":"The schema 'operation' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"alertsmanagement/resource-manager/readme.md", "tag":"package-preview-2021-01", "details":"The schema 'operationsList' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"alertsmanagement/resource-manager/readme.md", "tag":"package-preview-2021-01", "details":"The schema 'SmartDetectionMigrationRequest' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/SchemaMissingType	"readme":"alertsmanagement/resource-manager/readme.md", "tag":"package-preview-2021-01", "details":"The schema 'MigrationStatusResponseProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
⚠️ PreCheck/CheckDuplicateSchemas	"readme":"alertsmanagement/resource-manager/readme.md", "tag":"package-preview-2021-01", "details":"Checking for duplicate schemas, this could take a (long) while. Run with --verbose for more detail."

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

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

openapi-pipeline-app · 2021-01-31T12:38:40Z

Swagger Generation Artifacts

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

️✔️Succeeded [Logs]Release - Generate from 4ed719c. 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-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 4ed719c. 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

️✔️alertsmanagement/mgmt/2019-03-01/alertsmanagement [View full logs] [Release SDK Changes]

info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New function `SmartDetectorAlertRulesClient.PatchSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `AlertRulePatchObject.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `SmartDetectorAlertRulesClient.Patch(context.Context, string, string, AlertRulePatchObject) (AlertRule, error)`
info	[Changelog] - New function `SmartDetectorAlertRulesClient.PatchPreparer(context.Context, string, string, AlertRulePatchObject) (*http.Request, error)`
info	[Changelog] - New function `SmartDetectorAlertRulesClient.PatchResponder(*http.Response) (AlertRule, error)`
info	[Changelog] - New function `*AlertRulePatchObject.UnmarshalJSON([]byte) error`
info	[Changelog] - New struct `AlertRulePatchObject`
info	[Changelog] - New struct `AlertRulePatchProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 10 additive change(s).
info	[Changelog]

️✔️alertsmanagement/mgmt/2018-05-05/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```
️✔️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
```
️✔️preview/alertsmanagement/mgmt/2018-05-05-preview/alertsmanagement [View full logs] [Release SDK Changes]
```
info	[Changelog] No exported changes
```

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

️✔️Succeeded [Logs]Release - Generate from 4ed719c. 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.6369 --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] WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] 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"})

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

⚠️Warning [Logs]Release - Generate from 4ed719c. 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

️✔️azure-mgmt-alertsmanagement [View full logs] [Release SDK Changes]
- azure_mgmt_alertsmanagement-0.2.0rc2-py2.py3-none-any.whl
- azure-mgmt-alertsmanagement-0.2.0rc2.zip
```
info	[Changelog]
```

️🔄[Staging] ApiDocPreview inProgress [Detail]

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

openapi-workflow-bot · 2021-01-31T12:40:47Z

Hi, @dishonono your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @

dishonono · 2021-01-31T12:55:41Z

this is the ARM manifest PR:
https://armmanifest.visualstudio.com/One/_git/Manifest/pullrequest/2836

...anager/Microsoft.AlertsManagement/preview/2021-01-01-preview/MigrateFromSmartDetections.json

...sManagement/preview/2021-01-01-preview/examples/migrateFromSmartDetectionStartMigration.json

...anager/Microsoft.AlertsManagement/preview/2021-01-01-preview/MigrateFromSmartDetections.json

dishonono · 2021-02-07T09:27:00Z

Hi @jorgecotillo ,
I've fixed the comments you had.
one issue is that because I added x-ms-long-running-operation to the post, I now see this:

Although, as I said, the final status 200 will be delivered by the GET operation that the user is referred to through the location header.

...anager/Microsoft.AlertsManagement/preview/2021-01-01-preview/MigrateFromSmartDetections.json

jorgecotillo · 2021-02-10T09:19:27Z

@dishonono take a look at my GET and POST comment from 2/10

dishonono · 2021-02-10T11:09:35Z

/azp run unifiedPipeline

azure-pipelines · 2021-02-10T11:09:40Z

No pipelines are associated with this pull request.

dishonono · 2021-02-10T16:47:19Z

/azp run unifiedPipeline

azure-pipelines · 2021-02-10T16:47:24Z

No pipelines are associated with this pull request.

akning-ms · 2021-02-13T04:02:13Z

specification/alertsmanagement/resource-manager/readme.md

@@ -44,6 +44,16 @@ openapi-type: arm
 tag: package-2019-06-preview


Will you use new api version for your SDK release? if yes, we should change tag to your new tag for 2021-01 version

Hi,
no . We don't want to use the new API version for the SDK release

…version preview/2021-01-01-preview (Azure#12748) * Adds base for updating Microsoft.AlertsManagement from version preview/2020-08-04-preview to version 2021-01-01-preview * Updates readme * Updates API version in new specs and examples * first commit * fix: "Client Api Version." * try add x-ms-long-running-operation-options * some renames * try to remove long operation * fixes from code review * fix typo * code review fixes * try fix lintdiff * remove the GET from the swagger , Add 200 to the POST * fix spelling * remove location header from the 200 response

dishonono and others added 8 commits January 28, 2021 15:39

Adds base for updating Microsoft.AlertsManagement from version previe…

ab15813

…w/2020-08-04-preview to version 2021-01-01-preview

Updates readme

2b67d46

Updates API version in new specs and examples

90d47af

first commit

b669a86

fix: "Client Api Version."

6c5ad14

try add x-ms-long-running-operation-options

5422949

some renames

19d5c19

try to remove long operation

e62f880

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jan 31, 2021

dishonono marked this pull request as ready for review January 31, 2021 12:54

dishonono requested review from ofirmanor and orieldar as code owners January 31, 2021 12:54

openapi-assignment-bot bot assigned akning-ms Jan 31, 2021

jorgecotillo self-assigned this Feb 3, 2021