[Mirror] [Hub Generated] Review request for Microsoft.DataProtection to add version preview/2022-11-01-preview#2729
Conversation
|
Hi, @ruowan 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 |
|---|---|---|
| dataregistry.json | 2022-12-01-preview(b9f356a) | 2022-12-01-preview(main) |
| types.json | 2.0(b9f356a) | 2.0(main) |
| integrationRuntime.json | 2021-06-01-preview(b9f356a) | 2021-06-01-preview(main) |
| Rule | Message |
|---|---|
1004 - ResponseBodyFormatNowSupported |
The old version did not support 'application/zip' as a response body format. New: DataRegistry/preview/2022-12-01-preview/dataregistry.json#L316:9 Old: DataRegistry/preview/2022-12-01-preview/dataregistry.json#L316:9 |
1036 - ConstraintChanged |
The new version has a different 'pattern' value than the previous one. New: resource-manager/common/2.0/types.json#L103:5 Old: resource-manager/common/2.0/types.json#L103:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1391:5 |
️❌Breaking Change(Cross-Version): 50 Errors, 89 Warnings failed [Detail]
| compared swaggers (via Oad v0.10.2)] | new version | base version |
|---|---|---|
| dataprotection.json | 2022-11-01-preview(b9f356a) | 2022-05-01(main) |
| dataprotection.json | 2022-11-01-preview(b9f356a) | 2022-10-01-preview(main) |
| AlertRules.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| AlertRules.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| AutomationRules.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| AutomationRules.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| Enrichment.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| EntityQueries.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| EntityQueryTemplates.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| FileImports.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| Metadata.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| OfficeConsents.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| OnboardingStates.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| OnboardingStates.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| Recommendations.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| SecurityMLAnalyticsSettings.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| SecurityMLAnalyticsSettings.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| Settings.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| SourceControls.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| Watchlists.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| Watchlists.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| AlertTypes.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| AlertTypes.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| IncidentTypes.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| IncidentTypes.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| RelationTypes.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| ThreatIntelligenceTypes.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| dataConnectors.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
| operations.json | 2022-12-01-preview(b9f356a) | 2022-11-01(main) |
| operations.json | 2022-12-01-preview(b9f356a) | 2022-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
Only 10 items are listed, please refer to log for more details.
The following breaking changes are detected by comparison with latest preview version:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
Runtime Exception |
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/b9f356ab2ff3952571894dd712640b84a8cf7b52/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/Bookmarks.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-11-01-preview/Bookmarks.json", "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.288/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 42145.\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 --" |
Runtime Exception |
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/b9f356ab2ff3952571894dd712640b84a8cf7b52/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/Entities.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-11-01-preview/Entities.json", "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.288/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.EntityEdges.properties.additionalData.additionalProperties', line 1, position 66636.\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 of" |
Runtime Exception |
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/b9f356ab2ff3952571894dd712640b84a8cf7b52/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-11-01-preview/Incidents.json", "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.288/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 --" |
Runtime Exception |
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/b9f356ab2ff3952571894dd712640b84a8cf7b52/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/ThreatIntelligence.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-11-01-preview/ThreatIntelligence.json", "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.288/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.ThreatIntelligenceIndicatorProperties.properties.additionalData.additionalProperties', line 1, position 33348.\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" |
Runtime Exception |
"new":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/b9f356ab2ff3952571894dd712640b84a8cf7b52/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-12-01-preview/common/EntityTypes.json", "old":"https://github.com/test-repo-billy/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2022-11-01-preview/common/EntityTypes.json", "details":"Command failed: dotnet /mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.288/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.AccountEntityProperties.properties.additionalData.additionalProperties', line 1, position 2979.\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 " |
| The new version has a different 'pattern' value than the previous one. New: Microsoft.SecurityInsights/preview/2022-12-01-preview/AlertRules.json#L49:9 Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/AlertRules.json#L49:9 |
|
| The new version has a different 'pattern' value than the previous one. New: Microsoft.SecurityInsights/preview/2022-12-01-preview/AlertRules.json#L103:9 Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/AlertRules.json#L103:9 |
|
| The new version has a different 'pattern' value than the previous one. New: Microsoft.SecurityInsights/preview/2022-12-01-preview/AlertRules.json#L158:9 Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/AlertRules.json#L158:9 |
|
| The new version has a different 'pattern' value than the previous one. New: Microsoft.SecurityInsights/preview/2022-12-01-preview/AlertRules.json#L210:9 Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/AlertRules.json#L210:9 |
|
| The new version has a different 'pattern' value than the previous one. New: Microsoft.SecurityInsights/preview/2022-12-01-preview/AlertRules.json#L255:9 Old: Microsoft.SecurityInsights/preview/2022-11-01-preview/AlertRules.json#L255:9 |
️❌LintDiff: 4 Errors, 13 Warnings failed [Detail]
[must fix]The following errors/warnings are introduced by current PR:
Only 10 items are listed, please refer to log for more details.
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1391 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'integrationRuntimeName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1391 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'workspaceName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1391 |
RPC-Uri-V1-05 |
ResourceNameRestriction |
The resource name parameter 'integrationRuntimeName' should be defined with a 'pattern' restriction. Location: Microsoft.Synapse/preview/2021-06-01-preview/integrationRuntime.json#L1391 |
RPC-Uri-V1-05 |
| 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.DataProtection/preview/2022-11-01-preview/dataprotection.json#L6024 |
||
| Schema should have a description or title. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/AutomationRules.json#L311 |
||
| Schema should have a description or title. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1067 |
||
| Schema should have a description or title. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1185 |
||
| Schema should have a description or title. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1293 |
||
| Schema should have a description or title. Location: Microsoft.SecurityInsights/preview/2022-12-01-preview/Incidents.json#L1402 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
️️✔️~[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️❌~[Staging] SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌PoliCheck: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Click detail for error messages. Exception contact vsswagger@microsoft.com or https://aka.ms/swaggersupport. |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/synapse/resource-manager/readme.md tag: specification/synapse/resource-manager/readme.md#tag-package-composite-v2 |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️~[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️~[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi @ruowan, 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. |
8d12768 to
df7de47
Compare
…2022-10-01-preview to version 2022-11-01-preview
df7de47 to
e6f6e6c
Compare
986012a to
6de0216
Compare
…crosoft.DataProtection-2022-11-01-preview
e46791a to
d0a0048
Compare
Mirror from
https://github.com/Azure/azure-rest-api-specs/pull/21441