-
Notifications
You must be signed in to change notification settings - Fork 5.6k
[Hub Generated] Review request for Microsoft.ResourceHealth to add version stable/2022-10-01 #22721
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.ResourceHealth to add version stable/2022-10-01 #22721
Conversation
…2022-10-01-preview to version 2022-10-01
|
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 Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| ResourceHealth.json | 2022-10-01(57ac5f9) | 2022-05-01(main) |
| ResourceHealth.json | 2022-10-01(57ac5f9) | 2022-10-01-preview(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L2091:11 Old: Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json#L1924:11 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1085:13 Old: Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json#L938:13 |
|
| The new version has a different 'allOf' property than the previous one. New: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L2101:5 Old: Microsoft.ResourceHealth/preview/2022-10-01-preview/ResourceHealth.json#L1934:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2022-10 | package-2022-10(57ac5f9) | default(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.ResourceHealth/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L142 |
ResourceNameRestriction |
The resource name parameter 'issueName' should be defined with a 'pattern' restriction. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1067 |
TopLevelResourcesListBySubscription |
The top-level resource 'MetadataEntity' does not have list by subscription operation, please add it. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1592 |
TopLevelResourcesListBySubscription |
The top-level resource 'emergingIssuesGetResult' does not have list by subscription operation, please add it. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L2101 |
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L128 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetMetadata Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L326 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ImpactedResourcesGet Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L494 |
|
| OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListBySubscriptionIdAndEventId'. Consider updating the operationId Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L506 |
|
| OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListByTenantIdAndEventId'. Consider updating the operationId Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L551 |
|
| OperationId should contain the verb: 'fetcheventdetails' in:'Event_fetchDetailsBySubscriptionIdAndTrackingId'. Consider updating the operationId Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L683 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: ListEventsByTenantId Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L752 |
|
| OperationId should contain the verb: 'fetcheventdetails' in:'Event_fetchDetailsByTenantIdAndTrackingId'. Consider updating the operationId Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L806 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: GetEmergingIssues Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1096 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1134 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1307 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1311 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1319 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1323 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1525 |
|
Property location must have 'x-ms-mutability':['read', 'create'] extension defined.Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1703 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1707 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L1710 |
|
| Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L2035 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: Microsoft.ResourceHealth/stable/2022-10-01/ResourceHealth.json#L2195 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️❌~[Staging] ServiceAPIReadinessTest: 38 Errors, 0 Warnings failed [Detail]
Tag package-2022-10; Prod region: Deployed
Test run on region: westcentralus; Operation coverage: total: 25, untested: 0, failed: 20, passed: 5
Service API Readiness Test failed. Check pipeline artifact for detail report.
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/read' over scope '/providers/Microsoft.ResourceHealth' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: Events_ListByTenantId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: Events_ListByTenantId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/read' over scope '/providers/Microsoft.ResourceHealth/events/eventtra8lz4at' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: Event_GetByTenantIdAndTrackingId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: Event_GetByTenantIdAndTrackingId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/fetchEventDetails/action' over scope '/providers/Microsoft.ResourceHealth/events/eventtra8lz4at' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: Event_fetchDetailsByTenantIdAndTrackingId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: Event_fetchDetailsByTenantIdAndTrackingId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/impactedResources/read' over scope '/providers/Microsoft.ResourceHealth/events/eventtra8lz4at' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: ImpactedResources_ListByTenantIdAndEventId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ImpactedResources_ListByTenantIdAndEventId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/impactedResources/read' over scope '/providers/Microsoft.ResourceHealth/events/eventtra8lz4at/impactedResources/impactedb66d2n' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: ImpactedResources_GetByTenantId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: ImpactedResources_GetByTenantId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/listSecurityAdvisoryImpactedResources/action' over scope '/providers/Microsoft.ResourceHealth/events/eventtra8lz4at' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: SecurityAdvisoryImpactedResources_ListByTenantIdAndEventId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: SecurityAdvisoryImpactedResources_ListByTenantIdAndEventId |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'metadata' could not be found in the namespace 'Microsoft.ResourceHealth' for api version '2022-10-01'. The supported api-versions are '2018-07-01,2018-07-01-rc,2018-07-01-preview,2018-07-01-beta,2018-07-01-alpha'. Source: runtime OperationId: Metadata_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: Metadata_List |
CLIENT_ERROR |
statusCode: 404, errorCode: InvalidResourceType, errorMessage: The resource type 'metadata' could not be found in the namespace 'Microsoft.ResourceHealth' for api version '2022-10-01'. The supported api-versions are '2018-07-01,2018-07-01-rc,2018-07-01-preview,2018-07-01-beta,2018-07-01-alpha'. Source: runtime OperationId: Metadata_GetEntity |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: Metadata_GetEntity |
CLIENT_ERROR |
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: Events_ListBySubscriptionId |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: Event_GetBySubscriptionIdAndTrackingId |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/fetchEventDetails/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: Event_fetchDetailsBySubscriptionIdAndTrackingId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: Event_fetchDetailsBySubscriptionIdAndTrackingId |
CLIENT_ERROR |
statusCode: 400, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: ImpactedResources_ListBySubscriptionIdAndEventId |
CLIENT_ERROR |
statusCode: 404, errorCode: undefined, errorMessage: undefined Source: runtime OperationId: ImpactedResources_Get |
INVALID_CONTENT_TYPE |
Invalid Content-Type (application/octet-stream). These are supported: application/json Source: response OperationId: ImpactedResources_Get |
INVALID_RESPONSE_BODY |
Body is required in response but not provided Source: response OperationId: ImpactedResources_Get |
CLIENT_ERROR |
statusCode: 403, errorCode: AuthorizationFailed, errorMessage: The client '7904a8be-825f-480e-a728-80a70579dba4' with object id '7904a8be-825f-480e-a728-80a70579dba4' does not have authorization to perform action 'Microsoft.ResourceHealth/events/listSecurityAdvisoryImpactedResources/action' over scope '/subscriptions/db5eb68e-73e2-4fa8-b18a-46cd1be4cce5' or the scope is invalid. If access was recently granted, please refresh your credentials. Source: runtime OperationId: SecurityAdvisoryImpactedResources_ListBySubscriptionIdAndEventId |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: SecurityAdvisoryImpactedResources_ListBySubscriptionIdAndEventId |
CLIENT_ERROR |
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: AvailabilityStatuses_List |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: AvailabilityStatuses_List |
CLIENT_ERROR |
statusCode: 404, errorCode: MissingSubscription, errorMessage: The request did not have a subscription or a valid tenant level resource provider. Source: runtime OperationId: AvailabilityStatuses_GetByResource |
OBJECT_ADDITIONAL_PROPERTIES |
Additional properties not allowed: error Source: response OperationId: AvailabilityStatuses_GetByResource |
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView 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.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
NewApiVersionRequired reason: |
This reverts commit 111d6ca.
|
Availability status endpoints: events endpoints: |
|
/azp run unifiedPipeline |
|
No pipelines are associated with this pull request. |
|
Hi @abhayohri, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval. |
|
SigningOff from ARM side as checked that comments from previous ARM API Reviewer are resolved. There is one Linter issue which needs to be resolved (fixed/suppressed). |
|
@abhayohri, the config for dotnet sdk is not correct, could you please update it by following https://github.com/Azure/azure-rest-api-specs/blob/main/documentation/samplefiles/readme.csharp.md @MaryGao @tadelesh, could you take a look at the SDK breaking in this PR, thanks |
|
Please follow on Renhe's comment. I will skip LintDiff on this single error before merge, as suppression seems not able to work. ignore my comment above, I've confused it with #22916 |
|
The suppression doesn't seem to work but it should not be a blocker for this PR. |
|
Approved JS breaking since it is not introduced by this pr. |
…rsion stable/2022-10-01 (Azure#22721) * Adds base for updating Microsoft.ResourceHealth from version preview/2022-10-01-preview to version 2022-10-01 * Updates readme * Updates API version in new specs and examples * added missing api * Revert "added missing api" This reverts commit 111d6ca. * added missing api * added error message suppression to readme * prettier fix * added missing fields for s360 items * updated description * spelling fix * added missing properties to all stable api versions * Revert "added missing properties to all stable api versions" This reverts commit 220764b. * fixes from pr for resourcehealth.json file * updated child avialbility example uri * added suppression for _ActionUrl * added suppression for _ActionUrl * added suppression for _ActionUrl * added suppression for _ActionUrl * added suppression for _ActionUrl * added suppression for _ActionUrl * linter wrnings * update readme for .net sdk * update readme for .net sdk * update readme for sdks * trying suppression for actionurl.comment * added suppression for _ActionUrl

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.