-
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 preview/2021-06-01-preview #16042
[Hub Generated] Review request for Microsoft.KeyVault to add version preview/2021-06-01-preview #16042
Conversation
Hi, @susolank 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
1041 - AddedPropertyInResponse |
The new version has a new property 'release_policy' in response that was not found in the old version. New: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L354:7 Old: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L354:7 |
1045 - AddedOptionalProperty |
The new version has a new optional property 'release_policy' that was not found in the old version. New: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L354:7 Old: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L354:7 |
1045 - AddedOptionalProperty |
The new version has a new optional property 'exportable' that was not found in the old version. New: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L436:7 Old: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L432:7 |
️⚠️
LintDiff: 2 Warnings warning [Detail]
- Linted configuring files (Based on source branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
- Linted configuring files (Based on target branch, openapi-validator v1.10.1 , classic-openapi-validator v1.1.10 )
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: exportable Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L481 |
|
'KeyReleasePolicy' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keys.json#L626 |
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/preview/2021-06-01-preview/secrets.json#L306 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L312 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L318 |
R4013 - IntegerTypeMustHaveFormat |
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2021-06-01-preview/secrets.json#L324 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/common.json#L10 |
R4037 - MissingTypeObject |
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/common.json#L19 |
R4037 - MissingTypeObject |
The schema 'SystemData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/common.json#L33 |
R4037 - MissingTypeObject |
The schema 'PrivateLinkResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1959 |
R4037 - MissingTypeObject |
The schema 'PrivateLinkResource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1944 |
R4037 - MissingTypeObject |
The schema 'PrivateLinkServiceConnectionState' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1877 |
R4037 - MissingTypeObject |
The schema 'PrivateEndpoint' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1867 |
R4037 - MissingTypeObject |
The schema 'PrivateEndpointConnectionProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1850 |
R4037 - MissingTypeObject |
The schema 'PrivateEndpointConnection' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1814 |
R4037 - MissingTypeObject |
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1639 |
R4037 - MissingTypeObject |
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/common.json#L19 |
R4037 - MissingTypeObject |
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/common.json#L10 |
R4037 - MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1035 |
R4037 - MissingTypeObject |
The schema 'AccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1068 |
R4037 - MissingTypeObject |
The schema 'Permissions' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1096 |
R4037 - MissingTypeObject |
The schema 'VaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1213 |
R4037 - MissingTypeObject |
The schema 'VaultPatchProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1324 |
R4037 - MissingTypeObject |
The schema 'VaultAccessPolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1394 |
R4037 - MissingTypeObject |
The schema 'DeletedVaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1409 |
R4037 - MissingTypeObject |
The schema 'VaultCreateOrUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1449 |
R4037 - MissingTypeObject |
The schema 'VaultPatchParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1474 |
R4037 - MissingTypeObject |
The schema 'VaultAccessPolicyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1491 |
R4037 - MissingTypeObject |
The schema 'Vault' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1524 |
R4037 - MissingTypeObject |
The schema 'DeletedVault' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1567 |
R4037 - MissingTypeObject |
The schema 'VaultListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1591 |
R4037 - MissingTypeObject |
The schema 'DeletedVaultListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-06-01-preview/keyvault.json#L1607 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
- keyvault/resource-manager/readme.md#package-preview-2021-06
- keyvault/resource-manager/readme.md#package-preview-2021-04
- keyvault/resource-manager/readme.md#package-preview-2021-04-full
- keyvault/resource-manager/readme.md#package-preview-2020-04
- keyvault/resource-manager/readme.md#package-preview-2020-04-full
- keyvault/resource-manager/readme.md#package-2019-09
- keyvault/resource-manager/readme.md#package-2018-02-14-preview
- keyvault/resource-manager/readme.md#package-2018-02
- keyvault/resource-manager/readme.md#package-2016-10
- keyvault/resource-manager/readme.md#package-2015-06
- keyvault/resource-manager/readme.md#profile-hybrid-2020-09-01
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Swagger Generation Artifacts
|
NewApiVersionRequired reason: |
Hi @susolank, Your PR has some issues. Please fix the CI sequentially by following the order of
|
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.
One change to consider, but I won't block the PR based solely on that.
specification/keyvault/resource-manager/Microsoft.KeyVault/preview/2021-06-01-preview/keys.json
Outdated
Show resolved
Hide resolved
Hi @susolank, 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. |
@ruowan I feel this breaking change review process is not applicable to this PR because new properties are being added the KeyCreateParameters object. No existing properties are being modified or removed. No existing customers will be impacted by this change. This change is allow customers to create Secure Key Release (SKR) keys using ARM template. |
|
@lmazuel can you help merge this? As with other KV REST PRs, the remaining issues are, unfortunately, expected. |
There are no cusomer impact. Here is the reason for adding new property breaking change: #16042 (comment). |
@JeffreyRichter could you please help to review this breaking change? |
…Vault to add version preview/2021-06-01-preview (#1922) Create to sync Azure/azure-rest-api-specs#16042 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/main...AzureSDKAutomation:sdkAuto/keyvault?expand=1)
…preview/2021-06-01-preview (Azure#16042) * Added exportable attribute and release policy to CP Swagger doc * Specify type as object for ReleasePolicy * Address code review comments * Add suppression code for camelCase * Prettier check
…preview/2021-06-01-preview (Azure#16042) * Added exportable attribute and release policy to CP Swagger doc * Specify type as object for ReleasePolicy * Address code review comments * Add suppression code for camelCase * Prettier check
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
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 label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] 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.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.