-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2022-07-01 #19395
[Hub Generated] Review request for Microsoft.KeyVault to add version stable/2022-07-01 #19395
Conversation
…1-01-preview to version 2022-07-01
Changes that were merged include: - Adding "object" type. - Fixing description of enableRbacAuthorization (no longer a preview feature).
Hi, @adarce 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] |
1 similar comment
Hi, @adarce 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] |
Hi, @adarce your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Hi, @adarce your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). |
Swagger Validation Report
|
compared swaggers (via Oad v0.9.6)] | new version | base version |
---|---|---|
common.json | 2022-07-01(ff63535) | 2021-10-01(main) |
common.json | 2022-07-01(ff63535) | 2021-11-01(main) |
keys.json | 2022-07-01(ff63535) | 2021-10-01(main) |
keys.json | 2022-07-01(ff63535) | 2021-11-01(main) |
keyvault.json | 2022-07-01(ff63535) | 2021-10-01(main) |
keyvault.json | 2022-07-01(ff63535) | 2021-11-01(main) |
managedHsm.json | 2022-07-01(ff63535) | 2021-10-01(main) |
managedHsm.json | 2022-07-01(ff63535) | 2021-11-01(main) |
providers.json | 2022-07-01(ff63535) | 2021-10-01(main) |
providers.json | 2022-07-01(ff63535) | 2021-11-01(main) |
secrets.json | 2022-07-01(ff63535) | 2021-10-01(main) |
secrets.json | 2022-07-01(ff63535) | 2021-11-01(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#L707:15 |
The following breaking changes are detected by comparison with the latest preview version:
Only 30 items are listed, please refer to log for more details.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
LintDiff: 1 Warnings warning [Detail]
compared tags (via openapi-validator v1.13.0) | new version | base version |
---|---|---|
package-2022-07 | package-2022-07(ff63535) | default(main) |
The following errors/warnings are introduced by current PR:
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L1494 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/stable/2022-07-01/secrets.json#L306 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/stable/2022-07-01/secrets.json#L312 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/stable/2022-07-01/secrets.json#L318 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/stable/2022-07-01/secrets.json#L324 |
R4037 - MissingTypeObject |
The schema 'MHSMIPRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L1281 |
R4037 - MissingTypeObject |
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/stable/2022-07-01/providers.json#L88 |
R4039 - ParametersOrder |
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L512 |
R4039 - ParametersOrder |
The parameters:vaultName,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L568 |
R4039 - ParametersOrder |
The parameters:name,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L456 |
R4039 - ParametersOrder |
The parameters:name,location should be kept in the same order as they present in the path. Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L506 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L553 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1223 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1335 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1397 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1765 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L999 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L1263 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/providers.json#L66 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/providers.json#L138 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/providers.json#L145 |
R4041 - XmsIdentifierValidation |
Missing identifier id in array item property Location: Microsoft.KeyVault/stable/2022-07-01/providers.json#L214 |
'PUT' operation 'Vaults_UpdateAccessPolicy' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L272 |
|
'PUT' operation 'PrivateEndpointConnections_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L804 |
|
'PUT' operation 'MHSMPrivateEndpointConnections_Put' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.KeyVault/stable/2022-07-01/managedHsm.json#L614 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-07-01/keys.json#L499 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1465 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1487 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1518 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1562 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.KeyVault/stable/2022-07-01/keyvault.json#L1591 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ApiReadinessCheck 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.
️⚠️
SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"Using directive.0.suppress which is deprecated and will be removed in the future." |
|
💬 | "readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"AutoRest core version selected from configuration: ^3.2.0." |
💬 | "readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0 -> 1.11.0)" |
💬 | "readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.11.0->1.11.0)" |
💬 | "readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.21.4 -> 4.21.4)" |
💬 | "readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"> Installed AutoRest extension '@autorest/modelerfour' (4.21.4->4.21.4)" |
💬 | "readme":"keyvault/resource-manager/readme.md", "tag":"package-2022-07", "details":"Autorest completed in 11.77s. 0 files generated." |
️️✔️
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.
Swagger Generation Artifacts
|
Hi @adarce, Your PR has some issues. Please fix the CI sequentially by following the order of
|
1 similar comment
Hi @adarce, Your PR has some issues. Please fix the CI sequentially by following the order of
|
@heaths and @weidongxu-microsoft : This is intended to be a simple PR that adds the changes from the existing preview control plane API version 2021-11-01-preview to the stable API version 2022-07-01. I used OpenAPI Hub to generate this PR, so I don't expect this PR to have introduced any new CI validation issues. How should the existing CI validation issues in this PR be handled? |
This commit ensures the following invariant in managedHsm.json: ``` If an operation can return a 202 Accepted response, then we insert '"x-ms-long-running-operation": true,' directly below the operationId, and we insert a Location header in the operation as well as the corresponding example. ```
7a9aa25
to
ca6a761
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
…o managed hsm specificiation
MHSM changes look good to me. |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
"CheckMhsmNameAvailabilityParameters": { | ||
"type": "object", | ||
"properties": { | ||
"name": { | ||
"type": "string", | ||
"description": "The managed hsm name." | ||
} | ||
}, | ||
"required": [ | ||
"name" | ||
], | ||
"description": "The parameters used to check the availability of the managed hsm name." | ||
}, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
keyvault defined the payload slightly different.
Lines 1685 to 1709 in ff63535
"VaultCheckNameAvailabilityParameters": { | |
"properties": { | |
"name": { | |
"type": "string", | |
"description": "The vault name." | |
}, | |
"type": { | |
"type": "string", | |
"enum": [ | |
"Microsoft.KeyVault/vaults" | |
], | |
"x-ms-enum": { | |
"name": "Type", | |
"modelAsString": false | |
}, | |
"description": "The type of resource, Microsoft.KeyVault/vaults" | |
} | |
}, | |
"required": [ | |
"name", | |
"type" | |
], | |
"description": "The parameters used to check the availability of the vault name.", | |
"type": "object" | |
}, |
I don't think there is requirement from ARM on the schema, so it is up to you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@neeerajaakula or @riteshchitlangia1 : Please confirm that the slight discrepancies here are acceptable for Managed HSM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not relevant for Managed HSM api
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, agree with @neeerajaakula 's comment. Above difference between keyvault and mhsm is intentional and fine.
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
@weidongxu-microsoft : AKV's service has been deployed to all Public cloud regions, and our ARM manifest has also been applied everywhere. Can you please merge this PR? |
…Vault to add version stable/2022-07-01 (#2470) Create to sync Azure/azure-rest-api-specs#19395 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...azure-sdk:sdkAuto/keyvault?expand=1)
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:
What's the purpose of the update?
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
By the end of the month (June 2022). Likely in a week or so.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
ETA: 2022-07-01
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.
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.