Added 202 response code for patch async operations #14304

akashkeshari · 2021-05-07T06:15:10Z

The PR is to avoid issues caused by the breaking change that rpaas is going to introduce
https://teams.microsoft.com/l/message/19:[email protected]/1620325548526?tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47&groupId=929a4be2-b219-4f5f-8dd0-94ca0eeec6b5&parentMessageId=1620325548526&teamName=RP-as-a-Service%20Partners&channelName=Announcements&createdTime=1620325548526

Related icm link: https://portal.microsofticm.com/imp/v3/incidents/details/239962688/home

openapi-workflow-bot · 2021-05-07T06:15:11Z

Hi, @akashkeshari 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-workflow-bot · 2021-05-07T06:15:12Z

[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 · 2021-05-07T06:15:12Z

Swagger Validation Report

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

Compared Swaggers (Based on Oad v0.8.9)
- current:preview/2021-04-01-preview/connectedClusters.json compared with base:preview/2021-04-01-preview/connectedClusters.json

Rule	Message
`❌` 1011 - AddingResponseCode	The new version adds a response code '202'. New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L146:11
`❌` 1012 - RemovedResponseCode	The new version removes the response code '201' Old: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L146:11
`❌` 1044 - XmsLongRunningOperationChanged	The new version has a different 'x-ms-longrunning-operation' value than the previous one. New: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L98:7 Old: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L98:7

️⚠️LintDiff: 0 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- hybridkubernetes/resource-manager/readme.md tag:package-2021-04-01-preview
Linted configuring files (Based on target branch, openapi-validator v1.9.2 , classic-openapi-validator v1.1.6 )
- hybridkubernetes/resource-manager/readme.md tag:package-2021-04-01-preview

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` R4013 - IntegerTypeMustHaveFormat	The integer type does not have a format, please add it. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L570
`❌` R4018 - OperationsApiResponseSchema	The response schema of operations API '/providers/Microsoft.Kubernetes/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L389
⚠️ R1003 - ListInOperationName	Since operation 'Operations_Get' response has model definition 'x-ms-pageable', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L392
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L34
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L100
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L163
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L204
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L254
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L309
⚠️ R2063 - OperationIdNounConflictingModelNames	OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ConnectedClusterModel'. Consider using the plural form of 'ConnectedCluster' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json#L352

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

The following tags are being changed in this PR

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

The following errors/warnings are introduced by current PR:

|:speech_balloon: AutorestCore/Exception|"readme":"hybridkubernetes/resource-manager/readme.md",
"tag":"package-2021-04-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"hybridkubernetes/resource-manager/readme.md",
"tag":"package-2021-04-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|

The following errors/warnings exist before current PR submission:

|:speech_balloon: AutorestCore/Exception|"readme":"hybridkubernetes/resource-manager/readme.md",
"tag":"package-2021-04-01-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

️️✔️[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 · 2021-05-07T06:15:13Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️✔️azure-sdk-for-go - hybridkubernetes/mgmt/2021-03-01/hybridkubernetes - v55.0.0
️✔️azure-sdk-for-go - preview/hybridkubernetes/mgmt/2021-04-01-preview/hybridkubernetes - v55.0.0
️✔️azure-sdk-for-go - preview/hybridkubernetes/mgmt/2020-01-01-preview/hybridkubernetes - v55.0.0
️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-hybridkubernetes - 1.0.0

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

⚠️Warning [Logs]Release - Generate from b422712. 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-hybridkubernetes [View full logs] [Release SDK Changes]
- azure_mgmt_hybridkubernetes-1.0.0b1-py2.py3-none-any.whl
- azure-mgmt-hybridkubernetes-1.0.0b1.zip
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from b422712. SDK Automation 14.0.0

command	./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
cmderr	[generate.py] 2021-06-03 12:57:28 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-hybridkubernetes;1.0.0-beta.1;1.0.0-beta.2"
cmderr	[generate.py] 2021-06-03 12:57:28 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
cmderr	[generate.py] 2021-06-03 12:57:28 INFO autorest --version=3.1.3 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/hybridkubernetes/azure-resourcemanager-hybridkubernetes --java.namespace=com.azure.resourcemanager.hybridkubernetes   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/hybridkubernetes/resource-manager/readme.md
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-hybridkubernetes
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [POM][Skip] pom already has module azure-resourcemanager-hybridkubernetes
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [POM][Skip] pom already has module sdk/hybridkubernetes
cmderr	[generate.py] 2021-06-03 12:58:01 INFO [POM][Success] Write to root pom

️✔️azure-resourcemanager-hybridkubernetes [View full logs] [Release SDK Changes]

cmderr	[Inst] 2021-06-03 13:00:34 DEBUG Got artifact_id: azure-resourcemanager-hybridkubernetes
cmderr	[Inst] 2021-06-03 13:00:34 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-06-03 13:00:34 DEBUG Got artifact: azure-resourcemanager-hybridkubernetes-1.0.0-beta.2-javadoc.jar
cmderr	[Inst] 2021-06-03 13:00:34 DEBUG Got artifact: azure-resourcemanager-hybridkubernetes-1.0.0-beta.2-sources.jar
cmderr	[Inst] 2021-06-03 13:00:34 DEBUG Got artifact: azure-resourcemanager-hybridkubernetes-1.0.0-beta.2.jar
cmderr	[Inst] 2021-06-03 13:00:34 DEBUG Match jar package: azure-resourcemanager-hybridkubernetes-1.0.0-beta.2.jar
cmderr	[Inst] 2021-06-03 13:00:34 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14304/azure-sdk-for-java/azure-resourcemanager-hybridkubernetes/azure-resourcemanager-hybridkubernetes-1.0.0-beta.2.jar\" -o azure-resourcemanager-hybridkubernetes-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-hybridkubernetes -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-hybridkubernetes-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
```"}

️❌ azure-sdk-for-go failed [Detail]

❌Failed [Logs]Release - Generate from b422712. SDK Automation 14.0.0

command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: sh ./initScript.sh
warn	File azure-sdk-for-go_tmp/initOutput.json not found to read
command	go run ./tools/generator/main.go automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: go run ./tools/generator/main.go automation
warn	Skip package processing as generation is failed

️🔄 azure-sdk-for-net inProgress [Detail]

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs]Release - Generate from b422712. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
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
warn	No file changes detected after generation

️✔️hybridkubernetes [View full logs] [Release Schema Changes]

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

openapi-workflow-bot · 2021-05-07T06:18:01Z

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

...etes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json

ghost · 2021-05-30T16:00:42Z

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

openapi-workflow-bot · 2021-05-31T06:04:35Z

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.

majastrz

Signed off from ARM side.

added 202 response code for patch async operations

8bc26da

openapi-assignment-bot bot assigned ruowan May 7, 2021

openapi-pipeline-app bot added the BreakingChangeReviewRequired label May 7, 2021

rapatchi reviewed May 7, 2021

View reviewed changes

...etes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json Outdated Show resolved Hide resolved

rapatchi approved these changes May 7, 2021

View reviewed changes

ruowan assigned ruowan and unassigned ruowan May 7, 2021

JeffreyRichter approved these changes May 7, 2021

View reviewed changes

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

mentat9 reviewed May 8, 2021

View reviewed changes

...etes/resource-manager/Microsoft.Kubernetes/preview/2021-04-01-preview/connectedClusters.json Show resolved Hide resolved

mentat9 added the ARMChangesRequested label May 8, 2021

akashkeshari added the DoNotMerge <valid label in PR review process> use to hold merge after approval label May 11, 2021

Merge branch 'master' into akash/patch_async_fix

decffbe

ghost added no-recent-activity and removed no-recent-activity labels May 30, 2021

updated patch async response code to 202

37638fd

openapi-pipeline-app bot added the NewApiVersionRequired label May 31, 2021

openapi-sdkautomation bot mentioned this pull request May 31, 2021

[AutoPR track2_azure-mgmt-hybridkubernetes] Added 202 response code for patch async operations AzureSDKAutomation/azure-sdk-for-python#5788

Closed

akashkeshari removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Jun 1, 2021

akashkeshari requested a review from mentat9 June 2, 2021 05:55

majastrz removed the ARMChangesRequested label Jun 2, 2021

majastrz added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 2, 2021

majastrz approved these changes Jun 2, 2021

View reviewed changes

akning-ms merged commit b422712 into Azure:master Jun 3, 2021

heaths mentioned this pull request Jun 16, 2021

Initial 2021-05-01-preview version #14855

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Added 202 response code for patch async operations #14304

Added 202 response code for patch async operations #14304

Uh oh!

akashkeshari commented May 7, 2021

Uh oh!

openapi-workflow-bot bot commented May 7, 2021

Uh oh!

openapi-workflow-bot bot commented May 7, 2021

Uh oh!

openapi-pipeline-app bot commented May 7, 2021 •

edited

Loading

Uh oh!

openapi-pipeline-app bot commented May 7, 2021 •

edited

Loading

Breaking Changes Tracking

Uh oh!

openapi-workflow-bot bot commented May 7, 2021

Uh oh!

Uh oh!

Uh oh!

ghost commented May 30, 2021

Uh oh!

openapi-workflow-bot bot commented May 31, 2021

Uh oh!

majastrz left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Added 202 response code for patch async operations #14304

Added 202 response code for patch async operations #14304

Uh oh!

Conversation

akashkeshari commented May 7, 2021

Uh oh!

openapi-workflow-bot bot commented May 7, 2021

Uh oh!

openapi-workflow-bot bot commented May 7, 2021

Uh oh!

openapi-pipeline-app bot commented May 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Validation Report

Uh oh!

openapi-pipeline-app bot commented May 7, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Swagger Generation Artifacts

Breaking Changes Tracking

Uh oh!

openapi-workflow-bot bot commented May 7, 2021

Uh oh!

Uh oh!

Uh oh!

ghost commented May 30, 2021

Uh oh!

openapi-workflow-bot bot commented May 31, 2021

Uh oh!

majastrz left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

openapi-pipeline-app bot commented May 7, 2021 •

edited

Loading

openapi-pipeline-app bot commented May 7, 2021 •

edited

Loading