-
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
adding new api version 2021-05-01-preview #14485
Conversation
Hi, @LarryZhang19 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. vsswagger@microsoft.com |
Swagger Validation Report
|
Rule | Message |
---|---|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json#L234 |
|
Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enabled Location: Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json#L259 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettings_API.json#L5 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json#L5 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Insights/preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json#L5 |
|
The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation. Location: Microsoft.Insights/preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json#L5 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The default tag contains multiple API versions swaggers. readme: specification/monitor/resource-manager/readme.md tag: specification/monitor/resource-manager/readme.md#tag-package-2020-03 |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 35 Errors, 8 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json compared with base:preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json
- current:preview/2021-05-01-preview/diagnosticsSettings_API.json compared with base:preview/2017-05-01-preview/diagnosticsSettings_API.json
- current:preview/2021-05-01-preview/managementGroupDiagnosticSettings_API.json compared with base:preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json
- current:preview/2021-05-01-preview/subscriptionDiagnosticsSettings_API.json compared with base:preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/microsoft.insights/diagnosticSettingsCategories/{name}' removed or restructured? Old: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json#L39:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/microsoft.insights/diagnosticSettingsCategories' removed or restructured? Old: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json#L78:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/microsoft.insights/diagnosticSettings/{name}' removed or restructured? Old: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json#L39:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/{resourceUri}/providers/microsoft.insights/diagnosticSettings' removed or restructured? Old: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json#L161:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/providers/microsoft.management/managementGroups/{managementGroupId}/providers/microsoft.insights/diagnosticSettings/{name}' removed or restructured? Old: Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json#L39:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/providers/microsoft.management/managementGroups/{managementGroupId}/providers/microsoft.insights/diagnosticSettings' removed or restructured? Old: Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json#L161:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/microsoft.insights/diagnosticSettings/{name}' removed or restructured? Old: Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json#L39:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/microsoft.insights/diagnosticSettings' removed or restructured? Old: Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json#L161:5 |
1026 - TypeChanged |
The new version has a different type 'object' than the previous one ''. New: Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json#L119:5 Old: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json#L137:5 |
1026 - TypeChanged |
The new version has a different type 'object' than the previous one ''. New: Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json#L154:9 Old: Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettingsCategories_API.json#L162:9 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️
[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2021-05-01-preview-only",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2021-05-01-preview-only",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"monitor/resource-manager/readme.md",
"tag":"package-2021-05-01-preview-only",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
️️✔️
[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️
[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Thank you for your contribution LarryZhang19! We will review the pull request and get back to you soon. |
Swagger Generation Artifacts
|
[Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks. |
Hi @LarryZhang19, you should copy the files of previous api version as the fist commit. |
Hi, @LarryZhang19 your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @kairu-ms |
...manager/Microsoft.Insights/preview/2021-05-01-preview/diagnosticsSettingsCategories_API.json
Show resolved
Hide resolved
It's okay to keep it old way if it causes lots of CI errors. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved from ARM side.
Hi Larry, few comments:
|
* adding new api version 2021-05-01-preview * Addng missing bracket * Fix formatting * Formatting * Fix fields * Fix merge conflicts and systemData * Fix prettier * Fix systemData * Fix pr comments from ARM team. * Fix tab * Address ARM PR comment round 2 * Fix systemData and revert 2017-05-01-preview mistake * Fix location in samples * fix prettier * Fix type lint errors * Type fix * One last missing object type * Revert ErrorResponse change as it's breaking change Co-authored-by: Phoenix He <tih@microsoft.com>
* adding new api version 2021-05-01-preview * Addng missing bracket * Fix formatting * Formatting * Fix fields * Fix merge conflicts and systemData * Fix prettier * Fix systemData * Fix pr comments from ARM team. * Fix tab * Address ARM PR comment round 2 * Fix systemData and revert 2017-05-01-preview mistake * Fix location in samples * fix prettier * Fix type lint errors * Type fix * One last missing object type * Revert ErrorResponse change as it's breaking change Co-authored-by: Phoenix He <tih@microsoft.com>
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Please ensure to add changelog with this PR by answering the following questions.
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.
Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.