Updating with Patch changes #12149

viv-liu · 2020-12-17T01:41:10Z

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-17T01:41:12Z

Hi, @viv-liu 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 cross api-version diff. See OpenAPI Hub Diff

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-17T01:41:14Z

Swagger Validation Report

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

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

Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2019-10-28-preview/iotcentral.json <---> new: preview/2019-10-28-preview/iotcentral.json

Rule	Message
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'ApiTokens_Set' to 'ApiTokens_Create'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L967:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L935:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'ContinuousDataExports_Set' to 'ContinuousDataExports_Create'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1075:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1043:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceTemplates_Set' to 'DeviceTemplates_Create'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1234:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1169:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_Set' to 'Devices_Create'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1383:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1318:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_SetAttestation' to 'Devices_CreateAttestation'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1489:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1394:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_UpdateCloudProperties' to 'Devices_SetCloudProperties'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1570:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1475:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_UpdateComponentProperties' to 'Devices_SetComponentProperties'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1819:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1694:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_UpdateModuleComponentProperties' to 'Devices_SetModuleComponentProperties'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2169:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2012:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_UpdateModuleProperties' to 'Devices_SetModuleProperties'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2303:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2111:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'Devices_UpdateProperties' to 'Devices_SetProperties'. This will impact generated code. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2427:7 Old: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2202:7

️⚠️LintDiff: 8 Warnings warning [Detail]

Linted configuring files (Based on source branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- iotcentral/data-plane/readme.md tag:default
Linted configuring files (Based on target branch, openapi-validator v1.7.0 , classic-openapi-validator v1.1.5 )
- iotcentral/data-plane/readme.md tag:default

Rule	Message
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_SetComponentProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1819
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_UpdateComponentProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L1853
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_SetModuleComponentProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2169
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_UpdateModuleComponentProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2206
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_SetModuleProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2303
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_UpdateModuleProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2338
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_SetProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2427
⚠️ R2007 - LongRunningOperationsWithLongRunningExtension	The operation 'Devices_UpdateProperties' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation. New: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json#L2459

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️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-17T01:41:15Z

Swagger pipeline restarted successfully, please wait for status update in this comment.

openapi-workflow-bot · 2020-12-17T01:41:52Z

Hi, @viv-liu 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]

...cation/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json

openapi-workflow-bot · 2020-12-17T20:09:56Z

Hi @viv-liu, 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-17T20:09:56Z

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.

ghost · 2021-01-03T16:00:36Z

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

...cation/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json

jhendrixMSFT

Can you pleas also address the Avocado failures https://github.com/Azure/azure-rest-api-specs/pull/12149/checks?check_run_id=1572822106

Also looks like the prettier check is failing however the build is gone (can trigger a new one).

specification/iotcentral/data-plane/readme.md

jhendrixMSFT · 2021-01-06T00:00:18Z

/azp run

azure-pipelines · 2021-01-06T00:01:15Z

Azure Pipelines successfully started running 2 pipeline(s).

openapi-workflow-bot · 2021-01-06T00:05:38Z

Hi @viv-liu, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

Task	How to fix	Priority	Support (Microsoft alias)
Avocado	Fix-Avocado	High	ruowan
Semantic validation	Fix-SemanticValidation-Error	High	raychen, jianyxi
Model validation	Fix-ModelValidation-Error	High	raychen,jianyxi
LintDiff	Fix-LintDiff	high	jianyxi, ruoxuan

If you need further help, please feedback via swagger feedback."

jhendrixMSFT · 2021-01-28T22:37:39Z

...cation/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json

+        }
+      },
      "delete": {
        "operationId": "ContinuousDataExports_Remove",


Why Remove and not Delete?

For some generated languages, delete is keyword, for example in typescript, generated code change to "deletemethod()", but use remove we can keep it "remove().

viv-liu · 2021-01-29T19:23:43Z

This is good to go. @lirenhe @jhendrixMSFT can you merge this?

First set of changes

235c65f

openapi-assignment-bot bot assigned jhendrixMSFT Dec 17, 2020

Small updates

baf59bb

jhendrixMSFT reviewed Dec 17, 2020

View reviewed changes

...cation/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json Show resolved Hide resolved

Updated schema to include object

4dc3be2

openapi-pipeline-app bot added BreakingChangeReviewRequired labels Dec 17, 2020

Small tweaks

946c32b

viv-liu requested a review from lirenhe as a code owner December 17, 2020 20:23

jhendrixMSFT added the Reassign label Dec 17, 2020

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

jhendrixMSFT reviewed Jan 5, 2021

View reviewed changes

...cation/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json Show resolved Hide resolved

jhendrixMSFT requested changes Jan 6, 2021

View reviewed changes

specification/iotcentral/data-plane/readme.md Outdated Show resolved Hide resolved

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 6, 2021

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

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 6, 2021

Reverted schema, and changed readme suppression

de9216f

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 8, 2021

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jan 11, 2021

Different indents

d819e92

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 11, 2021

Removing longrunningoperation suppressions

14b93e4

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 11, 2021

Fixing linter problem

45e61de

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 27, 2021

Updating suppression again

087f58c

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 27, 2021

Removing suppression

3baf4ca

openapi-pipeline-app bot added CI-FixRequiredOnFailure and removed CI-FixRequiredOnFailure labels Jan 27, 2021

merging upstream readme

e6c0dbd

openapi-pipeline-app bot removed the CI-FixRequiredOnFailure label Jan 28, 2021

viv-liu added 2 commits January 28, 2021 11:47

Updating operationIds to create

2b1c403

Updating a few properties

08df448

yang-hai-feng approved these changes Jan 28, 2021

View reviewed changes

jhendrixMSFT reviewed Jan 28, 2021

View reviewed changes

Updating remove to delete

ac46160

jhendrixMSFT approved these changes Jan 28, 2021

View reviewed changes

Reverting changes back to "remove"

b027d82

jhendrixMSFT removed the Reassign label Jan 29, 2021

lmazuel merged commit f317511 into Azure:master Jan 29, 2021

Updating with Patch changes #12149

Updating with Patch changes #12149

Uh oh!

Conversation

viv-liu commented Dec 17, 2020 • edited by yang-hai-feng Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Dec 17, 2020

Uh oh!

openapi-pipeline-app bot commented Dec 17, 2020 • 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 Dec 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Dec 17, 2020

Uh oh!

Uh oh!

openapi-workflow-bot bot commented Dec 17, 2020

Uh oh!

openapi-workflow-bot bot commented Dec 17, 2020

Uh oh!

ghost commented Jan 3, 2021

Uh oh!

Uh oh!

jhendrixMSFT left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jhendrixMSFT commented Jan 6, 2021

Uh oh!

azure-pipelines bot commented Jan 6, 2021

Uh oh!

openapi-workflow-bot bot commented Jan 6, 2021

Uh oh!

jhendrixMSFT Jan 28, 2021

Choose a reason for hiding this comment

Uh oh!

yang-hai-feng Jan 29, 2021

Choose a reason for hiding this comment

Uh oh!

viv-liu commented Jan 29, 2021

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

viv-liu commented Dec 17, 2020 •

edited by yang-hai-feng

Loading

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

edited

Loading

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

edited

Loading