-
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
Microsoft.TimeSeriesInsights: Fix swagger correctness issues #14469
Microsoft.TimeSeriesInsights: Fix swagger correctness issues #14469
Conversation
Hi, @k-rush 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: fillGapWithZero Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L1215 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
Rule | Message |
---|---|
R4009 - RequiredReadOnlySystemData |
The response of operation:'Environments_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L140 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'EventSources_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L418 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ReferenceDataSets_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L665 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'AccessPolicies_Get' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L912 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Environments_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L74 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'EventSources_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L350 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'ReferenceDataSets_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L600 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'AccessPolicies_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L847 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'Environments_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L183 |
R4009 - RequiredReadOnlySystemData |
The response of operation:'EventSources_Update' is defined without 'systemData'. Consider adding the systemData to the response. Location: Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json#L461 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
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":"timeseriesinsights/resource-manager/readme.md",
"tag":"package-2020-05-15",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"timeseriesinsights/resource-manager/readme.md",
"tag":"package-2020-05-15",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"timeseriesinsights/resource-manager/readme.md",
"tag":"package-2020-05-15",
"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).
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. |
NewApiVersionRequired reason: |
Hi @k-rush, 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. |
@akning-ms I believe 3 of the breaking changes are a false positive. While the tooling mentions I removed the The other 2 are additional properties on the Operations response. This is required to fix the following Swagger Correctness S360 KPI: https://portal.azure-devex-tools.com/amekpis/correctness/detail?errorId=61AD52F9-7FD8-4B91-84EF-38672D8D5B3D I don't think either of these will have measurable negative customer impact, but I'm open to suggestions on how to mitigate any if there were to be. |
Yes. looks localTimeStamp is false alarm. @jianyexi to confirm, |
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.
Changes look good to me.
@ruowan, can you please review this? |
/azp run |
Azure Pipelines successfully started running 1 pipeline(s). |
Python SDK track2 failed. @msyyc help to take a look. |
@k-rush I've made some changes to your branch to fix Python SDK track2 failed, you can use it as a reference. |
…sInsights-2020-05-15
@RAY-316 Thanks! Those changes were already made in |
…0-05-15' of https://github.com/k-rush/azure-rest-api-specs into dev-timeseriesinsights-Microsoft.TimeSeriesInsights-2020-05-15
@ruowan what else do I need to do to get this PR in? |
@msyyc @ArcturusZhang pls help check the python & go SDK breaking changes. |
For python, the breaking change is permitted. |
…ger correctness issues (#1784) Create to sync Azure/azure-rest-api-specs#14469 [ReCreate this PR](https://github.com/azure-resource-manager-schemas/compare/master...AzureSDKAutomation:sdkAuto/timeseriesinsights?expand=1)
…4469) * Fix swagger correctness issues * Fix casing in localTimestamp * Fix localTimeStamp property * Fix lintdiff errors
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.