[Hub Generated] Review request for Microsoft.DeviceUpdate to add version stable/2023-07-01 #24311

Sedols · 2023-06-06T04:15:36Z

This is a PR generated at OpenAPI Hub. You can view your work branch via this link.

ARM API Information (Control Plane)

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
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.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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 apply 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

…22-12-01-preview to version 2023-07-01

openapi-workflow-bot · 2023-06-06T04:15:39Z

Hi, @Sedols 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 · 2023-06-06T04:15:40Z

Swagger Validation Report

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

There are no breaking changes.

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

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
deviceupdate.json	2023-07-01(0c86c49)	2022-10-01(main)
deviceupdate.json	2023-07-01(0c86c49)	2022-12-01-preview(main)
privatelinks.json	2023-07-01(0c86c49)	2022-10-01(main)
privatelinks.json	2023-07-01(0c86c49)	2022-12-01-preview(main)

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

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
package-2023-07-01	package-2023-07-01(0c86c49)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` XmsParameterLocation	The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.DeviceUpdate/stable/2023-07-01/deviceupdate.json#L1936
`❌` XmsParameterLocation	The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.DeviceUpdate/stable/2023-07-01/deviceupdate.json#L1943
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.DeviceUpdate/stable/2023-07-01/deviceupdate.json#L1397
⚠️ EnumInsteadOfBoolean	Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.DeviceUpdate/stable/2023-07-01/deviceupdate.json#L1479

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

Validation passes for Avocado.

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

Rule	Message
`❌` API Readiness check failed. Please make sure your service is deployed.	"code: InvalidResourceType, message: The resource type 'operations' could not be found in the namespace 'Microsoft.DeviceUpdate' for api version '2023-07-01'. The supported api-versions are '2020-03-01-preview, 2022-04-01-preview, 2022-10-01, 2022-12-01-preview'."

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

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

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

️️✔️TypeSpec Validation succeeded [Detail] [Expand]

Validation passes for TypeSpec Validation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

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

openapi-pipeline-app · 2023-06-06T04:15:40Z

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-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from dedb2ee. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.DeviceUpdate [View full logs] [Release SDK Changes]
- Azure.ResourceManager.DeviceUpdate.1.0.0-alpha.20230616.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs]Release - Generate from dedb2ee. 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] npm notice
cmderr	[automation_generate.sh] npm notice New minor version of npm available! 9.5.1 -> 9.7.1
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.7.1>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-deviceupdate [View full logs] [Release SDK Changes]
- azure-mgmt-deviceupdate-1.0.0b1.zip
- azure_mgmt_deviceupdate-1.0.0b1-py3-none-any.whl
```
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model Account has a new parameter encryption
```

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

️✔️Succeeded [Logs]Release - Generate from dedb2ee. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/deviceupdate/armdeviceupdate [View full logs] [Release SDK Changes]

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New struct `Encryption`
info	[Changelog] - New field `Encryption` in struct `AccountProperties`
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 3 additive change(s).

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs]Release - Generate from dedb2ee. SDK Automation 14.0.0

command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
SSL error: syscall failure: Broken pipe
Error: SSL error: syscall failure: Broken pipe

️✔️Az.deviceupdate.DefaultTag [View full logs]

Az.DeviceUpdate.0.1.0.nupkg

error	Fatal error: SSL error: syscall failure: Broken pipe
error	The following packages are still pending:
error		Az.deviceupdate.DefaultTag

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

openapi-pipeline-app · 2023-06-06T04:15:41Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/deviceupdate/armdeviceupdate	https://apiview.dev/Assemblies/Review/d8a57b3b5daf44399fb937b81b24c82c
.Net	Azure.ResourceManager.DeviceUpdate	https://apiview.dev/Assemblies/Review/35c3bb815e5c4c9bb23342f5b3b531c9

v-jiaodi · 2023-06-06T05:46:46Z

@Sedols please fix CI check error.

Sedols · 2023-06-06T17:12:56Z

@v-jiaodi I am left with API readiness check, which is expected because the version is not live yet in code (we are behind RPaaS). The Azure powershell failure I have no clue, I did not change anything for this version just removing the -preview from the version string. I see other RPs also having this pipeline failing.

v-jiaodi · 2023-06-07T02:20:48Z

@v-jiaodi I am left with API readiness check, which is expected because the version is not live yet in code (we are behind RPaaS). The Azure powershell failure I have no clue, I did not change anything for this version just removing the -preview from the version string. I see other RPs also having this pipeline failing.

@Sedols The azure-powershell error can be ignored. Waiting for ARM team review.

Sedols · 2023-06-08T03:27:23Z

@v-jiaodi is there anything else needed for merge? Thank you!

weidongxu-microsoft · 2023-06-08T05:57:02Z

@Sedols

Do you have schedule when this api-version will be rollout?

We do not want to merge too early (your version is 07-01). Upon merge to main, the API is public (means it be ready to use), and shows in mslearn, and user may start calling it.

Sedols · 2023-06-08T16:47:48Z

@weidongxu-microsoft we were planning to start the manifest rollout sometime next week, so it would light up in ARM in ~ 2 weeks. Is having a July version an issue for that?

Sedols · 2023-06-09T17:54:25Z

@v-jiaodi is the July issue blocking if the version lights up second part of June, or should I re-name it to 2023-06-01?

weidongxu-microsoft · 2023-06-12T02:19:51Z

@weidongxu-microsoft we were planning to start the manifest rollout sometime next week, so it would light up in ARM in ~ 2 weeks. Is having a July version an issue for that?

@Sedols I think 07-01 should be fine. I don't think it an issue if just off by half a month.

I'm fine if merge to rollout is about 1 or 2 weeks (just make it clear when you ask for SDK release, to avoid release a SDK that not work). Ping me again when you are ready to merge.

Sedols · 2023-06-15T16:59:13Z

@weidongxu-microsoft / @v-jiaodi we are ready for the rollout, you can please merge the PR.

…ion stable/2023-07-01 (Azure#24311) * Adds base for updating Microsoft.DeviceUpdate from version preview/2022-12-01-preview to version 2023-07-01 * Updates readme * Updates API version in new specs and examples * Fix tag in readme.md

Sedols added 3 commits June 5, 2023 21:14

Adds base for updating Microsoft.DeviceUpdate from version preview/20…

fb50bb9

…22-12-01-preview to version 2023-07-01

Updates readme

477d4a3

Updates API version in new specs and examples

0a9b7c9

AzureRestAPISpecReview added new-api-version resource-manager RPaaS labels Jun 6, 2023

Sedols marked this pull request as ready for review June 6, 2023 04:21

openapi-assignment-bot bot assigned v-jiaodi Jun 6, 2023

Fix tag in readme.md

0c86c49

azure-sdk mentioned this pull request Jun 6, 2023

[AutoPR sdk/resourcemanager/deviceupdate/armdeviceupdate] [Hub Generated] Review request for Microsoft.DeviceUpdate to add version stable/2023-07-01 azure-sdk/azure-sdk-for-go#6023

Closed

AzureRestAPISpecReview added ARMReview ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 6, 2023

ms-zhenhua 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 Jun 7, 2023

v-jiaodi approved these changes Jun 8, 2023

View reviewed changes

v-jiaodi added the Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates label Jun 8, 2023

weidongxu-microsoft merged commit dedb2ee into main Jun 16, 2023

weidongxu-microsoft deleted the Sedols-deviceupdate-Microsoft.DeviceUpdate-2023-07-01 branch June 16, 2023 01:50

[Hub Generated] Review request for Microsoft.DeviceUpdate to add version stable/2023-07-01 #24311

[Hub Generated] Review request for Microsoft.DeviceUpdate to add version stable/2023-07-01 #24311

Uh oh!

Conversation

Sedols commented Jun 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

Uh oh!

openapi-workflow-bot bot commented Jun 6, 2023

Uh oh!

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

Uh oh!

Generated ApiView

Uh oh!

v-jiaodi commented Jun 6, 2023

Uh oh!

Sedols commented Jun 6, 2023

Uh oh!

v-jiaodi commented Jun 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sedols commented Jun 8, 2023

Uh oh!

weidongxu-microsoft commented Jun 8, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sedols commented Jun 8, 2023

Uh oh!

Sedols commented Jun 9, 2023

Uh oh!

weidongxu-microsoft commented Jun 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Sedols commented Jun 15, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Sedols commented Jun 6, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 6, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 6, 2023 •

edited

Loading

openapi-pipeline-app bot commented Jun 6, 2023 •

edited

Loading

v-jiaodi commented Jun 7, 2023 •

edited

Loading

weidongxu-microsoft commented Jun 8, 2023 •

edited

Loading

weidongxu-microsoft commented Jun 12, 2023 •

edited

Loading