fix model validations #23156

grizzlytheodore · 2023-03-17T15:27:17Z

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

openapi-workflow-bot · 2023-03-17T15:27:20Z

Hi, @grizzlytheodore Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-03-17T15:27:21Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️LintDiff succeeded [Detail] [Expand]

Validation passes for LintDiff.

️⚠️Avocado: 1 Warnings warning [Detail]

Rule	Message
⚠️ MULTIPLE_API_VERSION	The default tag contains multiple API versions swaggers. readme: specification/compute/resource-manager/readme.md tag: specification/compute/resource-manager/readme.md#tag-package-2023-01-02

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-03-17T15:27:22Z

Swagger Generation Artifacts

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

️⚠️SDK Breaking Change Tracking warning [Detail]

Breaking Changes Tracking

⚠️azure-sdk-for-go - sdk/resourcemanager/compute/armcompute - 5.0.0

+	Field `ID` of struct `VirtualMachineScaleSetIPConfiguration` has been removed
+	Field `ID` of struct `VirtualMachineScaleSetNetworkConfiguration` has been removed

⚠️azure-sdk-for-python-track2 - track2_azure-mgmt-compute - 29.2.0b1

+	Model VirtualMachineScaleSetIPConfiguration no longer has parameter id
+	Model VirtualMachineScaleSetNetworkConfiguration no longer has parameter id

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

️✔️Succeeded [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json

️✔️Azure.ResourceManager.Compute [View full logs] [Preview SDK Changes]
- Azure.ResourceManager.Compute.1.2.0-alpha.20230317.1.nupkg
```
info	[Changelog]
```

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

⚠️Warning [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. SDK Automation 14.0.0

command	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 major version of npm available! 8.19.3 -> 9.6.2
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.2>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.2` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-compute [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter computer_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter hyper_v_generation
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_name
info	[Changelog]   - Model VirtualMachineScaleSetVMInstanceView has a new parameter os_version
info	[Changelog]
info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog]   - Model VirtualMachineScaleSetIPConfiguration no longer has parameter id
info	[Changelog]   - Model VirtualMachineScaleSetNetworkConfiguration no longer has parameter id

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

️✔️Succeeded [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. SDK Automation 14.0.0

command	./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-compute-generated [View full logs] [Preview SDK Changes]

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

️✔️Succeeded [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. SDK Automation 14.0.0

command	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

️✔️@azure/arm-compute [View full logs] [Preview SDK Changes]

azure-arm-compute-20.1.0.tgz

info	[Changelog] **Features**
info	[Changelog]
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter computerName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter hyperVGeneration
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osName
info	[Changelog]   - Interface VirtualMachineScaleSetVMInstanceView has a new optional parameter osVersion
info	[Changelog]   - Enum KnownStorageAccountType has a new value StandardSSDLRS

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

️✔️Succeeded [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. SDK Automation 14.0.0

command	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

️✔️sdk/resourcemanager/compute/armcompute [View full logs] [Preview SDK Changes] Breaking Change Detected

info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetIPConfiguration` has been removed
info	[Changelog] - Field `ID` of struct `VirtualMachineScaleSetNetworkConfiguration` has been removed
info	[Changelog]
info	[Changelog] ### Features Added
info	[Changelog]
info	[Changelog] - New value `StorageAccountTypeStandardSSDLRS` added to type alias `StorageAccountType`
info	[Changelog] - New field `ComputerName` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog] - New field `HyperVGeneration` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog] - New field `OSName` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog] - New field `OSVersion` in struct `VirtualMachineScaleSetVMInstanceView`
info	[Changelog]
info	[Changelog] Total 2 breaking change(s), 2 additive change(s).

️⚠️ azure-resource-manager-schemas warning [Detail]

⚠️Warning [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. Schema Automation 14.0.0

command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
cmderr	[initScript.sh]  old lockfile
cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
cmderr	[initScript.sh] npm WARN old lockfile
cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
cmderr	[initScript.sh] npm WARN old lockfile
warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json

️✔️compute [View full logs] [Preview Schema Changes]

️❌ azure-powershell failed [Detail]

❌Pipeline Framework Failed [Logs] Generate from 52b831d86ee2998d5806d71151c7cca8e3487912. SDK Automation 14.0.0

command	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
error	Fatal error: Cannot read properties of undefined (reading '0')
Cannot read properties of undefined (reading '0')
TypeError: Cannot read properties of undefined (reading '0')
    at Object.exports.getPackageData (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/types/PackageData.js:33:43)
    at /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:210:194
    at Array.map (<anonymous>)
    at workflowHandleReadmeMdOrCadlProject (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:210:164)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)
    at async Object.exports.workflowMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/workflow.js:94:9)
    at async Object.exports.sdkAutoMain (/mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/automation/entrypoint.js:191:13)
    at async /mnt/vss/_work/1/a/unified-pipeline-runtime/private/openapi-sdk-automation/lib/cli/cli.js:20:18

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-03-17T15:27:23Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/compute/armcompute	Create ApiView failed. Please ask PR assignee for help
Java	azure-resourcemanager-compute-generated	https://apiview.dev/Assemblies/Review/a05294c7691d408f9b0b9f39543046e5
JavaScript	@azure/arm-compute	https://apiview.dev/Assemblies/Review/482ee1b994ec401b91ef201e03d064b9
.Net	Azure.ResourceManager.Compute	There is no API change compared with the previous version

fix model validations

003cc38

grizzlytheodore requested review from Sandido, dkulkarni-ms, haagha, madewithsmiles, MS-syh2qs and hyonholee as code owners March 17, 2023 15:27

ghost added the Compute label Mar 17, 2023

AzureRestAPISpecReview added the resource-manager label Mar 17, 2023

azure-sdk mentioned this pull request Mar 17, 2023

[AutoPR sdk/resourcemanager/compute/armcompute] fix model validations azure-sdk/azure-sdk-for-go#4916

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label Mar 17, 2023

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label Mar 17, 2023

haagha merged commit df14545 into feature/cplat-2023-01-02 Mar 23, 2023

haagha deleted the diskRP-modelvalidation branch March 23, 2023 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix model validations #23156

fix model validations #23156

grizzlytheodore commented Mar 17, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-workflow-bot bot commented Mar 17, 2023

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

fix model validations #23156

fix model validations #23156

Conversation

grizzlytheodore commented Mar 17, 2023 • edited by openapi-workflow-bot bot Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented Mar 17, 2023

openapi-pipeline-app bot commented Mar 17, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented Mar 17, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented Mar 17, 2023 • edited Loading

Generated ApiView

grizzlytheodore commented Mar 17, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading

openapi-pipeline-app bot commented Mar 17, 2023 •

edited

Loading