-
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
Update roleManagementAlertOperations properties #22642
Conversation
Swagger pipeline can not start as the pull request has merge conflicts. |
Hi, @juliawelborn 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] |
Swagger pipeline can not start as the pull request has merge conflicts. |
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
RoleManagementAlerts.json | 2022-08-01-preview(1dfbc16) | 2022-08-01-preview(main) |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
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-2021-12-01-preview-only | package-2021-12-01-preview-only(1dfbc16) | package-2021-12-01-preview-only(main) |
The following errors/warnings exist before current PR submission:
Rule | Message |
---|---|
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L108 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L108 |
PathForResourceAction |
Path for 'post' method on a resource type MUST follow valid resource naming. Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L241 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property name. Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L362 |
UnSupportedPatchProperties |
The patch operation body parameter schema should not contains property type. Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L362 |
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L44 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L91 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L146 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L190 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L248 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L298 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L345 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L400 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L444 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L493 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L537 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L594 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L646 |
|
Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition Location: Microsoft.Authorization/preview/2022-08-01-preview/RoleManagementAlerts.json#L700 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/authorization/resource-manager/readme.md tag: specification/authorization/resource-manager/readme.md#tag-package-2021-12-01-preview-only |
️️✔️
ApiReadinessCheck succeeded [Detail] [Expand]
️❌
~[Staging] ServiceAPIReadinessTest: 0 Errors, 0 Warnings failed [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️
SwaggerAPIView succeeded [Detail] [Expand]
️️✔️
CadlAPIView 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.
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
Hi @juliawelborn, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi @juliawelborn, 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. |
Hi @ruowan. There is no customer impact to this breaking change because this API version has not been released to customers. The changes are necessary to align with our service's corresponding Graph APIs, which is important to reduce customer confusion. I have created a breaking change request describing the scenario as well (Scenario 17191878: Microsoft.Authorization 2022-08-01-preview API version breaking change request) |
* Start updating paths * update all paths and examples * Change patch operations to 204 instead of 200 * Update operations paths * Add new properties to operation * Update RoleManagementAlerts.json * Delete GetAlertOperations.json * Update GetAlertOperationById.json * Fix accidental comma deletion * Update GetAlertOperationById.json * Update RefreshAlert.json * Update RefreshAllAlerts.json * Update RefreshAlert.json * Fix date formatting * Fix date format * Fix date format * Update RefreshAlert.json * Remove unused type * Add remediatable to custom words
ARM API Information (Control Plane)
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
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:
I recently added this new api version (Add RoleManagementAlerts resource for PIM #19296), and it has not yet been released to customers. We recently found a discrepancy between the properties in this API and our corresponding graph API which we need to align with, so we want to correct that in the same api version. The API has not been released to customers, so there should not be customer impact.
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.