-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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 preview/2023-07-01-preview #25447
[Hub Generated] Review request for Microsoft.ResourceHealth to add version preview/2023-07-01-preview #25447
Conversation
…022-10-01 to version 2023-07-01-preview
Next Steps to Merge |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
ResourceHealth.json | 2023-07-01-preview(6eee1a5) | 2022-10-01(main) |
ResourceHealth.json | 2023-07-01-preview(6eee1a5) | 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/preview/2023-07-01-preview/ResourceHealth.json#L2139: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/preview/2023-07-01-preview/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/preview/2023-07-01-preview/ResourceHealth.json#L2149: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.1.4) | new version | base version |
---|---|---|
package-preview-2023-07 | package-preview-2023-07(6eee1a5) | default(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
TopLevelResourcesListBySubscription |
The top-level resource 'MetadataEntity' does not have list by subscription operation, please add it. Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json#L1615 |
TopLevelResourcesListBySubscription |
The top-level resource 'emergingIssuesGetResult' does not have list by subscription operation, please add it. Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json#L2149 |
Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/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/preview/2023-07-01-preview/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/preview/2023-07-01-preview/ResourceHealth.json#L494 |
|
OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListBySubscriptionIdAndEventId'. Consider updating the operationId Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json#L506 |
|
OperationId should contain the verb: 'listsecurityadvisoryimpactedresources' in:'SecurityAdvisoryImpactedResources_ListByTenantIdAndEventId'. Consider updating the operationId Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json#L551 |
|
OperationId should contain the verb: 'fetcheventdetails' in:'Event_fetchDetailsBySubscriptionIdAndTrackingId'. Consider updating the operationId Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/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/preview/2023-07-01-preview/ResourceHealth.json#L752 |
|
OperationId should contain the verb: 'fetcheventdetails' in:'Event_fetchDetailsByTenantIdAndTrackingId'. Consider updating the operationId Location: Microsoft.ResourceHealth/preview/2023-07-01-preview/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/preview/2023-07-01-preview/ResourceHealth.json#L1096 |
️❌
Avocado: 1 Errors, 0 Warnings failed [Detail]
Rule | Message |
---|---|
MISSING_APIS_IN_DEFAULT_TAG |
The default tag should contain all APIs. The API path /subscriptions/{}/providers/Microsoft.ResourceHealth/impactedResources is not in the default tag. Please make sure the missing API swaggers are in the default tag.readme: specification/resourcehealth/resource-manager/readme.md json: Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json |
️️✔️
SwaggerAPIView 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).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
...lth/resource-manager/Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json
Outdated
Show resolved
Hide resolved
a) Adding maintenance related fields for events b) Adding maintenance related fields for impacted resources c) Adding subeventType for events
715d500
to
446c8a3
Compare
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
...lth/resource-manager/Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json
Outdated
Show resolved
Hide resolved
...ager/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json
Outdated
Show resolved
Hide resolved
...ager/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json
Outdated
Show resolved
Hide resolved
...ager/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json
Outdated
Show resolved
Hide resolved
...ager/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json
Outdated
Show resolved
Hide resolved
...ager/Microsoft.ResourceHealth/preview/2023-07-01-preview/examples/ImpactedResources_Get.json
Outdated
Show resolved
Hide resolved
...review/2023-07-01-preview/examples/ImpactedResources_ListBySubscriptionId_ListByEventId.json
Outdated
Show resolved
Hide resolved
...review/2023-07-01-preview/examples/ImpactedResources_ListBySubscriptionId_ListByEventId.json
Outdated
Show resolved
Hide resolved
…ples, and added more info to the description of maintenance related fields for impacted resources
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
...review/2023-07-01-preview/examples/ImpactedResources_ListBySubscriptionId_ListByEventId.json
Outdated
Show resolved
Hide resolved
...lth/resource-manager/Microsoft.ResourceHealth/preview/2023-07-01-preview/ResourceHealth.json
Outdated
Show resolved
Hide resolved
…sources in the examples
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
add "DoNotMerge" label because go sdk generation failed |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
/azp run |
Azure Pipelines successfully started running 2 pipeline(s). |
/pr RequestMerge |
Swagger pipeline restarted successfully, please wait for status update in this comment. |
…rsion preview/2023-07-01-preview (#25447) * Adds base for updating Microsoft.ResourceHealth from version stable/2022-10-01 to version 2023-07-01-preview * Updates readme * Updates API version in new specs and examples * Adding 2023-07-01-preview a) Adding maintenance related fields for events b) Adding maintenance related fields for impacted resources c) Adding subeventType for events * Added values to maintenance related fields for impacted resource examples, and added more info to the description of maintenance related fields for impacted resources * Corrected the values of resourceName and resourceGroup of impacted resources in the examples * Changing maintenanceStatus field to just status * Used prettier
This is a PR generated at OpenAPI Hub. You can view your work branch via this link.
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to Step 2, "ARM Review", for this PR.
Breaking changes review (Step 1)
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
ARM API changes review (Step 2)
ARMReview
label.Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.