Adding patch operation in 2019-03-01 API #12190

napolish · 2020-12-21T15:24:03Z

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-workflow-bot · 2020-12-21T15:24:06Z

Hi, @napolish 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. [email protected]

openapi-pipeline-app · 2020-12-21T15:24:08Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.8.5)
- original: stable/2019-03-01/SmartDetectorAlertRulesApi.json <---> new: stable/2019-03-01/SmartDetectorAlertRulesApi.json

Rule	Message
`❌` 1039 - AddedOperation	The new version is adding an operation that was not found in the old version. New: Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json#L217:7

️❌LintDiff: 1 Errors, 1 Warnings failed [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- alertsmanagement/resource-manager/readme.md tag:package-2019-03
Linted configuring files (Based on target branch, openapi-validator v1.6.0 , classic-openapi-validator v1.1.5 )
- alertsmanagement/resource-manager/readme.md tag:package-2019-03

Rule	Message
`❌` R4007 - DefaultErrorResponseSchema	the default error response schema does not correspond to the schema documented at https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/common-api-details.md#error-response-content. New: Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json#L247
⚠️ R1007 - PatchInOperationName	'PATCH' operation 'SmartDetectorAlertRules_Patch' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. New: Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json#L221

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

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

There is no credential detected.

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

openapi-pipeline-app · 2020-12-21T15:24:08Z

Swagger Generation Artifacts

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

️✔️Succeeded [Logs]Release - Generate from 742d12e. Schema Automation 14.0.0

warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/[email protected] --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/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]  [email protected] No repository field.
cmderr	[resource-manager] optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})

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

️✔️Succeeded [Logs]Release - Generate from 742d12e. 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 [email protected]/[email protected] --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 742d12e. 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 `AlertRulePatchObject.MarshalJSON() ([]byte, error)`
info	[Changelog] - New function `SmartDetectorAlertRulesClient.PatchSender(*http.Request) (*http.Response, error)`
info	[Changelog] - New function `*AlertRulePatchObject.UnmarshalJSON([]byte) 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 `SmartDetectorAlertRulesClient.Patch(context.Context, string, string, AlertRulePatchObject) (AlertRule, 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-sdk-for-python succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 742d12e. 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 [email protected]/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]

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 0.2.0rc2 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/0.2.0rc2/report.json
cmdout	[Changelog] Size of delta 3.063% size of original (original: 35162 chars, delta: 1077 chars)

️️✔️[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-21T17:50:47Z

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.

akning-ms · 2020-12-22T01:52:01Z

...esource-manager/Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json

+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "#/definitions/SmartDetectorErrorResponse"


This error response is different from ARM's guideline. so that is why cause Linter error R4007,
But if your service already implement error response like what your define in SmartDetectorErrorResponse. to keep consistent, we can suppress it

We need to keep the error response consistent , can you please suppress this error? @akning-ms

openapi-workflow-bot · 2020-12-22T02:05:02Z

Hi, @napolish your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @lirenhe

akning-ms · 2020-12-24T10:42:16Z

@ArcturusZhang to take a look the GO sdk breaking change

ArcturusZhang · 2020-12-25T02:48:27Z

@ArcturusZhang to take a look the GO sdk breaking change

The breaking changes in go SDK are fine and expected

openapi-workflow-bot · 2020-12-29T09:53:45Z

Hi @napolish, 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.ma/swaggerfeedback.

jorgecotillo · 2020-12-30T19:12:44Z

Approved from ARM side.

ghost · 2021-01-17T16:00:25Z

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

* Adding patch operation in 2019-03-01 API * Adding missing example file * Fixing api version in the example * Fixing parameter name * Removing properties that don't exist in AzureResource

Adding patch operation in 2019-03-01 API

601be32

napolish requested review from ofirmanor and orieldar as code owners December 21, 2020 15:24

openapi-assignment-bot bot assigned lirenhe Dec 21, 2020

napolish added 2 commits December 21, 2020 19:10

Adding missing example file

ca7212b

Fixing api version in the example

e0b4d7b

openapi-pipeline-app bot added the CI-BreakingChange-Go label Dec 21, 2020

Fixing parameter name

96b62d2

openapi-pipeline-app bot added the NewApiVersionRequired label Dec 21, 2020

openapi-sdkautomation bot mentioned this pull request Dec 21, 2020

[AutoPR alertsmanagement] Adding patch operation in 2019-03-01 API AzureSDKAutomation/azure-resource-manager-schemas#1207

Closed

akning-ms reviewed Dec 22, 2020

View reviewed changes

openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Dec 22, 2020

Removing properties that don't exist in AzureResource

d419987

akning-ms removed the NewApiVersionRequired label Dec 24, 2020

akning-ms added the BreakingChangeReviewRequired label Dec 29, 2020

jorgecotillo added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Dec 30, 2020

ghost added the no-recent-activity label Jan 17, 2021

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

ghost removed the no-recent-activity label Jan 19, 2021

JeffreyRichter approved these changes Jan 19, 2021

View reviewed changes

akning-ms merged commit 742d12e into Azure:master Jan 25, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding patch operation in 2019-03-01 API #12190

Adding patch operation in 2019-03-01 API #12190

napolish commented Dec 21, 2020 •

edited by akning-ms

Loading

openapi-workflow-bot bot commented Dec 21, 2020

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

edited

Loading

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

edited

Loading

openapi-workflow-bot bot commented Dec 21, 2020

akning-ms Dec 22, 2020 •

edited

Loading

napolish Dec 23, 2020

openapi-workflow-bot bot commented Dec 22, 2020

akning-ms commented Dec 24, 2020

ArcturusZhang commented Dec 25, 2020

openapi-workflow-bot bot commented Dec 29, 2020

jorgecotillo commented Dec 30, 2020

ghost commented Jan 17, 2021

Adding patch operation in 2019-03-01 API #12190

Adding patch operation in 2019-03-01 API #12190

Conversation

napolish commented Dec 21, 2020 • edited by akning-ms Loading

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Dec 21, 2020

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

Swagger Validation Report

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

Swagger Generation Artifacts

openapi-workflow-bot bot commented Dec 21, 2020

akning-ms Dec 22, 2020 • edited Loading

Choose a reason for hiding this comment

napolish Dec 23, 2020

Choose a reason for hiding this comment

openapi-workflow-bot bot commented Dec 22, 2020

akning-ms commented Dec 24, 2020

ArcturusZhang commented Dec 25, 2020

openapi-workflow-bot bot commented Dec 29, 2020

jorgecotillo commented Dec 30, 2020

ghost commented Jan 17, 2021

napolish commented Dec 21, 2020 •

edited by akning-ms

Loading

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

edited

Loading

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

edited

Loading

akning-ms Dec 22, 2020 •

edited

Loading