[Hub Generated] Review request for Microsoft.ResourceHealth to add version preview/2022-10-01-preview #22479
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
…2022-05-01-preview to version 2022-10-01-preview
* Added ImpactedResources for Tenant. * Added new API listSecurityAdvisoryImpactedResources for Subscriptions and Tenants. * Added Tenant ImpactedResources, SecurityImpactedResources. * Changes to examples for Subscription ImpactedResources. * Added resourceName pattern for ImpactedResourceNameParameter. * Changes to example - SecurityAdvisoryImpactedResources_ListByTenantId_ListByEventId. Removed subscriptionId from unique resourceId.
* added fetchEventDetails initial commit * linter fixes * removed filterparam * re-add incorrectly deleted filter parameter * removed query start time parameter
* Added EmergingIssues API paths from 2018-07-01. * Fix LintDiff error - x-ms-identifiers * Fix LintDiff error - MissingTypeObject * Changed resource definition from v1 to v3.
* Adding 2 new fields to AvailabilityStatuses response. * Modified availabilitystatuses examples, changes to descriptions. * Modified availabilitystatuses examples - 2
…2022-05-01-preview to version 2022-10-01-preview
…preview' into abhayohri-resourcehealth-Microsoft.ResourceHealth-2022-10-01-preview
…ourceHealth-2022-10-01-preview
|
Hi, @abhayohri 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 Generation Artifacts
|
Generated ApiView
|
This was referenced Feb 6, 2023
This was referenced Feb 6, 2023
AzureRestAPISpecReview
added
the
BreakingChangeReviewRequired
AzureRestAPISpecReview
removed
the
BreakingChangeReviewRequired
|
Please note that most of the changes in this pr have already been approved in #21757. However when trying to solve the merge conflict i could not push directly to the branch and merging main via pr led to a large number of files being marked as updated #22455 Once i did this however a new Avocado issue was triggered and it seems like the metadata api hasn't been added in the swagger since the 2018-07-01 version. thus I added it. on the other issues and why they are acceptable:
this api seems to only have been added to the 2018-08-01-preview version. it has not been added to any stable version and is not going to be supported moving forward. this api version should be deprecated LintDiffs:
these have been addressed in previous pr's. basically fixing these would be considered a breaking change and after checking with breaking change review board it was decided to not fix these: #21588 (comment)
for these the list by subscription operation does not make sense as the data is the same accross subscriptions and tenants. also as stated above this api was a part of the 2018-07-01 version and was simply missed in future api version and as such cannot be changed without causing a breaking change
cc @dw511214992 |
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
|
Hi, @abhayohri your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
zizw123
reviewed
Feb 9, 2023
| "properties": { | ||
| "value": { | ||
| "description": "The list of metadata entities.", | ||
| "type": "array", |
There was a problem hiding this comment.
use x-ms-identifiers for the object in the array: https://github.com/Azure/autorest/tree/main/docs/extensions#x-ms-identifiers #Closed
There was a problem hiding this comment.
so according to your link:
"The default identifying property is id. You don't need to add this annotataion if there is the id property in the object model."
since metadata entity has the id field via:
"allOf": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/definitions/ProxyResource"
}
]
we don't need to add it
There was a problem hiding this comment.
Sounds good, I missed this in this initial review
zizw123
added
the
ARMChangesRequested
|
Please ensure to respond feedbacks from the ARM API reviewer. When you are ready to continue the ARM API review, please remove |
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
abhayohri
added
the
WaitForARMFeedback
openapi-workflow-bot
bot
removed
the
ARMChangesRequested
rkmanda
added
the
ARMSignedOff
openapi-workflow-bot
bot
removed
the
WaitForARMFeedback
|
@dw511214992 Can we get this merged? This is signed off by ARM review. |
dw511214992
approved these changes
Feb 16, 2023
dw511214992
deleted the
abhayohri-resourcehealth-Microsoft.ResourceHealth-2022-10-01-preview
branch
This was referenced Feb 16, 2023
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
…rsion preview/2022-10-01-preview (Azure#22479) * Adds base for updating Microsoft.ResourceHealth from version preview/2022-05-01-preview to version 2022-10-01-preview * Updates readme * Updates API version in new specs and examples * Dev resourcehealth/abhsinghal/2022 10 01 preview (Azure#21758) * Added ImpactedResources for Tenant. * Added new API listSecurityAdvisoryImpactedResources for Subscriptions and Tenants. * Added Tenant ImpactedResources, SecurityImpactedResources. * Changes to examples for Subscription ImpactedResources. * Added resourceName pattern for ImpactedResourceNameParameter. * Changes to example - SecurityAdvisoryImpactedResources_ListByTenantId_ListByEventId. Removed subscriptionId from unique resourceId. * added fetchEventDetails initial commit (Azure#21896) * added fetchEventDetails initial commit * linter fixes * removed filterparam * re-add incorrectly deleted filter parameter * removed query start time parameter * Added EmergingIssues API paths from 2018-07-01. (Azure#21954) * Added EmergingIssues API paths from 2018-07-01. * Fix LintDiff error - x-ms-identifiers * Fix LintDiff error - MissingTypeObject * Changed resource definition from v1 to v3. * Adding 2 new fields to AvailabilityStatuses response. (Azure#22081) * Adding 2 new fields to AvailabilityStatuses response. * Modified availabilitystatuses examples, changes to descriptions. * Modified availabilitystatuses examples - 2 * Adds base for updating Microsoft.ResourceHealth from version preview/2022-05-01-preview to version 2022-10-01-preview * Updates readme * Updates API version in new specs and examples * fix merge conflicts between main and dev-resourcehealth-Microsoft.ResourceHealth-2022-10-01-preview * added the metadata api into swagger * ran prettier * fixed example file * added pattern for issueName * undo adding pattern and ran prettier --------- Co-authored-by: abhishek-corp <104534488+abhishek-corp@users.noreply.github.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.
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:
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.