Update description for RBAC flag in Key Vault #15161
Merged
Conversation
This file contains hidden or 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
|
Hi, @jlichwa 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] |
|
[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 Validation Report
|
| Rule | Message |
|---|---|
|
The response is defined but without a default error response implementation.Consider adding it.' Location: Microsoft.KeyVault/preview/2020-04-01-preview/secrets.json#L268 |
|
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2020-04-01-preview/secrets.json#L300 |
|
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2020-04-01-preview/secrets.json#L306 |
|
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2020-04-01-preview/secrets.json#L312 |
|
The integer type does not have a format, please add it. Location: Microsoft.KeyVault/preview/2020-04-01-preview/secrets.json#L318 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L36 |
|
The private endpoint API: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/privateEndpointConnections is missing. Location: Microsoft.KeyVault/preview/2020-04-01-preview/managedHsm.json#L36 |
|
The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/common.json#L10 |
|
The schema 'CloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/common.json#L19 |
|
The schema 'SystemData' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/common.json#L33 |
|
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1035 |
|
The schema 'AccessPolicyEntry' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1068 |
|
The schema 'Permissions' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1096 |
|
The schema 'VaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1208 |
|
The schema 'VaultPatchProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1314 |
|
The schema 'VaultAccessPolicyProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1380 |
|
The schema 'DeletedVaultProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1395 |
|
The schema 'VaultCreateOrUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1435 |
|
The schema 'VaultPatchParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1460 |
|
The schema 'VaultAccessPolicyParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1477 |
|
The schema 'Vault' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1510 |
|
The schema 'DeletedVault' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1553 |
|
The schema 'VaultListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1577 |
|
The schema 'DeletedVaultListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1593 |
|
The schema 'ResourceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1609 |
|
The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1625 |
|
The schema 'VaultCheckNameAvailabilityParameters' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1659 |
|
The schema 'CheckNameAvailabilityResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1683 |
|
The schema 'NetworkRuleSet' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1711 |
|
The schema 'IPRule' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.KeyVault/preview/2021-04-01-preview/keyvault.json#L1754 |
️️✔️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-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#profile-hybrid-2020-09-01
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04-full",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2021-04-full",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2020-04",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2020-04",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2020-04-full",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-preview-2020-04-full",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-2019-09",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"package-2019-09",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"profile-hybrid-2020-09-01",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"keyvault/resource-manager/readme.md",
"tag":"profile-hybrid-2020-09-01",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️[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).
Swagger Generation Artifacts
|
heaths
approved these changes
Jul 12, 2021
heaths
approved these changes
Jul 12, 2021
|
#sign-off |
raych1
reviewed
Jul 13, 2021
| @@ -1260,7 +1260,7 @@ | |||
| "enableRbacAuthorization": { | |||
| "type": "boolean", | |||
| "default": false, | |||
| "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored (warning: this is a preview feature). When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." | |||
| "description": "Property that controls how data actions are authorized. When true, the key vault will use Role Based Access Control (RBAC) for authorization of data actions, and the access policies specified in vault properties will be ignored. When false, the key vault will use the access policies specified in vault properties, and any policy stored on Azure Resource Manager will be ignored. If null or not specified, the vault is created with the default value of false. Note that management actions are always authorized with RBAC." | |||
There was a problem hiding this comment.
First two change happens in preview version swagger, why do we also remove preview declaration in the description.
There was a problem hiding this comment.
@raych1 Feature GA-ed , any swagger going forward has that feature completed. Upcoming preview versions are created for new features, with other features in preview.... Is that make sense?
This was referenced Jul 15, 2021
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.
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with 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
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from 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.