Added missing operations for AKV Swagger Completeness #22112
Merged
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
Fixed LRO_RESPONSE_HEADER, INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY errors.
|
Hi, @rahulalapati43 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.2)] | new version | base version |
|---|---|---|
| keyvault.json | 2022-02-01-preview(6e8d98d) | 2021-10-01(main) |
| keyvault.json | 2022-02-01-preview(6e8d98d) | 2021-11-01-preview(main) |
| managedHsm.json | 2022-02-01-preview(6e8d98d) | 2021-10-01(main) |
| managedHsm.json | 2022-02-01-preview(6e8d98d) | 2021-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
| Rule | Message |
|---|---|
| The new version removs a required header 'Retry-After'. Old: Microsoft.KeyVault/stable/2021-10-01/managedHsm.json#L725:15 |
|
| The 'constant' status changed from the old version to the new. New: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L653:11 Old: Microsoft.KeyVault/stable/2021-10-01/keyvault.json#L653:11 |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version removs a required header 'Retry-After'. Old: Microsoft.KeyVault/preview/2021-11-01-preview/managedHsm.json#L725:15 |
|
| The 'constant' status changed from the old version to the new. New: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L653:11 Old: Microsoft.KeyVault/preview/2021-11-01-preview/keyvault.json#L653:11 |
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-02 | package-preview-2022-02(6e8d98d) | package-preview-2022-02(dev-keyvault-Microsoft.KeyVault-2022-02-01-preview-swagger-completeness) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
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/preview/2022-02-01-preview/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/preview/2022-02-01-preview/keyvault.json#L12 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L14 |
|
The resource VaultAccessPolicyParameters does not have a corresponding delete operation. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L267 |
|
Tracked resource 'VaultAccessPolicyParameters' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L267 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L511 |
|
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L512 |
|
The resource name parameter 'vaultName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L567 |
|
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L568 |
|
An async POST operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L568 |
|
A 202 response should include an Location response header. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L601 |
|
The path for the CURD methods do not contain a resource type. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L624 |
|
The resource name parameter 'privateEndpointConnectionName' should be defined with a 'pattern' restriction. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L751 |
|
Tracked resource 'PrivateEndpointConnection' must have patch operation that at least supports the update of tags. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L751 |
|
The get operation should only return 200. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L790 |
|
An async DELETE operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L870 |
|
The delete response body must be empty. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L904 |
|
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/preview/2022-02-01-preview/keyvault.json#L1068 |
|
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/preview/2022-02-01-preview/keyvault.json#L1077 |
|
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/preview/2022-02-01-preview/keyvault.json#L1217 |
|
ProvisioningState must have terminal states: Succeeded, Failed and Canceled. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L1297 |
|
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/preview/2022-02-01-preview/keyvault.json#L1334 |
|
The nested resource 'VaultAccessPolicyParameters' does not have list operation, please add it. Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L1512 |
|
Missing identifier id in array item property Location: Microsoft.KeyVault/preview/2022-02-01-preview/keyvault.json#L1781 |
|
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/preview/2022-02-01-preview/keyvault.json#L2031 |
|
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/preview/2022-02-01-preview/keyvault.json#L2063 |
|
An async PUT operation must set long running operation options 'x-ms-long-running-operation-options' Location: Microsoft.KeyVault/preview/2022-02-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/2022-02-01-preview/managedHsm.json#L38 |
|
An async PUT operation must return 201. Location: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L72 |
|
Only 201 is the supported response code for PUT async response. Location: Microsoft.KeyVault/preview/2022-02-01-preview/managedHsm.json#L73 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
ghost
added
the
This was referenced Jan 9, 2023
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @rahulalapati43 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
adarce
approved these changes
Jan 9, 2023
rahulalapati43
merged commit 2c9a7f1
into
dev-keyvault-Microsoft.KeyVault-2022-02-01-preview-swagger-completeness
rahulalapati43
deleted the
add-missing-operations-AKV-2022-02-01-preview
branch
tianxchen-ms
pushed a commit
that referenced
this pull request
Feb 2, 2023
…ess (#22154) * Adds base for updating Microsoft.KeyVault from version stable/2022-07-01 to version 2022-02-01-preview * Updates readme * Updates API version in new specs and examples * Fixed breaking changes in managedHsm.json. (#22112) Fixed LRO_RESPONSE_HEADER, INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY errors. Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com> * Undid the API version changes to the Vaults_List API (#22142) * Fixed breaking changes in managedHsm.json. Fixed LRO_RESPONSE_HEADER, INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY errors. * Undid the API Version change to the VaultListFilterTypes API. Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com> * Update listVault.json (#22155) * Update listVault.json * Remove the preview API version for the enum * Delete Vault_Lists API specification * Added the Vaults_List swagger specification back. * Abstracted Vaults_List API into 2015-11-01 directory to Swagger ModelValidation Errors. * Resolved unresolvable references. * Reorganized the definitions. * Reorganized the 2015-11-01 directory under 2022-02-01-preview * Moved the 2015-11-10 directory to stable. * Undo the abstraction changes. * Readd the listVault.json. * Added suppression directives for INVALID_REQUEST_PARAMETER and OBJECT_MISSING_REQUIRED_PROPERTY. * Modify suppress rule. * Update the suppression directive. * Update suppression directive. * Update suppression directive. * Update suppression directives. * Updated suppression directive. * Added suppression directives for INVALID_REQUEST_PARAMETER, OBJECT_MISSING_REQUIRED_PROPERTY * Updated suppression directives. * Updated suppression directives. * Updated suppression directives. * Updated suppression directives. * Updated suppression directives. * Added x-ms-validation rules to the api-version parameter. * Updated suppression directives. * Added individual suppression directives. * Removed where clause from the OBJECT_MISSING_REQUIRED_PROPERTY suppression directive. * Corrected yaml title for suppression directives. Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com> --------- Co-authored-by: Rahul Alapati <rahulalapati@microsoft.com>
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.
-[x] 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.