Update proximityPlacementGroup.json #23556
Merged
Conversation
This file contains hidden or 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
mimckitt
requested review from
MS-syh2qs,
Sandido,
dkulkarni-ms,
grizzlytheodore,
haagha,
hyonholee and
madewithsmiles
as code owners
|
Hi, @mimckitt 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| proximityPlacementGroup.json | 2023-03-01(a99b154) | 2022-11-01(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-03-01 | package-2023-03-01(a99b154) | package-2023-03-01(feature/cplat-2023-03-01) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The resource name parameter 'proximityPlacementGroupName' should be defined with a 'pattern' restriction. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L37 |
|
The delete operation is defined without a 200 or 204 error response implementation,please add it.' Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L186 |
|
The schema 'ProximityPlacementGroupProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L346 |
|
The schema 'ProximityPlacementGroup' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L405 |
|
The schema 'ProximityPlacementGroupListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L435 |
| The response of operation:'ProximityPlacementGroups_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L38 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L44 |
|
| The response of operation:'ProximityPlacementGroups_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L101 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L107 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L164 |
|
| Based on the response model schema, operation 'ProximityPlacementGroups_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L203 |
|
| The response of operation:'ProximityPlacementGroups_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L203 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L209 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L266 |
|
| Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: ComputeRP/stable/2023-03-01/proximityPlacementGroup.json#L305 |
️⚠️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
|
ghost
added
the
Generated ApiView
|
This was referenced Apr 13, 2023
Closed
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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Kartik Gupta <[email protected]> Co-authored-by: cakarata <[email protected]> Co-authored-by: payalguptapg <[email protected]> Co-authored-by: Anshul Verma <[email protected]> Co-authored-by: Adam Sandor <[email protected]> Co-authored-by: younghyun5756 <[email protected]> Co-authored-by: Younghyun Kim <[email protected]> Co-authored-by: krishnak-msft <[email protected]> Co-authored-by: Linu George <[email protected]> Co-authored-by: vatsan28 <[email protected]> Co-authored-by: Viv Lingaiah <[email protected]> Co-authored-by: Micah McKittrick <[email protected]>
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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> * 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 <[email protected]> Co-authored-by: Kartik Gupta <[email protected]> Co-authored-by: cakarata <[email protected]> Co-authored-by: payalguptapg <[email protected]> Co-authored-by: Anshul Verma <[email protected]> Co-authored-by: Adam Sandor <[email protected]> Co-authored-by: younghyun5756 <[email protected]> Co-authored-by: Younghyun Kim <[email protected]> Co-authored-by: krishnak-msft <[email protected]> Co-authored-by: Linu George <[email protected]> Co-authored-by: vatsan28 <[email protected]> Co-authored-by: Viv Lingaiah <[email protected]> Co-authored-by: Micah McKittrick <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.