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

Jump to bottom

Imagebuilder API Release 2024-02-01 #28871

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from

adding 2024-02-01

a9d65a1
Select commit
Failed to load commit list.
Draft

Imagebuilder API Release 2024-02-01 #28871

adding 2024-02-01
a9d65a1
Select commit
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff failed Apr 29, 2024 in 3m 59s

Swagger LintDiff failed

LintDiff: 45 Errors, 22 Warnings
View Azure DevOps build log for more details.

Details

Compared specs (v2.2.0) new version base version
package-2024-02 package-2024-02(a9d65a1) default(main)

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

Rule Message Related RPC [For API reviewers]
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplates.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L70
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListImageTemplatesByRg.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L112
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateLinux.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L173
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateImageTemplateWindows.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L176
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateTags.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L232
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/UpdateImageTemplateToRemoveIdentities.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L235
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetImageTemplate.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L275
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteImageTemplate.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L325
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/RunImageTemplate.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L374
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CancelImageBuild.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L423
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListRunOutputs.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L468
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetRunOutput.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L513
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/ListTriggers.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L558
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/GetTrigger.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L603
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/CreateSourceImageTrigger.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L665
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/DeleteTrigger.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L718
❌ invalid-ref Could not read file: file:///mnt/vss/_work/1/azure-rest-api-specs/specification/imagebuilder/resource-manager/Microsoft.VirtualMachineImages/stable/2024-02-01/examples/OperationsList.json .
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L754
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L769		 RPC-Policy-V1-05, RPC-Put-V1-23
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1655		 RPC-Policy-V1-05, RPC-Put-V1-23
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1741		 RPC-Policy-V1-05, RPC-Put-V1-23


The following errors/warnings exist before current PR submission:

Rule Message
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L151
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L157
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L213
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L217
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L263
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L332
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L359
❌ PostResponseCodes Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L381
❌ LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L408
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L501
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L591
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L643
❌ ProvisioningStateMustBeReadOnly provisioningState property must be set to readOnly.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L649
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L740
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L769
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1175
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1193
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1217
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1287
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1593
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1694
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1741
❌ AvoidAdditionalProperties Definitions must not have properties named additionalProperties except for user defined tags or predefined references.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1780
❌ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2034
❌ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2084
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L945
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L950
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1116
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1121
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1202
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1233
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1543
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1547
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1567
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1571
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1576
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1599
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1753
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1774
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1800
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1894
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1934
⚠️ 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.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L1965
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'subscriptionId'.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2035
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2042
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'location'.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2077
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'api-version'.
Location: Microsoft.VirtualMachineImages/stable/2024-02-01/imagebuilder.json#L2085
View more details on openapi-pipeline-app