Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix DesktopVirtualization 2024-08-08-preview doc build #33070

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
+27 −52

Merge branch 'main' into yuxia-FixDocBuild

6091066
Select commit
Loading
Failed to load commit list.
Open

Fix DesktopVirtualization 2024-08-08-preview doc build #33070

Merge branch 'main' into yuxia-FixDocBuild
6091066
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Mar 7, 2025 in 4m 41s

Swagger LintDiff succeeded

LintDiff
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.3) new version base version
package-preview-2024-08 package-preview-2024-08(6091066) package-preview-2024-08(main)

The following errors/warnings exist before current PR submission:
Only 50 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-08-08-preview/desktopvirtualization.json#L132
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L885
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1768
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4534
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:hour.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4858
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:minute.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4858
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:rampUpStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4858
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:peakStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4858
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:rampDownStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4858
❌ PatchBodyParametersSchema Properties of a PATCH request body must not have default value, property:offPeakStartVMOnConnect.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L4858
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:hour.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L5187
❌ PatchBodyParametersSchema Properties of a PATCH request body must not be required, property:minute.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L5187
❌ PatchIdentityProperty The patch operation body parameter schema should contain property 'identity'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L5471
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L5944
❌ RequiredPropertiesMissingInResourceModel Model definition 'ResourceProviderOperationListResult' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L8930
❌ ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'ScalingPlanPooledSchedule'. Properties [properties.name] conflict with ARM top level properties. Please rename these.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L9614
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10257
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10344
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'SessionHostManagementUpdateStatus' has extra properties ['percentComplete'].
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10695
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'SessionHostManagementUpdateStatus' has extra properties ['startTime'].
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10695
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'SessionHostManagementUpdateStatus' has extra properties ['endTime'].
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10695
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'SessionHostManagementUpdateStatus' has extra properties ['error'].
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10695
❌ BodyTopLevelProperties Top level properties should be one of name, type, id, location, properties, tags, plan, sku, etag, managedBy, identity, zones. Model definition 'SessionHostManagementUpdateStatus' has extra properties ['status'].
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10695
❌ RequiredPropertiesMissingInResourceModel Model definition 'SessionHostManagementUpdateStatus' must have the properties 'name', 'id' and 'type' in its hierarchy and these properties must be marked as readonly.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L10695
⚠️ OperationIdNounConflictingModelNames 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/2024-08-08-preview/desktopvirtualization.json#L154
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L266
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L328
⚠️ OperationIdNounConflictingModelNames 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/2024-08-08-preview/desktopvirtualization.json#L409
⚠️ OperationIdNounConflictingModelNames 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/2024-08-08-preview/desktopvirtualization.json#L458
⚠️ OperationIdNounConflictingModelNames 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/2024-08-08-preview/desktopvirtualization.json#L505
⚠️ OperationIdNounConflictingModelNames 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/2024-08-08-preview/desktopvirtualization.json#L567
⚠️ OperationIdNounConflictingModelNames 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/2024-08-08-preview/desktopvirtualization.json#L623
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L648
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L709
⚠️ PatchSkuProperty The patch operation body parameter schema should contain property 'sku'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L885
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L998
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1327
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1527
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1592
⚠️ PatchSkuProperty The patch operation body parameter schema should contain property 'sku'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1768
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1824
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1955
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'expandmsiximage' in:'MsixImages_Expand'. Consider updating the operationId
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1956
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L1981
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L2015
⚠️ PostOperationIdContainsUrlVerb OperationId should contain the verb: 'importappattachpackageinfo' in:'AppAttachPackageInfo_Import'. Consider updating the operationId
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L2016
⚠️ ParameterDescription Parameter should have a description.
Location: Microsoft.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L2041
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L2158
⚠️ 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.DesktopVirtualization/preview/2024-08-08-preview/desktopvirtualization.json#L2487
⚠️ PutInOperationName 'PUT' operation 'PrivateEndpointConnections_UpdateByHostPool' should use method name 'Create'. 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/2024-08-08-preview/desktopvirtualization.json#L2583
View more details on openapi-pipeline-app