Alec baird desktopvirtualization microsoft.desktop virtualization 2023 10 04 preview #26142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…table/2023-09-05 to version 2023-10-04-preview
Next Steps to Merge✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM). |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| desktopvirtualization.json | 2023-10-04-preview(358648e) | 2023-09-05(main) |
| desktopvirtualization.json | 2023-10-04-preview(358648e) | 2023-07-07-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 1 Errors, 15 Warnings failed [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2023-10 | package-preview-2023-10(358648e) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3530 |
RPC-Patch-V1-11 |
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3256 |
||
| OperationId should contain the verb: 'importappattachpackageinfo' in:'AppAttachPackageInfo_Import'. Consider updating the operationId Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3260 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppAttachPackageModel'. Consider using the plural form of 'AppAttachPackage' 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3368 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppAttachPackageModel'. Consider using the plural form of 'AppAttachPackage' 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3408 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppAttachPackageModel'. Consider using the plural form of 'AppAttachPackage' 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3463 |
||
| 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3483 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppAttachPackageModel'. Consider using the plural form of 'AppAttachPackage' 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3510 |
||
| The patch operation body parameter schema should contain property 'sku'. Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3530 |
RPC-Patch-V1-09 | |
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppAttachPackageModel'. Consider using the plural form of 'AppAttachPackage' 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3561 |
||
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'AppAttachPackageModel'. Consider using the plural form of 'AppAttachPackage' 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L3610 |
||
| Use the latest version v5 of types.json. Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L5420 |
||
| Use the latest version v5 of types.json. Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L5428 |
||
| Use the latest version v5 of types.json. Location: Microsoft.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L5443 |
||
| 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L5575 |
||
| 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.DesktopVirtualization/preview/2023-10-04-preview/desktopvirtualization.json#L5580 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
AzureRestAPISpecReview
added
ARMReview
CI-MissingBaseCommit
new-api-version
resource-manager
WaitForARMFeedback
|
Hi @alec-baird! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. |
This was referenced Oct 9, 2023
That is correct, but if I remove the identity property to fix the duplicate issue, it causes a LintDiff error stating that PATCH needs to have an identity property. I would assume it is supposed to be taking the property from ResourceModelWithAllowedPropertySet, but it doesn't seem to like that. So I am stuck with either solution causing an error, with or without the property. @rkmanda asked if you could specify which exact lines are causing the duplicate error @raych1 . |
alec-baird
added
WaitForARMFeedback
|
With @rkmanda approval, we added a suppression for PatchIdentityProperty and are ready for ARM Review/merge. |
You can address this with your next api version but lets start an email thread or Team chat with Ray Chen to resolve this deadlock |
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
/pr RequestMerge |
rkmanda
approved these changes
Oct 31, 2023
|
/azp run TypeSpec Validation |
|
Azure Pipelines successfully started running 1 pipeline(s). |
rkmanda
deleted the
alec-baird-desktopvirtualization-Microsoft.DesktopVirtualization-2023-10-04-preview
branch
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
This was referenced Oct 31, 2023
jnlycklama
pushed a commit
that referenced
this pull request
Nov 8, 2023
…3 10 04 preview (#26142) * Adds base for updating Microsoft.DesktopVirtualization from version stable/2023-09-05 to version 2023-10-04-preview * Updates readme * Updates API version in new specs and examples * Added AppAttach endpoints to public preview * Added new examples * ran prettier on swagger and changed naming convention of examples * fixed bad list naming convention in swagger * Corrected most lint errors * Pattern and xmsidentifiers added * fixed camelcase and added patch properties as separate definition * ran prettify on examples * Updated patchable properties * Fixed AppAttachPackagePatch properties * Removed System data * updated examples * ran prettier * missed one prettier * Fixed bad api version * Added Charles additions to examples * Ran prettier * Fixed last few examples and ran prettier * Removed kind from examples * ARM PR Comments * Added swagger supression * Moved surpression to this version only * Added ids and prettier * updated to ResourceModelWithAllowedPropertySet * Added Patch info * Added Charles identity fix * Added identity property * removed all of * Changed back to v1 to fix compatibility errors * Removed identity property, used all of common-types * Added systemData to match other TLAO * Added identity * Removed identity because it causing breaking changes * Tried to add identity in proper place * Added identity to AppAttach, not Hostpool * Removed allOf to determine if that fixes lint error * separated Patch properties and re-added allOf * Added suppression for PatchIdentity
zman-ms
pushed a commit
that referenced
this pull request
Jan 10, 2024
…3 10 04 preview (#26142) * Adds base for updating Microsoft.DesktopVirtualization from version stable/2023-09-05 to version 2023-10-04-preview * Updates readme * Updates API version in new specs and examples * Added AppAttach endpoints to public preview * Added new examples * ran prettier on swagger and changed naming convention of examples * fixed bad list naming convention in swagger * Corrected most lint errors * Pattern and xmsidentifiers added * fixed camelcase and added patch properties as separate definition * ran prettify on examples * Updated patchable properties * Fixed AppAttachPackagePatch properties * Removed System data * updated examples * ran prettier * missed one prettier * Fixed bad api version * Added Charles additions to examples * Ran prettier * Fixed last few examples and ran prettier * Removed kind from examples * ARM PR Comments * Added swagger supression * Moved surpression to this version only * Added ids and prettier * updated to ResourceModelWithAllowedPropertySet * Added Patch info * Added Charles identity fix * Added identity property * removed all of * Changed back to v1 to fix compatibility errors * Removed identity property, used all of common-types * Added systemData to match other TLAO * Added identity * Removed identity because it causing breaking changes * Tried to add identity in proper place * Added identity to AppAttach, not Hostpool * Removed allOf to determine if that fixes lint error * separated Patch properties and re-added allOf * Added suppression for PatchIdentity
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequestedis removed from your PR. This should cause the label
WaitForARMFeedbackto be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting helpsection below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReviewlabel.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiViewcomment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.