Provider sync properties#22198
Merged
ruowan merged 1 commit intoAzure:release-Sentinel-2023-02-01from Jan 24, 2023
Merged
Conversation
|
Hi, @dosiso 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.2)] | new version | base version |
|---|---|---|
| Incidents.json | 2023-02-01(11c7e58) | 2022-11-01(main) |
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/11c7e588fa7247f6661ff6c5d948ec59ee5b3d8e/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json", "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.46/common/temp/node_modules/.pnpm/@Azure+oad@0.10.2/node_modules/@azure/oad/dlls/OpenApiDiff.dll -o /tmp/old-resolved.json -n /tmp/new-resolved.json\nUnhandled exception. Newtonsoft.Json.JsonSerializationException: Error converting value True to type 'AutoRest.Swagger.Model.Schema'. Path 'definitions.UrlEntityProperties.properties.additionalData.additionalProperties', line 1, position 74112.\n ---> System.ArgumentException: Could not cast or convert from System.Boolean to AutoRest.Swagger.Model.Schema.\n at Newtonsoft.Json.Utilities.ConvertUtils.EnsureTypeAssignable(Object value, Type initialType, Type targetType)\n at Newtonsoft.Json.Utilities.ConvertUtils.ConvertOrCast(Object initialValue, CultureInfo culture, Type targetType)\n at Newtonsoft.Json.Serialization.JsonSerializerInternalReader.EnsureType(JsonReader reader, Object value, CultureInfo culture, JsonContract contract, Type targetType)\n --- End" |
️️✔️LintDiff succeeded [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-2023-02 | package-2023-02(11c7e58) | package-2023-02(release-Sentinel-2023-02-01) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The resource name parameter 'relationName' should be defined with a 'pattern' restriction. Location: Microsoft.SecurityInsights/stable/2023-02-01/Incidents.json#L640 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️~[Staging] CadlAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 5 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Expected type object but found type string Url: stable/2023-02-01/common/EntityTypes.json#L2272:35 ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentAlerts.json#L41:44 |
|
Expected type object but found type string Url: stable/2023-02-01/common/EntityTypes.json#L2272:35 ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L37:25 |
|
Expected type object but found type string Url: stable/2023-02-01/common/EntityTypes.json#L2272:35 ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L38:29 |
|
Expected type object but found type string Url: stable/2023-02-01/common/EntityTypes.json#L2272:35 ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L67:25 |
|
Expected type object but found type string Url: stable/2023-02-01/common/EntityTypes.json#L2272:35 ExampleUrl: 2023-02-01/examples/incidents/GetAllIncidentBookmarks.json#L68:29 |
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
openapi-workflow-bot
bot
added
ARMReview
WaitForARMFeedback
Swagger Generation Artifacts
|
|
Hi, @dosiso your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). |
Generated ApiView
|
Member
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced Jan 16, 2023
ruowan
approved these changes
Jan 18, 2023
ruowan
added
Approved-BreakingChange
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
ruowan
removed
WaitForARMFeedback
ruowan
approved these changes
Jan 24, 2023
Member
|
After sync with PR author offline, the model validation is not related with this PR changes. And PR author will create a separate PR to fix it. |
dw511214992
pushed a commit
that referenced
this pull request
Feb 22, 2023
* Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01 * Updates readme * Updates API version in new specs and examples * Provider sync properties (#22198) * Alert Rules - add alert details override changes and PUT example (#22196) * add alert details override changes and PUT example * add missing brace * add closing brace for alertDetailsOverride * add dynamic properties to 200 response * add dynamic details to 201 response --------- Co-authored-by: ShaniFelig <shfelifelig@microsoft.com> * Release Metadata 2023-02-01 stable version. (#22161) * Release Metadata 2023-02-01 stable version. * Fix Swagger spec validation errors. * Revert Metadata service version to 2022-12-01-preview * Bring back changes for version 2023-02-01 * Fix model validation --------- Co-authored-by: Dor Siso <60354892+dosiso@users.noreply.github.com> Co-authored-by: ShaniFelig <74960756+ShaniFelig@users.noreply.github.com> Co-authored-by: ShaniFelig <shfelifelig@microsoft.com> Co-authored-by: Samuel Kuang <samuk@microsoft.com>
aviyerMSFT
pushed a commit
to aviyerMSFT/azure-rest-api-specs
that referenced
this pull request
Mar 22, 2023
* Adds base for updating Microsoft.SecurityInsights from version stable/2022-11-01 to version 2023-02-01 * Updates readme * Updates API version in new specs and examples * Provider sync properties (Azure#22198) * Alert Rules - add alert details override changes and PUT example (Azure#22196) * add alert details override changes and PUT example * add missing brace * add closing brace for alertDetailsOverride * add dynamic properties to 200 response * add dynamic details to 201 response --------- Co-authored-by: ShaniFelig <shfelifelig@microsoft.com> * Release Metadata 2023-02-01 stable version. (Azure#22161) * Release Metadata 2023-02-01 stable version. * Fix Swagger spec validation errors. * Revert Metadata service version to 2022-12-01-preview * Bring back changes for version 2023-02-01 * Fix model validation --------- Co-authored-by: Dor Siso <60354892+dosiso@users.noreply.github.com> Co-authored-by: ShaniFelig <74960756+ShaniFelig@users.noreply.github.com> Co-authored-by: ShaniFelig <shfelifelig@microsoft.com> Co-authored-by: Samuel Kuang <samuk@microsoft.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
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:
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.
-[X] 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.