[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2022-11-01 #20839
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
…-01 to version 2022-11-01
…M control plane (via ARM)
|
Hi, @riteshchitlangia1 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 |
|---|---|---|
| common.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| common.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| keys.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| keys.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| keyvault.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| keyvault.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| managedHsm.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| managedHsm.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| providers.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| providers.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
| secrets.json | 2022-11-01(4b0f04d) | 2022-07-01(main) |
| secrets.json | 2022-11-01(4b0f04d) | 2022-02-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2022-11-01/keys.json#L482:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/keys.json#L482:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2022-11-01/managedHsm.json#L1248:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L1248:9 |
|
| The new version has a different default value than the previous one. New: Microsoft.KeyVault/stable/2022-11-01/managedHsm.json#L1260:9 Old: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L1261:9 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 13 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-11 | package-2022-11(4b0f04d) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'ManagedHsmKeys_CreateIfNotExist' Request Model: 'parameters[5].schema' Response Model: 'responses[200].schema' Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L14 |
||
| The response of operation:'ManagedHsmKeys_CreateIfNotExist' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L14 |
||
| The response of operation:'ManagedHsmKeys_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L72 |
||
| The response of operation:'ManagedHsmKeys_GetVersion' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L174 |
||
| 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: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L368 |
||
| 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: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L412 |
||
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L429 |
||
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L477 |
||
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L494 |
||
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L515 |
||
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L528 |
||
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L541 |
||
| Schema should have a description or title. Location: Microsoft.KeyVault/stable/2022-11-01/keysManagedHsm.json#L558 |
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 Key does not have a corresponding delete operation. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L13 |
|
Tracked resource 'Key' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L13 |
|
Property name should be camel case. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L428 |
|
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L646 |
|
The parameter 'ApiVersionParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2022-11-01/keys.json#L653 |
|
The response in the GET collection operation 'Keys_List' does not match the response definition in the individual GET operation 'Keys_Get' . Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L12 |
|
The response in the GET collection operation 'Keys_ListVersions' does not match the response definition in the individual GET operation 'Keys_GetVersion' . Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L12 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L14 |
|
The resource VaultAccessPolicyParameters does not have a corresponding delete operation. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L267 |
|
Tracked resource 'VaultAccessPolicyParameters' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L267 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L511 |
|
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L512 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L567 |
|
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L568 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L568 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L601 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L624 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L750 |
|
Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L750 |
|
The get operation should only return 200. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L789 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L869 |
|
The delete response body must be empty. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L903 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1067 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1076 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1216 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1296 |
|
Usage of Guid is not recommended. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1333 |
|
The nested resource 'VaultAccessPolicyParameters' does not have list operation, please add it. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1511 |
|
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L1780 |
|
The parameter 'SubscriptionIdParameter' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.KeyVault/stable/2022-11-01/keyvault.json#L2030 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 66 Errors, 0 Warnings failed [Detail]
Tag package-2022-11; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 47, untested: 0, failed: 28, passed: 19
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
statusCode: 404, errorCode: DeletedVaultNotFound, errorMessage: The specified deleted vault 'vaultnamuwqdpo' does not exist. Ensure that the vault was indeed deleted and that it is in recoverable state. If soft delete was not enabled then the vault is permanently deleted. Follow this link for more information: https://go.microsoft.com/fwlink/?linkid=2149745 Source: runtime OperationId: Vaults_GetDeleted |
|
statusCode: 400, errorCode: InvalidApiVersionParameter, errorMessage: The api-version '2022-11-01' is invalid. The supported versions are '2022-12-01,2022-11-01-preview,2022-09-01,2022-06-01,2022-05-01,2022-03-01-preview,2022-01-01,2021-04-01,2021-01-01,2020-10-01,2020-09-01,2020-08-01,2020-07-01,2020-06-01,2020-05-01,2020-01-01,2019-11-01,2019-10-01,2019-09-01,2019-08-01,2019-07-01,2019-06-01,2019-05-10,2019-05-01,2019-03-01,2018-11-01,2018-09-01,2018-08-01,2018-07-01,2018-06-01,2018-05-01,2018-02-01,2018-01-01,2017-12-01,2017-08-01,2017-06-01,2017-05-10,2017-05-01,2017-03-01,2016-09-01,2016-07-01,2016-06-01,2016-02-01,2015-11-01,2015-01-01,2014-04-01-preview,2014-04-01,2014-01-01,2013-03-01,2014-02-26,2014-04'. Source: runtime OperationId: Vaults_List |
|
No enum match for: 2022-11-01 Source: request OperationId: Vaults_List |
|
Enum does not match case for: Standard Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Get Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: List Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Update Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Create Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Import Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Delete Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Recover Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Backup Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Restore Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Get Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: List Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Set Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Delete Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Recover Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Backup Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Restore Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Get Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: List Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Update Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Create Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Import Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Delete Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Recover Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Backup Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: Restore Source: response OperationId: Vaults_ListBySubscription |
|
Enum does not match case for: ManageContacts Source: response OperationId: Vaults_ListBySubscription |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView 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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
ghost
added
the
Generated ApiView
|
|
Hi @riteshchitlangia1, Your PR has some issues. Please fix the CI sequentially by following the order of
|
AzureRestAPISpecReview
added
ARMReview
ReadyForApiTest
This was referenced Sep 23, 2022
|
Hi, @riteshchitlangia1 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
|
Hi @riteshchitlangia1, 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 added securitydomainproperties and fixed a s360 item.
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
tianxchen-ms
removed
ReadyForApiTest
openapi-pipeline-app
bot
added
ReadyForApiTest
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
…e.com/azure-sdk/internal/_wiki/wikis/internal.wiki/828/How-to-suppress-validation-rules and removing swagger changes for headers.
AzureRestAPISpecReview
removed
BreakingChangeReviewRequired
This was referenced Feb 3, 2023
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.
This PR adds a set of Managed HSM key operations CreateKeyIfNotExists/ List/Get Keys and KeyVersions via control plane.
This will help integrate partners to call MHSM key operations via MHSM control plane itself.
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:
We plan to deploy service next week, 10/10/2022.
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.