-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
Feature/cplat 2023 03 01 #22885
Feature/cplat 2023 03 01 #22885
Conversation
Hi, @grizzlytheodore Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
availabilitySet.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
capacityReservation.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
computeRPCommon.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
dedicatedHost.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
image.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
logAnalytic.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
proximityPlacementGroup.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
restorePoint.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
runCommand.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
sshPublicKey.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
virtualMachine.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
virtualMachineExtensionImage.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
virtualMachineImage.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
virtualMachineScaleSet.json | 2023-03-01(7ab8b27) | 2022-11-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄
LintDiff inProgress [Detail]
️⚠️
Avocado: 2 Warnings warning [Detail]
Rule | Message |
---|---|
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-03-01 |
|
The JSON file has a circular reference. readme: specification/compute/resource-manager/readme.md json: ComputeRP/stable/2023-03-01/virtualMachine.json |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
Error |
"\nfatal error: Failed to execute scenario: GeneratedScenario: Failed to execute step CloudServicesUpdateDomain_WalkUpdateDomain: variable.value.substring is not a function \nTypeError: variable.value.substring is not a function\n at PostmanUrl.encodeVariable (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionRunnerClient.js:468:60)\n at arrayEach (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/node_modules/lodash/lodash.js:530:11)\n at Function.forEach (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/node_modules/lodash/lodash.js:9410:14)\n at PostmanVariableList.each (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/node_modules/postman-collection/lib/collection/property-list.js:413:11)\n at PostmanCollectionRunnerClient.sendRestCallRequest (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionRunnerClient.js:473:36)\n at ApiScenarioRunner.executeRestCallStep (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:230:27)\n at ApiScenarioRunner.executeStep (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:89:32)\n at ApiScenarioRunner.execute (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:74:32)\n at async PostmanCollectionRunner.generateCollection (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:215:9)\n at async PostmanCollectionRunner.doRun (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:166:9)\n at async PostmanCollectionRunner.run (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:108:9)\n at async PostmanCollectionGenerator.run (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:424:28)\n at async /opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/commands/run-api-scenario.js:232:13\n at async Object.exports.cliSuppressExceptions (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/cliSuppressExceptions.js:9:28)\n at async Object.handler (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/commands/run-api-scenario.js:139:5) \nError: Failed to execute step CloudServicesUpdateDomain_WalkUpdateDomain: variable.value.substring is not a function \nTypeError: variable.value.substring is not a function\n at PostmanUrl.encodeVariable (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionRunnerClient.js:468:60)\n at arrayEach (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/node_modules/lodash/lodash.js:530:11)\n at Function.forEach (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/node_modules/lodash/lodash.js:9410:14)\n at PostmanVariableList.each (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/node_modules/postman-collection/lib/collection/property-list.js:413:11)\n at PostmanCollectionRunnerClient.sendRestCallRequest (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionRunnerClient.js:473:36)\n at ApiScenarioRunner.executeRestCallStep (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:230:27)\n at ApiScenarioRunner.executeStep (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:89:32)\n at ApiScenarioRunner.execute (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:74:32)\n at async PostmanCollectionRunner.generateCollection (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:215:9)\n at async PostmanCollectionRunner.doRun (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:166:9)\n at async PostmanCollectionRunner.run (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:108:9)\n at async PostmanCollectionGenerator.run (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:424:28)\n at async /opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/commands/run-api-scenario.js:232:13\n at async Object.exports.cliSuppressExceptions (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/cliSuppressExceptions.js:9:28)\n at async Object.handler (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/commands/run-api-scenario.js:139:5)\n at ApiScenarioRunner.executeStep (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:100:19)\n at async ApiScenarioRunner.execute (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/apiScenarioRunner.js:74:21)\n at async PostmanCollectionRunner.generateCollection (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:215:9)\n at async PostmanCollectionRunner.doRun (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:166:9)\n at async PostmanCollectionRunner.run (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:108:9)\n at async PostmanCollectionGenerator.run (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/apiScenario/postmanCollectionGenerator.js:424:28)\n at async /opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/commands/run-api-scenario.js:232:13\n at async Object.exports.cliSuppressExceptions (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/cliSuppressExceptions.js:9:28)\n at async Object.handler (/opt/hostedtoolcache/node/14.21.3/x64/lib/node_modules/oav/dist/lib/commands/run-api-scenario.js:139:5), \n" |
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView succeeded [Detail] [Expand]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
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.
️️✔️
TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi, @grizzlytheodore, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
…n (2022-11-01) to address modelvalidation errors
This reverts commit 08417d3.
* Added $expand option in ListAllVMs and ListAllVMs in RG * Update virtualMachine.json
* dedicatedHost Resize feature * DedicatedHost Sku renamed to size and resolved lint errors. * reviewer comments * httpMethod fix
Hi, @grizzlytheodore your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
ARM reviewer, Here is a list of PR/features that are added to this version: |
"modelAsString": true | ||
} | ||
}, | ||
"bypassPlatformSafetyChecksOnUserSchedule": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The rest looks good, see if this can be updated
…mentFailure flag for Run Command (#23557) * Add managed identities inputs for script, errorBlob, outputBlob * Add treatFailureAsDeploymentFailure flag
* Update proximityPlacementGroup.json * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json
last commit is updating example description |
* copy last version to 2023-03-01 folder * update version reference in the new folder * update versions reference in the new folder * add new readme tag with new version * sync with updates made to 2022-11-01 version * fix generation error * fix duplicate enum name thru c# directive instead. * make all the changes to this version that was made to the last version (2022-11-01) to address modelvalidation errors * update * Revert "update" This reverts commit 08417d3. * Added $expand option in ListAllVMs and ListAllVMs in RG (Azure#22800) * Added $expand option in ListAllVMs and ListAllVMs in RG * Update virtualMachine.json * dedicatedHost Resize feature (Azure#23268) * dedicatedHost Resize feature * DedicatedHost Sku renamed to size and resolved lint errors. * reviewer comments * httpMethod fix * Add property for VM (Azure#22882) (Azure#23329) Co-authored-by: payalguptapg <126145083+payalguptapg@users.noreply.github.com> * Add Reapply for VMSS (Azure#22344) * Add Reapply for VMSS * Prettier fix * Update examples * Address review comments 01 * Use typical resourceGroupName parameter. * Address review comments - Rename examples * Remove <br> syntax from many descriptions in CRP swagger files (Azure#23019) * up to computeRPCommon * all but computeRPCommons * computerpcommon * vmss clean * common clean * vmss try n * trying only \n * remove \n as it messes with rest docs * cleanup 2022-11-01 accidents * cleanups 2023 * remove ID from Update objects that do not have ID (Azure#23078) * update * add identifiers --------- Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com> * Origin/feature/cplat 2023 03 01 (Azure#23203) * Update virtualMachine.json Added missing property for Additional properties not allowed: provisionAfterExtensions Json path: $.value[*].properties.provisionAfterExtensions * added missing property for provisionAfterExtensions * add locatoin in VirtualMachineScaleSetVMExtension * fixed issue of x-ms-mutability --------- Co-authored-by: Younghyun Kim <younghyunkim@microsoft.com> * Add securityPostureReference (Azure#23106) * [RestorePoints] Adding Encryption, Source Details, HyperVGeneration and WriteAccelerated for Restore Point (Azure#23303) * Restore Point Encryption Details * Modified descriptions and made DiskRestorePointProperties as input property * Renaming object and adding type * Renaming DiskRestorePointProperties * making DiskRestorePoint.id readOnly * Modifying reference * Running Prettier * Renaming EncryptionType * Adding HyperVGeneration and WriteAcceleratorEnabled (prchin) * Add optional parameter hibernate to vmss deallocate api (Azure#23409) * Add optional parameter hibernate to vmss deallocate api * Fix with prettier * update example for vmss deallocate * Add Spot Related Properties to VMSS PATCH * prettier and lintDiff suppressions * retry lintDiff suppression * lint diff suppression retry * Add managed identities parameters for blobs, add treatFailureAsDeploymentFailure flag for Run Command (Azure#23557) * Add managed identities inputs for script, errorBlob, outputBlob * Add treatFailureAsDeploymentFailure flag * Update proximityPlacementGroup.json (Azure#23556) * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json * Update proximityPlacementGroup.json --------- Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com> Co-authored-by: Kartik Gupta <31189137+Kartik-715@users.noreply.github.com> Co-authored-by: cakarata <47228825+cakarata@users.noreply.github.com> Co-authored-by: payalguptapg <126145083+payalguptapg@users.noreply.github.com> Co-authored-by: Anshul Verma <88476874+AnshulVermaa@users.noreply.github.com> Co-authored-by: Adam Sandor <adsandor@microsoft.com> Co-authored-by: younghyun5756 <102988755+younghyun5756@users.noreply.github.com> Co-authored-by: Younghyun Kim <younghyunkim@microsoft.com> Co-authored-by: krishnak-msft <127885427+krishnak-msft@users.noreply.github.com> Co-authored-by: Linu George <127192938+linugeorgeofficial@users.noreply.github.com> Co-authored-by: vatsan28 <vatsan9228@gmail.com> Co-authored-by: Viv Lingaiah <viv.lingaiah@gmail.com> Co-authored-by: Micah McKittrick <32313503+mimckitt@users.noreply.github.com>
Adding ComputeRp 2023-03-01 version:
For ARM reviewer:
please review this PR. we followed the rules where:
first commit: adding new folder
second commit: updating versions references.
Here is a list of PR/features that are added to this version:
#22344
#22800
#23329
#23019
16ca22f
#23078 <- breaking change approved
#23106
#23268
#23303 <- breaking change approved
#23409
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:
Contribution checklist (MS Employees Only):
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
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.
-[ ] 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.