Fix TimeSeriesInsights swagger issues #12204
Merged
Conversation
This file contains 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
|
Hi, @kairu-ms 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 |
|---|---|
|
"readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2018-08-preview", "details":"Schema 'StandardEnvironmentResourceProperties' inherits 'EnvironmentResourceProperties' via an allOf that is already coming from parent 'ResourceProperties'" |
|
"readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2018-08-preview", "details":"Schema 'LongTermEnvironmentResourceProperties' inherits 'EnvironmentResourceProperties' via an allOf that is already coming from parent 'ResourceProperties'" |
|
"readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2018-08-preview", "details":"Error: Plugin prechecker reported failure." |
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'Operation-display' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'ResourceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'CreateOrUpdateTrackedResourceProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
|
| "readme":"timeseriesinsights/resource-manager/readme.md", "tag":"package-2020-05-15", "details":"The schema 'EnvironmentCreateOrUpdateParameters' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'" |
️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
Swagger Generation Artifacts
|
kairu-ms
commented
Dec 22, 2020
...ghts/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json
Show resolved
Hide resolved
kairu-ms
commented
Dec 22, 2020
| @@ -1900,8 +1910,22 @@ | |||
| "description": "Parameters supplied to the Create or Update Event Source operation for an IoTHub event source." | |||
| }, | |||
| "EventSourceUpdateParameters": { | |||
| "discriminator": "kind", | |||
There was a problem hiding this comment.
Add this to discriminate "EventHubEventSourceUpdateParameters" and "IoTHubEventSourceUpdateParameters".
kairu-ms
commented
Dec 22, 2020
...ghts/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json
Show resolved
Hide resolved
|
Hi @kairu-ms, 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. |
This was referenced Dec 22, 2020
|
Hi @akning-ms, I'm trying to fix a patch method with polymorphic parameter. It's failed to pass some checkers. I think it's a special case because the discriminator 'kind' is not needed in request body, while it's needed for discrimination in SDK. So I marked it as a read only parameter. But it cannot pass checkers. I wander if there're any better operations. Another change is to remove 'ResourceProperties' because its properties already contained by others. It's also failed to pass breaking change checker. BTW, the new swagger can successfully generate Python Track2 SDK and works well with service API. And I've implemented the CLI commands based on it. |
00Kai0
approved these changes
Dec 23, 2020
xseeseesee
approved these changes
Dec 23, 2020
|
Hi @kairu-ms, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi @kairu-ms, pls ping related tools owner for help in above table. |
|
Hi, @kairu-ms. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
ghost
added
the
raych1
reviewed
Feb 1, 2021
...ghts/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json
Show resolved
Hide resolved
|
In the Window Period to fix mismatches between swagger and service, when PR is labelled with “FixS360”, breaking change can be approved by PR assignee; the Azure Breaking Change Board is no longer required to approve the PR. Please ensure to clarify what s360 action items to be solved, and @ mention PR assignee for awareness. Please check this wiki [Window to Fix Broken]( Window to Fix Broken - Overview (azure.com)) for more details. |
|
Hi @JeffreyRichter, this PR is to fix swagger issues. Can you review and approve the breaking change. Thanks. |
JeffreyRichter
added
the
Approved-BreakingChange
JeffreyRichter
approved these changes
Feb 9, 2021
|
Hi @xccc-msft. This RP is ready, can you help to merge it? |
This was referenced Feb 10, 2021
Merged
iscai-msft
added a commit
to iscai-msft/azure-rest-api-specs
that referenced
this pull request
Feb 10, 2021
…into fix_resource_multiapi_submodule * 'master' of https://github.com/Azure/azure-rest-api-specs: (452 commits) Dev cost management microsoft.cost management 2020 12 01 preview new (Azure#12259) Edit securityContact swagger for 2020-01-01 (Azure#12265) [Hub Generated] Review request for Microsoft.Insights to add version stable/2020-10-01 (Azure#11579) [Hub Generated] Review request for Microsoft.Media to add version stable/2020-05-01 (Azure#12681) Fix TimeSeriesInsights swagger issues (Azure#12204) Fixing error in lastModifiedAt description (Azure#12854) Update comment.yml (Azure#12910) Fixing RI s360 Flagged corrections in 2019-10-01 version (Azure#12777) [Hub Generated] Review request for Microsoft.Web to add version stable/2020-10-01 (Azure#11636) [Ready For Review] New version 20210101 (Azure#12111) Update scheduledQueryRule_API.json (Azure#12895) Remove UserAssigned MSI (Azure#12900) Update library.json (Azure#12922) KeyVault: Feature/update security domain spec (Azure#12863) Fixes ExampleId type and incorrect ArmTokenParameter name (Azure#12896) Update contract for anomaly detector (Azure#12487) [NetAppFiles] Urgent bug fix, backup response, remove systemData(not in response yet) (Azure#12852) [AML] Add PipelineEndpoint with version and DataPathAssignments fields in AzureMLExecutePipeline (Azure#12744) remove duplicated schema (Azure#12779) [Web] Add Swagger for Service Principal (Azure#12780) ...
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* add polymorphism * fix polymorphy issues for enviroment update and event-source update * remove readme.az.md * remove readme.cli.md * add suppress for kind property in timeseriesinsights.json
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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 API 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.