-
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
Supporting User MSI and CMK in RS Vault CRUD Operation #12248
Conversation
#1) * Supporting User Assigned Identity and CMK. * Indentation fixes * Added Examples for CRUD with CMK * Added more fields to the Operation Resource
Hi, @asmaskar 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 |
---|---|
The child tracked resource, 'operationStatus' with immediate parent 'Vault', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaultusages.json#L65 |
|
The child tracked resource, 'operationResults' with immediate parent 'Vault', must have a list by immediate parent operation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaultusages.json#L65 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: useSystemAssignedIdentity New: Microsoft.RecoveryServices/stable/2020-02-02/vaults.json#L1504 |
|
'operationId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaults.json#L725 |
|
'operationId' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaults.json#L776 |
|
'keyVaultProperties' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaults.json#L1253 |
|
'kekIdentity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaults.json#L1256 |
|
'error' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. New: Microsoft.RecoveryServices/stable/2020-02-02/vaults.json#L1549 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️
[Staging] Cross Version BreakingChange (Base on stable version): 14 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.5)
- original: stable/2016-06-01/registeredidentities.json <---> new: stable/2020-02-02/registeredidentities.json
- original: stable/2016-06-01/replicationusages.json <---> new: stable/2020-02-02/replicationusages.json
- original: stable/2016-06-01/vaults.json <---> new: stable/2020-02-02/vaults.json
- original: stable/2016-06-01/vaultusages.json <---> new: stable/2020-02-02/vaultusages.json
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
Hi, @asmaskar your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @xccc-msft |
Hi @asmaskar, 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. |
NewApiVersionRequired reason: |
"schema": { | ||
"$ref": "#/definitions/Vault" | ||
} | ||
"202": { |
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.
What's the reason behind updating the response code?
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.
The reason is that 201 was not being used from the service side. The next reason is that the synchronous call has been made Asynchronous so 202 is added as per the ARM guidelines
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.
Good, I realized it after looking at the new operationStatus endpoints but it wasn't clear from the PR description nor from the title.
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.
Sorry for the confusion.
From ARM side, this PR looks ok but contains new properties to an existing api-version. Please follow the breaking change process and get an approval. |
"$ref": "#/parameters/ApiVersion" | ||
} | ||
], | ||
"responses": { |
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.
Missing deafult response model. Consider using error models defined in types.json in common-types folder: https://github.com/Azure/azure-rest-api-specs/tree/master/specification/common-types/resource-management Also, an example reference can be found here:
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, this is actually an issue on a lot of the responses in this swagger.
In reply to: 551566447 [](ancestors = 551566447)
Added a few comments - please update the PR when ready. |
Hi @asmaskar, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, |
@filizt Can you please review this and let me know if there are any concerns around the PR |
I'll take a look. Could you also mark all the checkboxes that apply to your changes on the PR? |
}, | ||
"202": { | ||
"description": "Accepted" | ||
}, |
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.
Please mark as long running operation
@asmaskar there is only one comment waiting (#12248 (comment)). If it's addressed, we should be able to approve today. |
@filizt I have addressed the comment provided. Thanks |
@xccc-msft can you please let me know if there are any more changes to be made in the pr. If it seems fine, can you please approve it |
@asmaskar Please let me know when it's ready to merge. Thanks. |
@xccc-msft please go ahead and merge it. Thanks |
…D (#1)
Supporting User Assigned Identity and CMK.
Indentation fixes
Added Examples for CRUD with CMK
Added more fields to the Operation Resource
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 API 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.