PR for testing #2889
Closed
PR for testing #2889
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
Automation for azure-sdk-for-nodeA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Automation for azure-libraries-for-javaA PR has been created for you based on this PR content. Once this PR will be merged, content will be added to your service PR: |
Automation for azure-sdk-for-pythonA PR has been created for you: |
Automation for azure-sdk-for-goA PR has been created for you: |
AutoRest linter results for SDK Related Validation Errors/WarningsThese errors are reported by the SDK team's validation tools, reachout to ADX Swagger Reviewers directly for any questions or concerns. File: specification/compute/resource-manager/readme.md
|
| Code | Id | Source | Message |
|---|---|---|---|
| DescriptionAndTitleMissing | R4000 | Link | 'storageUri' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| DescriptionAndTitleMissing | R4000 | Link | 'nextLink' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| DescriptionAndTitleMissing | R4000 | Link | 'provisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| DescriptionAndTitleMissing | R4000 | Link | 'orchestratorProfile' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
❌2 new Errors.(12 total)
| Code | Id | Source | Message |
|---|---|---|---|
| XmsParameterLocation | R4001 | Link | The parameter 'resourceGroupName' 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". |
| XmsParameterLocation | R4001 | Link | The parameter 'diskName' 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". |
AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback
Thanks for your co-operation.
Result limit exceeded, check build outputThe linter diff produced too many results to display here. Please view the build output to see the results. For help with SDK-related validation Errors / Warnings, reach out to ADX Swagger Reviewers. For help with ARM-related validation Errors / Warnings, reach out to ARM RP API Review. View Build Output
AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback Thanks for your co-operation. |
AutoRest linter results for SDK-related validation Errors / WarningsThese errors are reported by the SDK team's validation tools, reach out to ADX Swagger Reviewers directly for any questions or concerns. Config file: specification/compute/resource-manager/readme.md
|
| Rule | Location | Message | |
|---|---|---|---|
| 1 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:787 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 2 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:805 | 'identifier' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 3 | R2018 - XmsEnumValidation | 2018-06-01/gallery.json:808 | The enum types should have x-ms-enum type extension set with appropriate options. Property name: provisioningState |
| 4 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:837 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 5 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:896 | 'identifier' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 6 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:899 | 'recommended' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 7 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:902 | 'disallowed' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 8 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:905 | 'purchasePlan' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 9 | R2018 - XmsEnumValidation | 2018-06-01/gallery.json:908 | The enum types should have x-ms-enum type extension set with appropriate options. Property name: provisioningState |
| 10 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:954 | 'vCPUs' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 11 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:957 | 'memory' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 12 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1009 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 13 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1023 | 'publishingProfile' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 14 | R2018 - XmsEnumValidation | 2018-06-01/gallery.json:1026 | The enum types should have x-ms-enum type extension set with appropriate options. Property name: provisioningState |
| 15 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1040 | 'storageProfile' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 16 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1044 | 'replicationStatus' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 17 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1063 | 'source' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 18 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1088 | 'managedImage' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 19 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1141 | 'osDiskImage' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 20 | R4000 - DescriptionAndTitleMissing | 2018-06-01/gallery.json:1329 | 'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 21 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'VirtualMachineImageResource' |
| 22 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'VirtualMachineImageResource' |
| 23 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 24 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 25 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 26 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 27 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 28 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 29 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 30 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 31 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 32 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 33 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 34 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 35 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
| 36 | S4002 - LocationMustHaveXmsMutability | 2017-01-31/containerService.json:267 | Property 'location' must have '"x-ms-mutability":["read", "create"]' extension defined. Resource Model: 'Resource' |
⚠️ 73 existing SDK Warnings
| Rule | Location | Message | |
|---|---|---|---|
| 1 | R4000 - DescriptionAndTitleMissing | 2017-09-01/skus.json:273 | 'ResourceSkuLocationInfo' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 2 | R4000 - DescriptionAndTitleMissing | 2017-09-01/skus.json:290 | 'ResourceSkuRestrictionInfo' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 3 | R2066 - PostOperationIdContainsUrlVerb | 2018-06-01/disk.json:290 | OperationId should contain the verb: 'begingetaccess' in:'Disks_GrantAccess'. Consider updating the operationId |
| 4 | R2066 - PostOperationIdContainsUrlVerb | 2018-06-01/disk.json:334 | OperationId should contain the verb: 'endgetaccess' in:'Disks_RevokeAccess'. Consider updating the operationId |
| 5 | R2066 - PostOperationIdContainsUrlVerb | 2018-06-01/disk.json:605 | OperationId should contain the verb: 'begingetaccess' in:'Snapshots_GrantAccess'. Consider updating the operationId |
| 6 | R2066 - PostOperationIdContainsUrlVerb | 2018-06-01/disk.json:649 | OperationId should contain the verb: 'endgetaccess' in:'Snapshots_RevokeAccess'. Consider updating the operationId |
| 7 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:720 | 'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 8 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:730 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 9 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:744 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 10 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:755 | 'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 11 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:1108 | 'access' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 12 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:1148 | 'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 13 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:1151 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 14 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:1165 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 15 | R4000 - DescriptionAndTitleMissing | 2018-06-01/disk.json:1176 | 'sku' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 16 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:355 | 'publisherName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 17 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:361 | 'type' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 18 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:367 | 'version' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 19 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:405 | 'publisherName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 20 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:446 | 'publisherName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 21 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:452 | 'type' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 22 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:465 | '$top' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 23 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:472 | '$orderby' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 24 | R2029 - PageableOperation | 2018-10-01/compute.json:715 | Based on the response model schema, operation 'VirtualMachineExtensions_List' might be pageable. Consider adding the x-ms-pageable extension. |
| 25 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:863 | '$top' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 26 | R4000 - ParameterDescriptionRequired | 2018-10-01/compute.json:870 | '$orderby' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. |
| 27 | R2063 - OperationIdNounConflictingModelNames | 2018-10-01/compute.json:1028 | OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'UsageModel'. Consider using the plural form of 'Usage' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. |
| 28 | R1005 - GetInOperationName | 2018-10-01/compute.json:1681 | 'GET' operation 'VirtualMachines_InstanceView' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. |
| 29 | R2029 - PageableOperation | 2018-10-01/compute.json:2453 | Based on the response model schema, operation 'VirtualMachineScaleSets_GetInstanceView' might be pageable. Consider adding the x-ms-pageable extension. |
| 30 | R1003 - ListInOperationName | 2018-10-01/compute.json:2804 | Since operation 'VirtualMachineScaleSets_GetOSUpgradeHistory' response has model definition 'x-ms-pageable', it should be of the form "_list". Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. |
| 31 | R2066 - PostOperationIdContainsUrlVerb | 2018-10-01/compute.json:3091 | OperationId should contain the verb: 'manualupgrade' in:'VirtualMachineScaleSets_UpdateInstances'. Consider updating the operationId |
| 32 | R2066 - PostOperationIdContainsUrlVerb | 2018-10-01/compute.json:3278 | OperationId should contain the verb: 'osrollingupgrade' in:'VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade'. Consider updating the operationId |
| 33 | R2066 - PostOperationIdContainsUrlVerb | 2018-10-01/compute.json:3318 | OperationId should contain the verb: 'extensionrollingupgrade' in:'VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade'. Consider updating the operationId |
| 34 | R1006 - PutInOperationName | 2018-10-01/compute.json:3589 | 'PUT' operation 'VirtualMachineScaleSetVMs_Update' 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. |
| 35 | R2066 - PostOperationIdContainsUrlVerb | 2018-10-01/compute.json:4088 | OperationId should contain the verb: 'getrequestratebyinterval' in:'LogAnalytics_ExportRequestRateByInterval'. Consider updating the operationId |
| 36 | R2066 - PostOperationIdContainsUrlVerb | 2018-10-01/compute.json:4142 | OperationId should contain the verb: 'getthrottledrequests' in:'LogAnalytics_ExportThrottledRequests'. Consider updating the operationId |
| 37 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4218 | 'display' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 38 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4317 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 39 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4335 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 40 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4448 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 41 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4601 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 42 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4615 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 43 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4694 | 'plan' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 44 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4697 | 'osDiskImage' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 45 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4700 | 'dataDiskImages' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 46 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:4711 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 47 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:5552 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 48 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:5891 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 49 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:5928 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 50 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6211 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 51 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6225 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 52 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6670 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 53 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6691 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 54 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6776 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 55 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6797 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 56 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6852 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 57 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6868 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 58 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:6986 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 59 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:7186 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 60 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:7219 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 61 | R2001 - AvoidNestedProperties | 2018-10-01/compute.json:7547 | Consider using x-ms-client-flatten to provide a better end user experience |
| 62 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:7653 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 63 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:7777 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 64 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:7994 | 'SubResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 65 | R4000 - DescriptionAndTitleMissing | 2018-10-01/compute.json:8003 | 'SubResourceReadOnly' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 66 | R2001 - AvoidNestedProperties | 2018-10-01/compute.json:8101 | Consider using x-ms-client-flatten to provide a better end user experience |
| 67 | R2029 - PageableOperation | 2018-10-01/runCommands.json:79 | Based on the response model schema, operation 'VirtualMachineRunCommands_Get' might be pageable. Consider adding the x-ms-pageable extension. |
| 68 | R1003 - ListInOperationName | 2018-10-01/runCommands.json:126 | Since operation 'VirtualMachines_RunCommand' response has model definition 'array', it should be of the form "_list". Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. |
| 69 | R1003 - ListInOperationName | 2018-10-01/runCommands.json:184 | Since operation 'VirtualMachineScaleSetVMs_RunCommand' response has model definition 'array', it should be of the form "_list". Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. |
| 70 | R4000 - DescriptionAndTitleMissing | 2018-10-01/runCommands.json:433 | 'RunCommandResult' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 71 | R2018 - XmsEnumValidation | 2017-01-31/containerService.json:352 | The enum types should have x-ms-enum type extension set with appropriate options. Property name: count |
| 72 | R4000 - DescriptionAndTitleMissing | 2017-01-31/containerService.json:529 | 'ContainerServiceDiagnosticsProfile' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
| 73 | R4000 - DescriptionAndTitleMissing | 2017-01-31/containerService.json:557 | 'properties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. |
AutoRest linter results for ARM-related validation Errors / Warnings
These errors are reported by the ARM team's validation tools, reach out to ARM RP API Review directly for any questions or concerns.
Config file: specification/compute/resource-manager/readme.md
❌ 2 new ARM Errors
| Rule | Location | Message | |
|---|---|---|---|
| 1 | R3016 - DefinitionsPropertiesNamesCamelCase | 2018-06-01/disk.json:867 | Property named: 'diskIOPSReadWrite', for definition: 'DiskProperties' must follow camelCase style. Example: 'diskIopsReadWrite'. |
| 2 | R3016 - DefinitionsPropertiesNamesCamelCase | 2018-06-01/disk.json:1010 | Property named: 'diskIOPSReadWrite', for definition: 'DiskUpdateProperties' must follow camelCase style. Example: 'diskIopsReadWrite'. |
❌ 12 existing ARM Errors
| Rule | Location | Message | |
|---|---|---|---|
| 1 | D5001 - XmsExamplesRequired | 2017-09-01/skus.json:38 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'ResourceSkus_List' |
| 2 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:103 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Update' |
| 3 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:182 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_Delete' |
| 4 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:286 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_GrantAccess' |
| 5 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:330 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Disks_RevokeAccess' |
| 6 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:418 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Update' |
| 7 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:497 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_Delete' |
| 8 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:601 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_GrantAccess' |
| 9 | D5001 - XmsExamplesRequired | 2018-06-01/disk.json:645 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'Snapshots_RevokeAccess' |
| 10 | D5001 - XmsExamplesRequired | 2018-10-01/compute.json:36 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. |
| 11 | D5001 - XmsExamplesRequired | 2018-10-01/runCommands.json:180 | Please provide x-ms-examples describing minimum/maximum property set for response/request payloads for operations. Operation: 'VirtualMachineScaleSetVMs_RunCommand' |
| 12 | R3026 - TrackedResourcePatchOperation | 2017-01-31/containerService.json:555 | Tracked resource 'ContainerService' must have patch operation that at least supports the update of tags. It's strongly recommended that the PATCH operation supports update of all mutable properties as well. |
⚠️ 12 new ARM Warnings
| Rule | Location | Message | |
|---|---|---|---|
| 1 | R3027 - TrackedResourceListByResourceGroup | 2018-06-01/gallery.json:835 | The tracked resource, 'GalleryImage', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 2 | R3028 - TrackedResourceListBySubscription | 2018-06-01/gallery.json:835 | The tracked resource, 'GalleryImage', must have a list by subscriptions operation. |
| 3 | R3027 - TrackedResourceListByResourceGroup | 2018-06-01/gallery.json:1007 | The tracked resource, 'GalleryImageVersion', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 4 | R3028 - TrackedResourceListBySubscription | 2018-06-01/gallery.json:1007 | The tracked resource, 'GalleryImageVersion', must have a list by subscriptions operation. |
| 5 | R3018 - EnumInsteadOfBoolean | 2018-06-01/gallery.json:1116 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: excludeFromLatest |
| 6 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5990 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticOSUpgrade |
| 7 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5994 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disableAutomaticRollback |
| 8 | R3010 - TrackedResourceListByImmediateParent | 2017-01-31/containerService.json:267 | The child tracked resource, 'versions' with immediate parent 'Image', must have a list by immediate parent operation. |
| 9 | R3010 - TrackedResourceListByImmediateParent | 2017-01-31/containerService.json:267 | The child tracked resource, 'extensions' with immediate parent 'VirtualMachineScaleSet', must have a list by immediate parent operation. |
| 10 | R3010 - TrackedResourceListByImmediateParent | 2017-01-31/containerService.json:267 | The child tracked resource, 'images' with immediate parent 'Gallery', must have a list by immediate parent operation. |
| 11 | R3010 - TrackedResourceListByImmediateParent | 2017-01-31/containerService.json:267 | The child tracked resource, 'virtualmachines' with immediate parent 'VirtualMachineScaleSet', must have a list by immediate parent operation. |
| 12 | R3010 - TrackedResourceListByImmediateParent | 2017-01-31/containerService.json:267 | The child tracked resource, 'extensions' with immediate parent 'VirtualMachine', must have a list by immediate parent operation. |
⚠️ 55 existing ARM Warnings
| Rule | Location | Message | |
|---|---|---|---|
| 1 | R3018 - EnumInsteadOfBoolean | 2018-06-01/disk.json:929 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled |
| 2 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:4315 | The tracked resource, 'AvailabilitySet', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 3 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:4430 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: vmScaleSetEnabled |
| 4 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:4434 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: supportsMultipleExtensions |
| 5 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:4464 | The tracked resource, 'VirtualMachineImageResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 6 | R3028 - TrackedResourceListBySubscription | 2018-10-01/compute.json:4464 | The tracked resource, 'VirtualMachineImageResource', must have a list by subscriptions operation. |
| 7 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:4542 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion |
| 8 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:4584 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion |
| 9 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:4599 | The tracked resource, 'VirtualMachineExtension', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 10 | R3028 - TrackedResourceListBySubscription | 2018-10-01/compute.json:4599 | The tracked resource, 'VirtualMachineExtension', must have a list by subscriptions operation. |
| 11 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:4805 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: overwriteVhds |
| 12 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5123 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled |
| 13 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5227 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: writeAcceleratorEnabled |
| 14 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5273 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: writeAcceleratorEnabled |
| 15 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5319 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: ultraSSDEnabled |
| 16 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5404 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: provisionVMAgent |
| 17 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5408 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAutomaticUpdates |
| 18 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5457 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: disablePasswordAuthentication |
| 19 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5465 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: provisionVMAgent |
| 20 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5534 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: allowExtensionOperations |
| 21 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5543 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary |
| 22 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5578 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled |
| 23 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:5724 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isCustomerInitiatedMaintenanceAllowed |
| 24 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:5885 | The tracked resource, 'VirtualMachine', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 25 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6184 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneResilient |
| 26 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6383 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: writeAcceleratorEnabled |
| 27 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6435 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: writeAcceleratorEnabled |
| 28 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6477 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: writeAcceleratorEnabled |
| 29 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6556 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary |
| 30 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6613 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary |
| 31 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6705 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary |
| 32 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6709 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAcceleratedNetworking |
| 33 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6728 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableIPForwarding |
| 34 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6740 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: primary |
| 35 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6744 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableAcceleratedNetworking |
| 36 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6763 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableIPForwarding |
| 37 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:6960 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: autoUpgradeMinorVersion |
| 38 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:7130 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: overprovision |
| 39 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:7139 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: singlePlacementGroup |
| 40 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:7143 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: zoneBalance |
| 41 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:7165 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: overprovision |
| 42 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:7169 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: singlePlacementGroup |
| 43 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:7176 | The tracked resource, 'VirtualMachineScaleSet', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 44 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:7586 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: latestModelApplied |
| 45 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:7641 | The tracked resource, 'VirtualMachineScaleSetVM', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 46 | R3027 - TrackedResourceListByResourceGroup | 2018-10-01/compute.json:7775 | The tracked resource, 'RollingUpgradeStatusInfo', must have a list by resource group operation.(This rule does not apply for tenant level resources.) |
| 47 | R3028 - TrackedResourceListBySubscription | 2018-10-01/compute.json:7775 | The tracked resource, 'RollingUpgradeStatusInfo', must have a list by subscriptions operation. |
| 48 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:8015 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: walkPerformed |
| 49 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:8079 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: groupByThrottlePolicy |
| 50 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:8083 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: groupByOperationName |
| 51 | R3018 - EnumInsteadOfBoolean | 2018-10-01/compute.json:8087 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: groupByResourceName |
| 52 | R2004 - NonApplicationJsonType | 2018-10-01/runCommands.json:14 | Only 'application/json' content-type is supported by ARM. |
| 53 | R2004 - NonApplicationJsonType | 2018-10-01/runCommands.json:18 | Only 'application/json' content-type is supported by ARM. |
| 54 | R3018 - EnumInsteadOfBoolean | 2018-10-01/runCommands.json:300 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: required |
| 55 | R3018 - EnumInsteadOfBoolean | 2017-01-31/containerService.json:540 | Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled |
AutoRest Linter Guidelines | AutoRest Linter Issues | Send feedback
Thanks for your co-operation.
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.
This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.
PR information
api-versionin the path should match theapi-versionin the spec).Quality of Swagger