[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2023-02-01 #23428
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
… following properties: enableSoftDelete, softDeleteRetentionDays, enablePurgeProtection and publicNetworkAccess
|
Hi, @neeerajaakula 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 |
|---|---|---|
| managedHsm.json | 2020-04-01-preview(abe4d3c) | 2020-04-01-preview(main) |
| managedHsm.json | 2021-04-01-preview(abe4d3c) | 2021-04-01-preview(main) |
| managedHsm.json | 2021-06-01-preview(abe4d3c) | 2021-06-01-preview(main) |
| managedHsm.json | 2021-11-01-preview(abe4d3c) | 2021-11-01-preview(main) |
| managedHsm.json | 2022-02-01-preview(abe4d3c) | 2022-02-01-preview(main) |
| managedHsm.json | 2021-10-01(abe4d3c) | 2021-10-01(main) |
| managedHsm.json | 2022-07-01(abe4d3c) | 2022-07-01(main) |
| managedHsm.json | 2022-11-01(abe4d3c) | 2022-11-01(main) |
| managedHsm.json | 2023-02-01(abe4d3c) | 2023-02-01(main) |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2020-04 | package-preview-2020-04(abe4d3c) | package-preview-2020-04(main) |
| package-preview-2020-04-full | package-preview-2020-04-full(abe4d3c) | package-preview-2020-04-full(main) |
| package-preview-2022-02 | package-preview-2022-02(abe4d3c) | package-preview-2022-02(main) |
| package-2022-07 | package-2022-07(abe4d3c) | package-2022-07(main) |
| package-preview-2021-11 | package-preview-2021-11(abe4d3c) | package-preview-2021-11(main) |
| package-2021-10 | package-2021-10(abe4d3c) | package-2021-10(main) |
| package-preview-2021-06 | package-preview-2021-06(abe4d3c) | package-preview-2021-06(main) |
| package-preview-2021-04-full | package-preview-2021-04-full(abe4d3c) | package-preview-2021-04-full(main) |
| package-2023-02 | package-2023-02(abe4d3c) | package-2023-02(main) |
| package-2022-11 | package-2022-11(abe4d3c) | package-2022-11(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L38 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L38 |
|
A 'put' operation 'ManagedHsms_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L38 |
|
A 'put' operation 'ManagedHsms_CreateOrUpdate' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 201. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L38 |
|
An async PUT operation must return 201. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L72 |
|
An async PUT operation must return 201. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L72 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L73 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L73 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L73 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L73 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L119 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L119 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L119 |
|
The patch operation body parameter schema should not contains property name. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L119 |
|
The patch operation body parameter schema should not contains property type. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L119 |
|
The patch operation body parameter schema should not contains property location. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L119 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L164 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L164 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L192 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L192 |
|
The get operation should only return 200. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L243 |
|
The get operation should only return 200. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L243 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L243 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L243 |
|
The get operation should only return 200. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L246 |
|
The get operation should only return 200. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L246 |
|
The schema 'ManagedHsmSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L360 |
|
The schema 'ManagedHsmSku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L360 |
|
The schema 'ManagedHsmProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L393 |
|
The schema 'ManagedHsmProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L393 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L188:22 ExampleUrl: preview/2020-04-01-preview/examples/ManagedHsm_Delete.json |
|
Long running operation should return location or azure-AsyncOperation in header but not provided Url: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L188:22 ExampleUrl: preview/2020-04-01-preview/examples/ManagedHsm_Delete.json |
️️✔️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
|
ghost
added
the
This was referenced Apr 4, 2023
This was referenced Apr 4, 2023
… HSM resource manager version 2020-04-01-preview
… HSM resource manager version 2020-04-01-preview for delete operation
| @@ -43,6 +43,9 @@ | |||
| } | |||
| }, | |||
| "202": { | |||
| "headers": { | |||
| "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9" | |||
There was a problem hiding this comment.
Can you please confirm from code to see if RP returns this header in 2020-04-01-preview version? Just to make sure service code and swagger are in sync.
There was a problem hiding this comment.
Keeping this change as RP does return.
| "202": {}, | ||
| "202": { | ||
| "headers": { | ||
| "Location": "https://some.endpoint.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/hsm-group/providers/Microsoft.KeyVault/managedHSMs/hsm1?api-version=2022-07-01&kv-operation=abJjb2RkIjoiAGVsZXRlTWFuYWdlZEhzbUFzeW5jYm9" |
There was a problem hiding this comment.
Can you please confirm from code to see if RP returns this header in 2020-04-01-preview version? Just to make sure service code and swagger are in sync.
There was a problem hiding this comment.
Reverting this change as RP does not return the location header for this version.
|
Hi @neeerajaakula, Your PR has some issues. Please fix the CI sequentially by following the order of
|
…M RP public network access. Added default value.
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @neeerajaakula, 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 PR has the following changes:
|
|
LRO_RESPONSE_HEADER only happen to 2020-04-01-preview. SDK would use stable version, hence would ignore this error. |
| @@ -911,7 +911,8 @@ | |||
| "description": "SKU of the managed HSM Pool", | |||
| "enum": [ | |||
| "Standard_B1", | |||
| "Custom_B32" | |||
| "Custom_B32", | |||
| "Custom_B6" | |||
| ], | |||
| "x-ms-enum": { | |||
| "name": "ManagedHsmSkuName", | |||
There was a problem hiding this comment.
Since you are doing breaking change review, please also check if they'd prefer you to change "modelAsString" to "true", especially if you are going to add new value to this in future.
There was a problem hiding this comment.
Also usually adding enum should happen in a new api-version (but maybe exception if for S360).
There was a problem hiding this comment.
Recommendation from breaking change review board was keep it as is and not add 'modelAsString'.
mikekistler
added
the
Approved-BreakingChange
kim-soohwan
approved these changes
Apr 10, 2023
weidongxu-microsoft
deleted the
neeerajaakula-keyvault-Microsoft.KeyVault-2023-02-01
branch
This was referenced Apr 11, 2023
JoshLove-msft
pushed a commit
to JoshLove-msft/azure-rest-api-specs
that referenced
this pull request
Apr 25, 2023
…stable/2023-02-01 (Azure#23428) * Update description for managed HSM properties in resource manager for following properties: enableSoftDelete, softDeleteRetentionDays, enablePurgeProtection and publicNetworkAccess * Fix model validation failures for LRO_Response_Header rule in managed HSM resource manager version 2020-04-01-preview * Fix model validation failures for LRO_Response_Header rule in managed HSM resource manager version 2020-04-01-preview for delete operation * Revert change of location header to delete in managed HSM resource manager * Fix S360 issue with additional property being returned for managed HSM RP public network access. Added default value. * Fix S360 alert for enum mismatch in Managed HSM resource manager for SKU property
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.
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM API Information (Control Plane)
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.