-
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
[Compute] API Version 2023-01-02 #24364
Conversation
Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com>
* Added fileFormat to GrantAccessData * Added VHDX word to custom-words * Added examples
Description for None.
Hi, @haagha 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 |
---|---|---|
disk.json | 2023-01-02(3ecc2fe) | 2022-07-02(main) |
disk.json | 2023-01-02(3ecc2fe) | 2016-04-30-preview(main) |
diskAccess.json | 2023-01-02(3ecc2fe) | 2022-07-02(main) |
diskEncryptionSet.json | 2023-01-02(3ecc2fe) | 2022-07-02(main) |
diskRPCommon.json | 2023-01-02(3ecc2fe) | 2022-07-02(main) |
diskRestorePoint.json | 2023-01-02(3ecc2fe) | 2022-07-02(main) |
snapshot.json | 2023-01-02(3ecc2fe) | 2022-07-02(main) |
The following breaking changes are detected by comparison with the latest preview version:
Rule | Message |
---|---|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}' removed or restructured? Old: DiskRP/preview/2016-04-30-preview/disk.json#L368:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots' removed or restructured? Old: DiskRP/preview/2016-04-30-preview/disk.json#L541:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots' removed or restructured? Old: DiskRP/preview/2016-04-30-preview/disk.json#L577:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess' removed or restructured? Old: DiskRP/preview/2016-04-30-preview/disk.json#L610:5 |
|
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess' removed or restructured? Old: DiskRP/preview/2016-04-30-preview/disk.json#L654:5 |
|
The new version is missing a definition that was found in the old version. Was 'EncryptionSettings' removed or renamed? New: DiskRP/stable/2023-01-02/disk.json#L472:3 Old: DiskRP/preview/2016-04-30-preview/disk.json#L693:3 |
|
The new version is missing a definition that was found in the old version. Was 'Snapshot' removed or renamed? New: DiskRP/stable/2023-01-02/disk.json#L472:3 Old: DiskRP/preview/2016-04-30-preview/disk.json#L693:3 |
|
The new version is missing a definition that was found in the old version. Was 'SnapshotUpdate' removed or renamed? New: DiskRP/stable/2023-01-02/disk.json#L472:3 Old: DiskRP/preview/2016-04-30-preview/disk.json#L693:3 |
|
The new version is missing a client parameter that was found in the old version. Was 'SnapshotNameParameter' removed or renamed? New: DiskRP/stable/2023-01-02/disk.json#L892:3 Old: DiskRP/preview/2016-04-30-preview/disk.json#L1201:3 |
|
The 'required' status changed from the old version('True') to the new version('False'). New: DiskRP/stable/2023-01-02/diskRPCommon.json#L375:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L992:7 |
|
The new version has a different 'allOf' property than the previous one. New: DiskRP/stable/2023-01-02/disk.json#L180:13 Old: DiskRP/preview/2016-04-30-preview/disk.json#L108:13 |
|
The new version has a different 'allOf' property than the previous one. New: DiskRP/stable/2023-01-02/disk.json#L514:5 Old: DiskRP/preview/2016-04-30-preview/disk.json#L755:5 |
|
The new version is missing a property found in the old version. Was 'accountType' renamed or removed? New: DiskRP/stable/2023-01-02/disk.json#L610:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L789:7 |
|
The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: DiskRP/stable/2023-01-02/disk.json#L610:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L789:7 |
|
The new version is missing a property found in the old version. Was 'ownerId' renamed or removed? New: DiskRP/stable/2023-01-02/disk.json#L610:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L789:7 |
|
The new version is missing a property found in the old version. Was 'accountType' renamed or removed? New: DiskRP/stable/2023-01-02/disk.json#L777:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L910:7 |
|
The new version is missing a property found in the old version. Was 'creationData' renamed or removed? New: DiskRP/stable/2023-01-02/disk.json#L777:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L910:7 |
|
The new version is missing a property found in the old version. Was 'encryptionSettings' renamed or removed? New: DiskRP/stable/2023-01-02/disk.json#L777:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L910:7 |
|
The new version is missing a property found in the old version. Was 'properties' renamed or removed? New: DiskRP/stable/2023-01-02/diskRPCommon.json#L576:7 Old: DiskRP/preview/2016-04-30-preview/disk.json#L1034:7 |
|
The new version has a different x-ms-enum 'modelAsString' than the previous one. New: DiskRP/stable/2023-01-02/diskRPCommon.json#L263:9 Old: DiskRP/preview/2016-04-30-preview/disk.json#L953:9 |
|
The new version has a different x-ms-enum 'modelAsString' than the previous one. New: DiskRP/stable/2023-01-02/diskRPCommon.json#L525:9 Old: DiskRP/preview/2016-04-30-preview/disk.json#L1010:9 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.3) | new version | base version |
---|---|---|
package-2023-01-02 | package-2023-01-02(3ecc2fe) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
ResourceNameRestriction |
The resource name parameter 'diskName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2023-01-02/disk.json#L37 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: DiskRP/stable/2023-01-02/disk.json#L38 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L67 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: DiskRP/stable/2023-01-02/disk.json#L67 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/disk.json#L74 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L186 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/disk.json#L193 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L254 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L288 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/disk.json#L292 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L325 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L358 |
ResourceNameRestriction |
The resource name parameter 'diskName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2023-01-02/disk.json#L376 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L406 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/disk.json#L413 |
ResourceNameRestriction |
The resource name parameter 'diskName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2023-01-02/disk.json#L431 |
LroPostReturn |
200 response for a LRO POST operation must have a response schema specified. Location: DiskRP/stable/2023-01-02/disk.json#L432 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/disk.json#L452 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/disk.json#L456 |
ResourceNameRestriction |
The resource name parameter 'diskAccessName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2023-01-02/diskAccess.json#L37 |
ProvisioningStateSpecifiedForLROPut |
201 response schema in long running PUT operation is missing ProvisioningState property. A LRO PUT operations response schema must have ProvisioningState specified for the 200 and 201 status codes. Location: DiskRP/stable/2023-01-02/diskAccess.json#L38 |
PutResponseSchemaDescription |
Any Put MUST contain 200 and 201 return codes. Location: DiskRP/stable/2023-01-02/diskAccess.json#L67 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/diskAccess.json#L74 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: DiskRP/stable/2023-01-02/diskAccess.json#L83 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/diskAccess.json#L130 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: DiskRP/stable/2023-01-02/diskAccess.json#L139 |
LroLocationHeader |
A 202 response should include an Location response header. Location: DiskRP/stable/2023-01-02/diskAccess.json#L217 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: DiskRP/stable/2023-01-02/diskAccess.json#L226 |
ResourceNameRestriction |
The resource name parameter 'diskAccessName' should be defined with a 'pattern' restriction. Location: DiskRP/stable/2023-01-02/diskAccess.json#L319 |
MissingDefaultResponse |
Operation is missing a default response. Location: DiskRP/stable/2023-01-02/diskAccess.json#L340 |
️⚠️
Avocado: 1 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-01-02 |
️️✔️
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: 0 Errors, 0 Warnings failed [Detail]
️️✔️
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 @haagha, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @haagha, 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 |
@Wzb123456789 The Model validation error does not make sense to me since the "Id" is already present in the example. |
Please check and approve this PR so that I can get the SDK owner to check BreakingChange. |
@ms-zhenhua could you also comment on the model validation issue? Thanks. |
@ms-zhenhua Please check and approve this PR so that I can get the SDK owner to check BreakingChange. |
ARM has already signed off. I asked Zhenhua Hu and they had no further comments. |
Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com> Co-authored-by: Theodore Chang <thchan@microsoft.com> Co-authored-by: shpimpal <34675111+shpimpal@users.noreply.github.com>
ARM API Information (Control Plane)
ARM has already signed off on the new feature change for this API version:
Added fileFormat to GrantAccessData for DD snapshots (https://github.com/Azure/azure-rest-api-specs/pull/23528[)](https://github.com/Azure/azure-rest-api-specs/pull/24364/commits/86d06da9f84048ba3be06003163e5d2bd1e68305)
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. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
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.