[RestorePoints] Adding Encryption, Source Details, HyperVGeneration and WriteAccelerated for Restore Point #23303
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
linugeorgeofficial
requested review from
Sandido,
dkulkarni-ms,
haagha,
madewithsmiles,
MS-syh2qs,
grizzlytheodore and
hyonholee
as code owners
|
Hi, @linugeorgeofficial 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 |
|---|---|---|
| restorePoint.json | 2023-03-01(5f3008e) | 2022-11-01(main) |
The following breaking changes are detected by comparison with the latest stable version:
️⚠️LintDiff: 2 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-03-01 | package-2023-03-01(5f3008e) | package-2023-03-01(feature/cplat-2023-03-01) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L768 |
||
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L808 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The resource name parameter 'restorePointCollectionName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L37 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: ComputeRP/stable/2023-03-01/restorePoint.json#L164 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L196 |
|
The resource name parameter 'restorePointCollectionName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L370 |
|
The resource name parameter 'restorePointName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L370 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: ComputeRP/stable/2023-03-01/restorePoint.json#L371 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: ComputeRP/stable/2023-03-01/restorePoint.json#L436 |
|
A 202 response should include an Location response header. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L472 |
|
The schema 'RestorePointCollectionSourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L567 |
|
The schema 'RestorePointCollectionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L581 |
|
The schema 'RestorePointCollection' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L607 |
|
The schema 'RestorePointCollectionUpdate' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L621 |
|
The schema 'RestorePointCollectionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L635 |
|
The schema 'RestorePointSourceMetadata' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L651 |
|
The schema 'RestorePointSourceVMStorageProfile' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L705 |
|
The schema 'RestorePointSourceVMOSDisk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L724 |
|
The schema 'RestorePointSourceVMDataDisk' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L776 |
|
The schema 'RestorePoint' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L873 |
| The response of operation:'RestorePointCollections_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L38 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/restorePoint.json#L52 |
|
| The response of operation:'RestorePointCollections_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L104 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/restorePoint.json#L110 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L164 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/restorePoint.json#L170 |
|
| The response of operation:'RestorePointCollections_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L219 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/restorePoint.json#L225 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/restorePoint.json#L292 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/restorePoint.json#L338 |
|
| The response of operation:'RestorePoints_Create' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L371 |
|
| The x-ms-long-running-operation-options should be specified explicitly to indicate the type of response header to track the async operation. Location: ComputeRP/stable/2023-03-01/restorePoint.json#L371 |
️⚠️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-03-01 |
️️✔️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.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️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
|
ghost
added
the
|
Hi @linugeorgeofficial, Your PR has some issues. Please fix the CI sequentially by following the order of
|
iamashwani-who
approved these changes
Mar 28, 2023
...ion/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-03-01/restorePoint.json
Outdated
Show resolved
Hide resolved
...ion/compute/resource-manager/Microsoft.Compute/ComputeRP/stable/2023-03-01/restorePoint.json
Outdated
Show resolved
Hide resolved
linugeorgeofficial
changed the title
linugeorgeofficial
changed the title
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @linugeorgeofficial, 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. |
This was referenced Mar 28, 2023
|
synced up with @linugeorgeofficial offline. I see two breaking changes here:
and I was provided reasons for them:
@ArcturusZhang regarding #2, if there a better way to add more properties to diskRestorePoint, than creating this breaking change? |
|
@JeffreyRichter please approve the breaking changes. here are the justifications provided by the service team, and also the feature is in preview: Justification for the DiskRestorePointAttributes change: Justification for the readOnly change: |
|
Can you come to our Office Hours on Monday @ 10am Pacific to walk us through these breaks? |
@JeffreyRichter could you please share meeting invite? thchan@microsoft.com |
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
@JeffreyRichter also, to help you understand whats going on for the readOnly tags: |
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
mikekistler
added
the
Approved-BreakingChange
11 tasks
linugeorgeofficial
changed the title
prchin
approved these changes
Apr 11, 2023
11 tasks
ArcturusZhang
pushed a commit
that referenced
this pull request
Apr 18, 2023
* 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 (#22800) * Added $expand option in ListAllVMs and ListAllVMs in RG * Update virtualMachine.json * dedicatedHost Resize feature (#23268) * dedicatedHost Resize feature * DedicatedHost Sku renamed to size and resolved lint errors. * reviewer comments * httpMethod fix * Add property for VM (#22882) (#23329) Co-authored-by: payalguptapg <126145083+payalguptapg@users.noreply.github.com> * Add Reapply for VMSS (#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 (#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 (#23078) * update * add identifiers --------- Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com> * Origin/feature/cplat 2023 03 01 (#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 (#23106) * [RestorePoints] Adding Encryption, Source Details, HyperVGeneration and WriteAccelerated for Restore Point (#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 (#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 (#23557) * Add managed identities inputs for script, errorBlob, outputBlob * Add treatFailureAsDeploymentFailure flag * Update proximityPlacementGroup.json (#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>
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
* 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>
1 task
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.
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.