Device Update for IoT Hub swagger changes from SDK client library review. #19492

dpokluda · 2022-06-17T00:57:09Z

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

Changelog

Add a changelog entry for 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: Incorporating SDK client library feedback; no change to actual service version methods
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month. July 2022
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month. June 2022
If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the 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 refresh required 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

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

Removing API(s) in a stable version
Removing properties in a stable version
Removing API version(s) in a stable version
Updating API in a stable or public preview version with Breaking Change Validation errors
Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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 · 2022-06-17T00:57:11Z

Hi, @dpokluda 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 · 2022-06-17T00:57:12Z

Swagger Validation Report

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

compared swaggers (via Oad v0.9.6)]	new version	base version
deviceupdate.json	2022-07-01(ba91ceb)	2022-07-01(main)

Rule	Message
`❌` 1006 - RemovedDefinition	The new version is missing a definition that was found in the old version. Was 'LogCollectionOperation' removed or renamed? New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2295:3 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2286:3
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_GetGroupUpdateCompliance' to 'DeviceManagement_GetUpdateComplianceForGroup'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1126:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1125:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_GetDeviceClassSubgroupDetails' to 'DeviceManagement_GetDeviceClassSubgroup'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1486:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1481:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_ListBestUpdatesForDeviceClassSubgroup' to 'DeviceManagement_GetBestUpdatesForDeviceClassSubgroup'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1607:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1602:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_DeleteDeviceClassSubgroupDeployment' to 'DeviceManagement_DeleteDeploymentForDeviceClassSubgroup'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1746:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1740:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_ListDevicesForDeviceClassSubgroupDeployment' to 'DeviceManagement_ListDeviceStatesForDeviceClassSubgroupDeployment'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1923:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L1917:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_CollectLogs' to 'DeviceManagement_StartLogCollection'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2085:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2079:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_GetLogCollectionOperation' to 'DeviceManagement_GetLogCollection'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2131:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2125:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_ListLogCollectionOperations' to 'DeviceManagement_ListLogCollections'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2170:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2164:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeviceManagement_GetLogCollectionOperationDetailedStatus' to 'DeviceManagement_GetLogCollectionDetailedStatus'. This will impact generated code. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2209:7 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2203:7
`❌` 1009 - RemovedRequiredParameter	The required parameter 'logCollectionRequest' was removed in the new version. Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2100:11
`❌` 1010 - AddingRequiredParameter	The required parameter 'logCollection' was added in the new version. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2106:11
`❌` 1023 - TypeFormatChanged	The new version has a different format than the previous one. New: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L4356:5 Old: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L4331:5

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

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

There is no credential detected.

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

compared tags (via openapi-validator v1.13.0)	new version	base version
package-2022-07-01-preview	package-2022-07-01-preview(ba91ceb)	package-2022-07-01-preview(main)

The following errors/warnings are introduced by current PR:

Rule	Message
`❌` R2003 - ValidFormats	'url' is not a known format. Location: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L4360

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ R2001 - AvoidNestedProperties	Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json#L2696

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

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]

The following tags are being changed in this PR

deviceupdate/data-plane/readme.md#package-2022-07-01-preview

The following errors/warnings are introduced by current PR:

|:speech_balloon: |"readme":"deviceupdate/data-plane/readme.md",
"tag":"package-2022-07-01-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)"|
|:speech_balloon: |"readme":"deviceupdate/data-plane/readme.md",
"tag":"package-2022-07-01-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)"|
|:speech_balloon: |"readme":"deviceupdate/data-plane/readme.md",
"tag":"package-2022-07-01-preview",
"details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)"|
|:speech_balloon: |"readme":"deviceupdate/data-plane/readme.md",
"tag":"package-2022-07-01-preview",
"details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)"|
|:speech_balloon: |"readme":"deviceupdate/data-plane/readme.md",
"tag":"package-2022-07-01-preview",
"details":"Autorest completed in 11.76s. 0 files generated."|

The following errors/warnings exist before current PR submission:

Rule	Message
⚠️ DeprecatedConfig	"readme":"deviceupdate/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"Using directive.0.suppress which is deprecated and will be removed in the future."
💬	"readme":"deviceupdate/data-plane/readme.md", "tag":"package-2022-07-01-preview", "details":"AutoRest core version selected from configuration: ^3.2.0."

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

Validation passes for PrettierCheck.

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

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

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

openapi-pipeline-app · 2022-06-17T00:57:13Z

Swagger Generation Artifacts

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

 Please click here to preview with your @microsoft account.

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

Breaking Changes Tracking

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

⚠️Warning [Logs]Release - Generate from b9b9192. 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
cmderr	[automation_generate.sh]  global `--global`, `--local` are deprecated. Use `--location=global` instead.
warn	No file changes detected after generation
warn	No package detected after generation

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

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

️✔️azure-iot-deviceupdate [View full logs] [Release SDK Changes]
- pom.xml

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

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

command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
cmderr	[automation_init.sh] deprecated [email protected]: The functionality that this package provided is now in @npmcli/arborist
cmderr	[automation_init.sh] WARN deprecated [email protected]: Please upgrade  to version 7 or higher.  Older versions may use Math.random() in certain circumstances, which is known to be problematic.  See https://v8.dev/blog/math-random for details.
cmderr	[automation_init.sh] npm WARN deprecated @opentelemetry/[email protected]: Package renamed to @opentelemetry/api, see https://github.com/open-telemetry/opentelemetry-js
cmderr	[automation_init.sh]  WARN deprecated @azure/[email protected]: This version has been deprecated, please upgrade to the version tagged as latest
cmderr	[automation_init.sh] npm WARN @octokit/[email protected] requires a peer of @octokit/core@>=3 but none is installed. You must install peer dependencies yourself.
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json

️✔️@azure/device-update [View full logs] [Release SDK Changes]

error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.

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

openapi-workflow-bot · 2022-06-17T00:59:37Z

Hi @dpokluda, 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.
Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

openapi-workflow-bot · 2022-06-17T00:59:55Z

Hi @dpokluda, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

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

weidongxu-microsoft · 2022-06-17T01:41:49Z

Please do not modify package-lock.json in PR

…orty; removing to fix Linux filename casing issue).

.../deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json

weidongxu-microsoft

So far, no REST API change.

SDK in preview, so we can do breaking changes to SDK.

.../deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json

weidongxu-microsoft · 2022-06-28T02:20:18Z

package-lock.json

ideally this file should not be in commit.

How do I remove it from the commit? I reverted the changes I made.

git checkout main -- package-lock.json

then double check and commit the change, push. That should make it exactly same as main, and it should disappear from the PR.

mikekistler

There was a terminology issue raised in the SDK Arch Board review that seems to originate in the path structure of the REST API.

There are two "collections" (static path segments) that both use "deviceClassId" as the id:

deviceClasses
deviceClassSubgroups

If these are truly two distinct collections, they should have distinct ids. Conversely, if these are two different names for the same collection, then you should pick one name and use it consistently.

dpokluda · 2022-06-28T18:03:36Z

@mikekistler, the concepts are same but the two (device-class at the global level and device-class-subgroup at the group level represent slightly different set of devices). I have sent you a detailed e-mail describing the two concepts and their differences.

lmazuel

Approving that the content is valid Swagger and makes to me, I'm not judging the accuracy of the rename since I was not in archboard

lmazuel · 2022-07-01T20:25:51Z

@mikekistler I was told by @dpokluda that your "request-changes" was actually just a comment, therefore I'm ignoring it and merging to allow David to more forward. If you have concerns let me know. Thanks!

mikekistler · 2022-07-01T21:35:18Z

@lmazuel I must have pushed request changes by mistake. It is correct that this was just a comment. And I can't seem to undo it now so leaving this comment here "for the record".

Fixing endpoint url type and providing sdk client name for orderby.

a885ce3

dpokluda requested a review from a team as a code owner June 17, 2022 00:57

dpokluda requested review from BlackRider97 and weidongxu-microsoft and removed request for a team June 17, 2022 00:57

openapi-assignment-bot bot assigned jhendrixMSFT Jun 17, 2022

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Jun 17, 2022

openapi-pipeline-app bot added the CI-FixRequiredOnFailure label Jun 17, 2022

SDK review feedback plus removing two examples (I will re-add them sh…

c185208

…orty; removing to fix Linux filename casing issue).

openapi-pipeline-app bot removed the BreakingChangeReviewRequired label Jun 21, 2022

dpokluda added 4 commits June 21, 2022 16:20

Reverting package-lock.json change.

188d56f

Re-adding the two examples

1343c50

Update sample file casing.

e20993a

Another filename case mismatch fix.

47e97a5

openapi-pipeline-app bot added the BreakingChangeReviewRequired label Jun 21, 2022

Incorporating SDK review feedback into our swagger.

ba91ceb

azure-sdk mentioned this pull request Jun 23, 2022

[AutoPR azure-iot-deviceupdate] Device Update for IoT Hub swagger changes from SDK client library review. azure-sdk/azure-sdk-for-java#817

Closed

lmazuel reviewed Jun 27, 2022

View reviewed changes

.../deviceupdate/data-plane/Microsoft.DeviceUpdate/preview/2022-07-01-preview/deviceupdate.json Show resolved Hide resolved

weidongxu-microsoft reviewed Jun 28, 2022

View reviewed changes

mikekistler requested changes Jun 28, 2022

View reviewed changes

lmazuel approved these changes Jun 28, 2022

View reviewed changes

lmazuel merged commit b9b9192 into Azure:main Jul 1, 2022

dpokluda deleted the sdk-review-feedback branch July 8, 2022 22:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Device Update for IoT Hub swagger changes from SDK client library review. #19492

Device Update for IoT Hub swagger changes from SDK client library review. #19492

dpokluda commented Jun 17, 2022

openapi-workflow-bot bot commented Jun 17, 2022

openapi-pipeline-app bot commented Jun 17, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jun 17, 2022 •

edited

Loading

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 17, 2022

openapi-workflow-bot bot commented Jun 17, 2022

weidongxu-microsoft commented Jun 17, 2022

weidongxu-microsoft left a comment •

edited

Loading

weidongxu-microsoft Jun 28, 2022

dpokluda Jun 28, 2022

weidongxu-microsoft Jun 29, 2022 •

edited

Loading

mikekistler left a comment

dpokluda commented Jun 28, 2022

lmazuel left a comment

lmazuel commented Jul 1, 2022

mikekistler commented Jul 1, 2022

Device Update for IoT Hub swagger changes from SDK client library review. #19492

Device Update for IoT Hub swagger changes from SDK client library review. #19492

Conversation

dpokluda commented Jun 17, 2022

Changelog

Contribution checklist:

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Jun 17, 2022

openapi-pipeline-app bot commented Jun 17, 2022 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Jun 17, 2022 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-workflow-bot bot commented Jun 17, 2022

openapi-workflow-bot bot commented Jun 17, 2022

weidongxu-microsoft commented Jun 17, 2022

weidongxu-microsoft left a comment • edited Loading

Choose a reason for hiding this comment

weidongxu-microsoft Jun 28, 2022

Choose a reason for hiding this comment

dpokluda Jun 28, 2022

Choose a reason for hiding this comment

weidongxu-microsoft Jun 29, 2022 • edited Loading

Choose a reason for hiding this comment

mikekistler left a comment

Choose a reason for hiding this comment

dpokluda commented Jun 28, 2022

lmazuel left a comment

Choose a reason for hiding this comment

lmazuel commented Jul 1, 2022

mikekistler commented Jul 1, 2022

openapi-pipeline-app bot commented Jun 17, 2022 •

edited

Loading

openapi-pipeline-app bot commented Jun 17, 2022 •

edited

Loading

weidongxu-microsoft left a comment •

edited

Loading

weidongxu-microsoft Jun 29, 2022 •

edited

Loading