azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Published
20 hours ago •
Azure
Azure
connectedvmware: fixing Swagger inconsistencies
Unblocks https://github.com/hashicorp/pandora/pull/1740
This PR fixes inconsistencies within the connectedvmware Swagger, where the URI Segments are inconsistent
Hi, @tombuildsstuff Thanks for your PR. I am workflow bot for review process. Here are some small tips.
![openapi-workflow-bot[bot] avatar](https://avatars.githubusercontent.com/in/81125?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 8 Errors, 0 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.1)] | new version | base version |
|---|---|---|
| connectedvmware.json | 2022-01-10-preview(bf128e1) | 2022-01-10-preview(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌LintDiff: 3 Errors, 0 Warnings failed [Detail]
| compared tags (via openapi-validator v1.13.0) | new version | base version |
|---|---|---|
| package-2022-01-10-preview | package-2022-01-10-preview(bf128e1) | package-2022-01-10-preview(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
|
The parameters:resourceGroupName,name,extensionName should be kept in the same order as they present in the path. Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3510 |
|
|
The parameters:resourceGroupName,name,extensionName should be kept in the same order as they present in the path. Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3577 |
|
|
The parameters:resourceGroupName,name,extensionName should be kept in the same order as they present in the path. Location: Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json#L3632 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️❌ModelValidation: 38 Errors, 0 Warnings failed [Detail]
Only 30 items are listed, please refer to log for more details.
️❌SemanticValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Generation Artifacts
️️✔️ApiDocPreview succeeded [Detail] [Expand]
Please click here to preview with your @microsoft account.
️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]
Breaking Changes Tracking
️❌ azure-sdk-for-python-track2 failed [Detail]
❌Failed [Logs] Generate from ed6827e9b1108a5b75762bd5dd67b3b4b3ad8c19. SDK Automation 14.0.0command sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json cmderr [automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed. command sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json cmderr [automation_generate.sh] cmderr [automation_generate.sh] npm notice New minor version of npm available! 8.15.0 -> 8.19.2 cmderr [automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v8.19.2> cmderr [automation_generate.sh] npm notice Run `npm install -g [email protected]` to update! cmderr [automation_generate.sh] npm notice cmdout [automation_generate.sh] [Autorest] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json:3439:5 cmdout [automation_generate.sh] [Autorest] fatal | Process() cancelled due to failure cmdout [automation_generate.sh] [Autorest] warning | IgnoredPropertyNextToRef | Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > GuestAgentProperties > properties > provisioningAction) cmdout [automation_generate.sh] [Autorest] keys: [ [32m'type'[39m ] cmdout [automation_generate.sh] [Autorest] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json:6907:9 cmdout [automation_generate.sh] [Autorest] error | Error: Semantic validation failed. There was some errors cmdout [automation_generate.sh] [Autorest] error | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing. cmdout [automation_generate.sh] [Autorest] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json:3439:5 cmdout [automation_generate.sh] [Autorest] fatal | Process() cancelled due to failure cmdout [automation_generate.sh] [Autorest] warning | IgnoredPropertyNextToRef | Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > GuestAgentProperties > properties > provisioningAction) cmdout [automation_generate.sh] [Autorest] keys: [ [32m'type'[39m ] cmdout [automation_generate.sh] [Autorest] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json:6907:9 cmdout [automation_generate.sh] [Autorest] error | Error: Semantic validation failed. There was some errors cmdout [automation_generate.sh] [Autorest] error | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing. cmdout [automation_generate.sh] [Autorest]/mnt/vss/_work/1/s/azure-sdk-for-python_tmp/venv-sdk/auto_temp.json does not exist!!!Error happened during codegen error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh warn Skip package processing as generation is failed
️❌ azure-sdk-for-java failed [Detail]
❌Failed [Logs] Generate from ed6827e9b1108a5b75762bd5dd67b3b4b3ad8c19. SDK Automation 14.0.0command ./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json command ./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
❌azure-resourcemanager-connectedvmware [View full logs] [Preview SDK Changes]
️❌ azure-sdk-for-go failed [Detail]
❌Failed [Logs] Generate from ed6827e9b1108a5b75762bd5dd67b3b4b3ad8c19. SDK Automation 14.0.0command sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json command generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json cmderr [generator automation-v2] [ERROR] total 1 error(s): cmderr [generator automation-v2] [ERROR] failed to execute `go generate` '[33;1mWARNING: Unable to find version for /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/connectedvmware/armconnectedvmware[0m cmderr [generator automation-v2] [ERROR] Cannot find go module under resourcemanager/connectedvmware/armconnectedvmware, try to build in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/connectedvmware/armconnectedvmware cmderr [generator automation-v2] [ERROR] ##[command]Cleaning auto-generated files in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/connectedvmware/armconnectedvmware cmderr [generator automation-v2] [ERROR] ##[command]Executing autorest.go in /mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/connectedvmware/armconnectedvmware cmderr [generator automation-v2] [ERROR] autorest --version=3.8.2 --use=@autorest/[email protected] --go --track2 --output-folder=/mnt/vss/_work/1/s/azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/connectedvmware/armconnectedvmware --clear-output-folder=false --go.clear-output-folder=false --honor-body-placement=true --remove-unreferenced-types=false ./autorest.md cmderr [generator automation-v2] [ERROR] AutoRest code generation utility [cli version: 3.6.1; node: v14.20.1] cmderr [generator automation-v2] [ERROR] (C) 2018 Microsoft Corporation. cmderr [generator automation-v2] [ERROR] https://aka.ms/autorest cmderr [generator automation-v2] [ERROR] info | AutoRest core version selected from configuration: 3.8.2. cmderr [generator automation-v2] [ERROR] There is a new version of AutoRest available (3.6.2). cmderr [generator automation-v2] [ERROR] > You can install the newer version with with npm install -g autorest@latest cmderr [generator automation-v2] [ERROR] info | Loading AutoRest core '/home/cloudtest/.autorest/@[email protected]/nodemodules/@autorest/core/dist' (3.8.2) cmderr [generator automation-v2] [ERROR] info | Installing AutoRest extension '@autorest/go' (4.0.0-preview.44 -> 4.0.0-preview.44) cmderr [generator automation-v2] [ERROR] info | Installed AutoRest extension '@autorest/go' (4.0.0-preview.44->4.0.0-preview.44) cmderr [generator automation-v2] [ERROR] info | Installing AutoRest extension '@autorest/modelerfour' (4.23.1 -> 4.23.1) cmderr [generator automation-v2] [ERROR] info | Installed AutoRest extension '@autorest/modelerfour' (4.23.1->4.23.1) cmderr [generator automation-v2] [ERROR] error | PathParameterMissingDefinition | Semantic violation: Path parameter 'virtualMachineName' referenced in path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/extensions/{extensionName}' needs to be defined in every operation at either the path or operation level. (Missing in 'patch', 'delete', 'get') (paths > /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/extensions/{extensionName}) cmderr [generator automation-v2] [ERROR] paramName: [32m'virtualMachineName'[39m cmderr [generator automation-v2] [ERROR] uri: [32m'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/extensions/{extensionName}'[39m cmderr [generator automation-v2] [ERROR] methods: [ [32m'patch'[39m, [32m'delete'[39m, [32m'get'[39m ] cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json:3439:5 cmderr [generator automation-v2] [ERROR] fatal | Process() cancelled due to failure cmderr [generator automation-v2] [ERROR] warning | IgnoredPropertyNextToRef | Semantic violation: Sibling values alongside $ref will be ignored. See https://github.com/Azure/autorest/blob/main/docs/openapi/howto/$ref-siblings.md for allowed values (components > schemas > GuestAgentProperties > properties > provisioningAction) cmderr [generator automation-v2] [ERROR] keys: [ [32m'type'[39m ] cmderr [generator automation-v2] [ERROR] - file:///mnt/vss/_work/1/s/azure-rest-api-specs/specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/preview/2022-01-10-preview/connectedvmware.json:6907:9 cmderr [generator automation-v2] [ERROR] error | Error: Semantic validation failed. There was some errors cmderr [generator automation-v2] [ERROR] error | Autorest completed with an error. If you think the error message is unclear, or is a bug, please declare an issues at https://github.com/Azure/autorest/issues with the error message you are seeing. cmderr [generator automation-v2] [ERROR] ##[error]Error running autorest.go cmderr [generator automation-v2] [ERROR] build.go:5: running "pwsh": exit status 1 cmderr [generator automation-v2] [ERROR] ': exit status 1 error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-go/src/github.com/Azure/azure-sdk-for-go]: generator automation-v2 warn Skip package processing as generation is failed
️❌ azure-sdk-for-js failed [Detail]
❌Failed [Logs] Generate from ed6827e9b1108a5b75762bd5dd67b3b4b3ad8c19. SDK Automation 14.0.0command sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json warn File azure-sdk-for-js_tmp/initOutput.json not found to read command sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json cmderr [automation_generate.sh] [ERROR] An error occurred while generating codes for readme file: "specification/connectedvmware/resource-manager/readme.md": cmderr [automation_generate.sh] [ERROR] Err: Error: Command failed: autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/connectedvmware/resource-manager/readme.md --use=@autorest/[email protected] cmderr [automation_generate.sh] [ERROR] Stderr: "null" cmderr [automation_generate.sh] [ERROR] Stdout: "null" cmderr [automation_generate.sh] [ERROR] ErrorStack: "Error: Command failed: autorest --version=3.8.4 --typescript --modelerfour.lenient-model-deduplication --azure-arm --head-as-boolean=true --license-header=MICROSOFT_MIT_NO_VERSION --generate-test --typescript-sdks-folder=/mnt/vss/_work/1/s/azure-sdk-for-js ../azure-rest-api-specs/specification/connectedvmware/resource-manager/readme.md --use=@autorest/[email protected] cmderr [automation_generate.sh] [ERROR] at checkExecSyncError (child_process.js:790:11) cmderr [automation_generate.sh] [ERROR] at Object.execSync (child_process.js:863:15) cmderr [automation_generate.sh] [ERROR] at Object.<anonymous> (/opt/hostedtoolcache/node/14.20.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:39:33) cmderr [automation_generate.sh] [ERROR] at Generator.next (<anonymous>) cmderr [automation_generate.sh] [ERROR] at /opt/hostedtoolcache/node/14.20.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:115:75 cmderr [automation_generate.sh] [ERROR] at new Promise (<anonymous>) cmderr [automation_generate.sh] [ERROR] at Object.__awaiter (/opt/hostedtoolcache/node/14.20.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/node_modules/tslib/tslib.js:111:16) cmderr [automation_generate.sh] [ERROR] at Object.generateMgmt (/opt/hostedtoolcache/node/14.20.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/hlc/generateMgmt.js:20:20) cmderr [automation_generate.sh] [ERROR] at /opt/hostedtoolcache/node/14.20.1/x64/lib/node_modules/@azure-tools/js-sdk-release-tools/dist/autoGenerateInPipeline.js:34:34 cmderr [automation_generate.sh] [ERROR] at Generator.next (<anonymous>)" error Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js]: sh .scripts/automation_generate.sh warn Skip package processing as generation is failed
️❌ azure-powershell failed [Detail]
❌Failed [Logs] Generate from ed6827e9b1108a5b75762bd5dd67b3b4b3ad8c19. SDK Automation 14.0.0command sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json command pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
❌Az.connectedvmware [View full logs] [Preview SDK Changes]
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon.
Hi @tombuildsstuff, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.
| Task | How to fix | Priority |
|---|---|---|
| Avocado | Fix-Avocado | High |
| Semantic validation | Fix-SemanticValidation-Error | High |
| Model validation | Fix-ModelValidation-Error | High |
| LintDiff | Fix-LintDiff | high |
Hi @tombuildsstuff, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review. Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki. If you want to know the production traffic statistic, please see ARM Traffic statistic. If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove ARMChangesRequested
Ping @lirenhe , is there any update on this PR? This is a blocking issue for us. Thanks!
Ping @lirenhe , is there any update on this PR? This is a blocking issue for us. Thanks!
We need to required tool check pass before merging this PR and there are a lot of failures. Please check How to fix?
Hi, @tombuildsstuff. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.
Please fix the tool validation errors especially the schema validtion errors. Looks for the patch operation, paramter name of 'name' is not updated.