-
Notifications
You must be signed in to change notification settings - Fork 5.6k
New 2020-03-01 API Version for Streaming Jobs #14199
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
Conversation
|
Hi, @roslynlu 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. [email protected] |
|
[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 @roslynlu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
|
Hi, @roslynlu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board([email protected]). cc @zhenglaizhang |
|
NewApiVersionRequired reason: |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
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: isDataAction Location: Microsoft.StreamAnalytics/stable/2020-03-01/streamingjobs.json#L605 |
The following errors/warnings exist before current PR submission:
Only 10 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
R4015 - NestedResourcesMustHaveListOperation |
The nested resource 'Transformation' does not have list operation, please add it. Location: Microsoft.StreamAnalytics/stable/2020-03-01/transformations.json#L241 |
R4015 - NestedResourcesMustHaveListOperation |
The nested resource 'Transformation' does not have list operation, please add it. Location: Microsoft.StreamAnalytics/stable/2016-03-01/transformations.json#L241 |
R4018 - OperationsApiResponseSchema |
The response schema of operations API '/providers/Microsoft.StreamAnalytics/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L36 |
R4037 - MissingTypeObject |
The schema 'properties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2020-03-01/subscriptions.json#L104 |
R4037 - MissingTypeObject |
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L528 |
R4037 - MissingTypeObject |
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L555 |
R4037 - MissingTypeObject |
The schema 'StreamingJob' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L583 |
R4037 - MissingTypeObject |
The schema 'StreamingJobProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L598 |
R4037 - MissingTypeObject |
The schema 'Sku' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L699 |
R4037 - MissingTypeObject |
The schema 'StreamingJobListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.StreamAnalytics/stable/2016-03-01/streamingjobs.json#L715 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The default tag contains multiple API versions swaggers. readme: specification/streamanalytics/resource-manager/readme.md tag: specification/streamanalytics/resource-manager/readme.md#tag-package-2020-03-preview |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌Cross-Version Breaking Changes: 911 Errors, 8 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.11)
- current:stable/2020-03-01/functions.json compared with base:preview/2017-04-01-preview/functions.json
- current:stable/2020-03-01/inputs.json compared with base:preview/2017-04-01-preview/inputs.json
- current:stable/2020-03-01/outputs.json compared with base:preview/2017-04-01-preview/outputs.json
- current:stable/2020-03-01/streamingjobs.json compared with base:preview/2017-04-01-preview/streamingjobs.json
- current:stable/2020-03-01/subscriptions.json compared with base:preview/2017-04-01-preview/subscriptions.json
- current:stable/2020-03-01/transformations.json compared with base:preview/2017-04-01-preview/transformations.json
- current:stable/2020-03-01/functions.json compared with base:stable/2016-03-01/functions.json
- current:stable/2020-03-01/inputs.json compared with base:stable/2016-03-01/inputs.json
- current:stable/2020-03-01/outputs.json compared with base:stable/2016-03-01/outputs.json
- current:stable/2020-03-01/streamingjobs.json compared with base:stable/2016-03-01/streamingjobs.json
- current:stable/2020-03-01/subscriptions.json compared with base:stable/2016-03-01/subscriptions.json
- current:stable/2020-03-01/transformations.json compared with base:stable/2016-03-01/transformations.json
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 |
|---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.StreamAnalytics/streamingjobs/{jobName}/functions/{functionName}/RetrieveDefaultDefinition' removed or restructured? Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L374:5 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'FunctionConfiguration' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AzureMachineLearningStudioFunctionBinding' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'CSharpFunctionBinding' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AzureMachineLearningStudioFunctionRetrieveDefaultDefinitionParameters' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AzureMachineLearningServiceFunctionRetrieveDefaultDefinitionParameters' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'CSharpFunctionRetrieveDefaultDefinitionParameters' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AzureMachineLearningServiceFunctionBinding' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'AggregateFunctionProperties' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/functions.json#L459:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/functions.json#L423:3 |
1006 - RemovedDefinition |
The new version is missing a definition that was found in the old version. Was 'CustomClrSerialization' removed or renamed? New: Microsoft.StreamAnalytics/stable/2020-03-01/inputs.json#L423:3 Old: Microsoft.StreamAnalytics/preview/2017-04-01-preview/inputs.json#L387:3 |
️️✔️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
- streamanalytics/resource-manager/readme.md#package-2020-03-preview
- streamanalytics/resource-manager/readme.md#package-pure-2020-03-preview
- streamanalytics/resource-manager/readme.md#package-pure-2017-04-preview
- streamanalytics/resource-manager/readme.md#package-pure-2016-03
- streamanalytics/resource-manager/readme.md#package-pure-2020-03
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-2020-03-preview",
"details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-2020-03-preview",
"details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2020-03",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2020-03",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
The following errors/warnings exist before current PR submission:
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-2020-03-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2020-03-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2020-03-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2017-04-preview",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2017-04-preview",
"details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2016-03",
"details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
|:speech_balloon: AutorestCore/Exception|"readme":"streamanalytics/resource-manager/readme.md",
"tag":"package-pure-2016-03",
"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
|
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
For python, the breaking change is expected. |
* copy 2016 version into 2020 folder to easily see diff * add the changes from 2017 preview * add dynamic scaling api and update api version to 2020 * add new version to readme * remove accidental changes to 2017 folder * fix streamingjobs.json * fix operations api * minor fixes * address some review comments * more validation fixes * address comments * fix breaking changes * prettier fix * update 2016 * fix some validation checks * try to fix location/tags validation error * fix lintdiff * fix lintdiff warnings * missed one Co-authored-by: Roslyn Lu <[email protected]>
Features added to this new swagger version:
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.