Skip to content

Conversation

@almat-msft
Copy link
Member

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix OpenAPI spec quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

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 ApiView comment 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
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copied the files in a separate commit.
This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2024-04-03 to preview/2024-04-08-preview.
@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 14, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 14, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️❌Breaking Change(Cross-Version): 20 Errors, 354 Warnings failed [Detail]
Compared specs (v0.10.9) new version base version
desktopvirtualization.json 2024-04-08-preview(1a7b4e5) 2024-04-03(main)
desktopvirtualization.json 2024-04-08-preview(1a7b4e5) 2024-03-06-preview(main)

The following breaking changes are detected by comparison with the latest stable version:

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

Rule Message
1034 - AddedRequiredProperty The new version has new required property 'type' that was not found in the old version.
New: common-types/resource-management/v6/managedidentity.json#L44:7
1034 - AddedRequiredProperty The new version has new required property 'type' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v5/types.json#L128:9
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L162:7
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v5/types.json#L135:9
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L190:7
1034 - AddedRequiredProperty The new version has new required property 'publisher' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L190:7
1034 - AddedRequiredProperty The new version has new required property 'product' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L190:7
1034 - AddedRequiredProperty The new version has new required property 'name, publisher, product' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v5/types.json#L142:9
1034 - AddedRequiredProperty The new version has new required property 'type' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v5/types.json#L128:9
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v5/types.json#L135:9
1034 - AddedRequiredProperty The new version has new required property 'name, publisher, product' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v5/types.json#L142:9
1034 - AddedRequiredProperty The new version has new required property 'type' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v5/types.json#L128:9
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v5/types.json#L135:9
1034 - AddedRequiredProperty The new version has new required property 'name, publisher, product' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v5/types.json#L142:9
1034 - AddedRequiredProperty The new version has new required property 'type' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v5/types.json#L128:9
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v5/types.json#L135:9
1034 - AddedRequiredProperty The new version has new required property 'name, publisher, product' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v5/types.json#L142:9
1034 - AddedRequiredProperty The new version has new required property 'type' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v5/types.json#L128:9
1034 - AddedRequiredProperty The new version has new required property 'name' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v5/types.json#L135:9
1034 - AddedRequiredProperty The new version has new required property 'name, publisher, product' that was not found in the old version.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v5/types.json#L142:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v5/types.json#L128:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v5/types.json#L135:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v5/types.json#L142:9


The following breaking changes are detected by comparison with the latest preview version:

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

Rule Message
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/operationStatuses/{operationId}' removed or restructured?
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L2905:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/operationStatuses' removed or restructured?
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L2950:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default/operationStatuses/{operationId}' removed or restructured?
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L3272:5
⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default/operationStatuses' removed or restructured?
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L3317:5
⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'HostPoolControlParameter' removed or renamed?
New: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L4913:3
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L5127:3
⚠️ 1009 - RemovedRequiredParameter The required parameter 'hostPoolControlParameter' was removed in the new version.
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L2863:11
⚠️ 1010 - AddingRequiredParameter The required parameter 'hostPoolUpdateControlParameter' was added in the new version.
New: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L2844:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '200'.
New: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L2807:11
⚠️ 1014 - RemovingHeader The new version removs a required header 'Azure-AsyncOperation'.
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L2881:15
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v1/types.json#L163:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v1/types.json#L170:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v1/types.json#L177:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v1/types.json#L163:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v1/types.json#L170:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v1/types.json#L177:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v1/types.json#L163:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v1/types.json#L170:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v1/types.json#L177:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L128:9
Old: common-types/resource-management/v1/types.json#L163:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L131:9
Old: common-types/resource-management/v1/types.json#L170:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: common-types/resource-management/v6/types.json#L134:9
Old: common-types/resource-management/v1/types.json#L177:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L6695:9
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L6998:9
⚠️ 1017 - ReferenceRedirection The '$ref' property points to different models in the old and new versions.
New: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L6579:9
Old: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json#L6883:9
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 339 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-preview-2024-04 package-preview-2024-04(1a7b4e5) default(main)

[must fix]The following errors/warnings are introduced by current PR:

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

Rule Message Related RPC [For API reviewers]
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L43
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L79
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L82
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L85
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L119
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L122
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L125
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L174
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L177
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L180
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L214
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L217
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L220
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L265
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L268
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L271
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L311
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L314
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L317
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of privatelinks.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L323
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L355
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L358
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L361


The following errors/warnings exist before current PR submission:

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

Rule Message
OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L50
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L225
PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'PrivateEndpointConnections_UpdateByWorkspace' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema'
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L386
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L386
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L773
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:hour.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1041
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:minute.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1041
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:hour.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1307
PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:minute.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1307
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:rampUpStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1307
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:peakStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1307
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:rampDownStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1307
PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:offPeakStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1307
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L1618
ConsistentPatchProperties The property 'tags' in the request body either not apppear in the resource model or has the wrong level.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L2007
ConsistentPatchProperties The property 'tags' in the request body either not apppear in the resource model or has the wrong level.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L2172
PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L2428
SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L3699
SubscriptionsAndResourceGroupCasing The path segment resourcegroups should be resourceGroups.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L3897
PutRequestResponseSchemeArm A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'PrivateEndpointConnections_UpdateByHostPool' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema'
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L4858
PutResponseCodes Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L4858
XmsEnumValidation The enum types should have x-ms-enum type extension set with appropriate options.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L8948
⚠️ PatchSkuProperty The patch operation body parameter schema should contain property 'sku'.
Location: Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json#L225
️❌Avocado: 4 Errors, 0 Warnings failed [Detail]
Rule Message
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DesktopVirtualization/hostPools/{}/sessionHostManagements/default/operationStatuses/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/desktopvirtualization/resource-manager/readme.md
json: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DesktopVirtualization/hostPools/{}/sessionHostManagements/default/operationStatuses is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/desktopvirtualization/resource-manager/readme.md
json: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DesktopVirtualization/hostPools/{}/sessionHostConfigurations/default/operationStatuses/{} is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/desktopvirtualization/resource-manager/readme.md
json: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json
MISSING_APIS_IN_DEFAULT_TAG The default tag should contain all APIs. The API path /subscriptions/{}/resourceGroups/{}/providers/Microsoft.DesktopVirtualization/hostPools/{}/sessionHostConfigurations/default/operationStatuses is not in the default tag. Please make sure the missing API swaggers are in the default tag.
readme: specification/desktopvirtualization/resource-manager/readme.md
json: Microsoft.DesktopVirtualization/preview/2024-03-06-preview/desktopvirtualization.json
️️✔️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.
️️✔️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]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 14, 2024

Swagger Generation Artifacts

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

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

Only 0 items are rendered, please refer to log for more details.

️❌ azure-resource-manager-schemas failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-powershell succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 14, 2024

@almat-msft
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@almat-msft
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@almat-msft
Copy link
Member Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@almat-msft almat-msft added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 3, 2024
@almat-msft
Copy link
Member Author

    "type": {

You should rename this as it conflicts with the ARM top level property names

Refers to: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json:7044 in 0110f47. [](commit_id = 0110f47, deletion_comment = False)

    "type": {

You should rename this as it conflicts with the ARM top level property names

Refers to: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json:7044 in 0110f47. [](commit_id = 0110f47, deletion_comment = False)

This is expected since it is a tracked resource

@almat-msft
Copy link
Member Author

secureBootEnabled

    "secureBootEnabled": {

Replace boolean/switch properties with a more meaningful enum whenever possible.

A boolean will forever have two valid values (true or false). Enums are always a more flexible and future proof option because they allow additional values to be added in the future in a non-breaking way, e.g. [Enabled, Disabled, Suspended, Deallocated].

For example two switches "isTypeA" and "isTypeB" should be replaced with one enum "type": [A, B, DefaultType].

Refers to: specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2024-04-08-preview/desktopvirtualization.json:7072 in 0110f47. [](commit_id = 0110f47, deletion_comment = False)

we are mirroring Compute here, and there is only that much that we can do

@AzureRestAPISpecReview AzureRestAPISpecReview added BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 3, 2024
@rkmanda rkmanda added BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. Approved-Suppression WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 4, 2024
Copy link
Member

@rkmanda rkmanda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@rkmanda rkmanda added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Jun 9, 2024
@openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Jun 9, 2024
@almat-msft
Copy link
Member Author

/pr RequestMerge

@ms-bogdan-rotaru
Copy link
Contributor

@almat-msft Although you requested to merge the PR, this cannot be done yet as there is one pending requested change which you have to close/address/etc.

@almat-msft almat-msft dismissed abatishchev’s stale review June 13, 2024 18:16

These have been addressed

@almat-msft almat-msft requested a review from msyyc June 13, 2024 23:10
@ms-bogdan-rotaru ms-bogdan-rotaru merged commit bbd815a into Azure:main Jun 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-Approved-Benign Changes are not breaking at the REST API level and have at most minor impact to generated SDKs. BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required new-api-version resource-manager SuppressionReviewRequired

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants