-
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
Added stable version of synapse dataplane APIs #14033
Conversation
Hi, @xolve 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 |
---|---|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3450 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3571 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3589 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3636 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3654 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3706 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3745 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3797 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3816 |
|
Consider using x-ms-client-flatten to provide a better end user experience Location: Microsoft.Synapse/stable/2020-12-01/artifacts.json#L3953 |
️⚠️
Avocado: 1 Warnings warning [Detail]
Rule | Message |
---|---|
The JSON file has a circular reference. readme: specification/synapse/data-plane/readme.md json: stable/2020-12-01/entityTypes/Pipeline.json |
️️✔️
ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️❌
Cross-Version Breaking Changes: 41 Errors, 0 Warnings failed [Detail]
- Compared Swaggers (Based on Oad v0.8.9)
- current:stable/2020-12-01/artifacts.json compared with base:preview/2019-06-01-preview/artifacts.json
- current:stable/2020-12-01/bigDataPools.json compared with base:preview/2019-06-01-preview/bigDataPools.json
- current:stable/2020-12-01/checkAccessSynapseRbac.json compared with base:preview/2020-08-01-preview/checkAccessSynapseRbac.json
- current:2020-12-01/entityTypes/DataFlow.json compared with base:2019-06-01-preview/entityTypes/DataFlow.json
- current:2020-12-01/entityTypes/Dataset.json compared with base:2019-06-01-preview/entityTypes/Dataset.json
- current:2020-12-01/entityTypes/LinkedService.json compared with base:2019-06-01-preview/entityTypes/LinkedService.json
- current:2020-12-01/entityTypes/Notebook.json compared with base:2019-06-01-preview/entityTypes/Notebook.json
- current:2020-12-01/entityTypes/Pipeline.json compared with base:2019-06-01-preview/entityTypes/Pipeline.json
- current:2020-12-01/entityTypes/SparkJobDefinition.json compared with base:2019-06-01-preview/entityTypes/SparkJobDefinition.json
- current:2020-12-01/entityTypes/SqlScript.json compared with base:2019-06-01-preview/entityTypes/SqlScript.json
- current:2020-12-01/entityTypes/Trigger.json compared with base:2019-06-01-preview/entityTypes/Trigger.json
- current:stable/2020-12-01/gitintegration.json compared with base:preview/2019-06-01-preview/gitintegration.json
- current:stable/2020-12-01/integrationRuntimes.json compared with base:preview/2019-06-01-preview/integrationRuntimes.json
- current:stable/2020-12-01/library.json compared with base:preview/2019-06-01-preview/library.json
- current:stable/2020-12-01/managedPrivateEndpoints.json compared with base:preview/2019-06-01-preview/managedPrivateEndpoints.json
- current:stable/2020-12-01/monitoring.json compared with base:preview/2019-11-01-preview/monitoring.json
- current:stable/2020-12-01/roleAssignments.json compared with base:preview/2020-08-01-preview/roleAssignments.json
- current:stable/2020-12-01/roleDefinitions.json compared with base:preview/2020-08-01-preview/roleDefinitions.json
- current:stable/2020-12-01/sparkJob.json compared with base:preview/2019-11-01-preview/sparkJob.json
- current:stable/2020-12-01/sqlPools.json compared with base:preview/2019-06-01-preview/sqlPools.json
- current:stable/2020-12-01/workspace.json compared with base:preview/2019-06-01-preview/workspace.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 '/notebooks/summary' removed or restructured? Old: Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json#L2429:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/batches' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L35:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/batches/{batchId}' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L132:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sessions' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L210:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sessions/{sessionId}' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L307:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sessions/{sessionId}/reset-timeout' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L385:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sessions/{sessionId}/statements' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L420:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sessions/{sessionId}/statements/{statementId}' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L503:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/sessions/{sessionId}/statements/{statementId}/cancel' removed or restructured? Old: Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json#L549:5 |
1007 - RemovedClientParameter |
The new version is missing a client parameter that was found in the old version. Was 'RoleIdParameter' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/roleAssignments.json#L288:3 Old: Microsoft.Synapse/preview/2020-08-01-preview/roleAssignments.json#L341:3 |
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️
[Staging] SDK Track2 Validation: 1 Warnings warning [Detail]
- The following tags are being changed in this PR
Rule | Message |
---|---|
"readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2020-12-01", "details":"The schema 'NotebookCellOutputItem-text' has no type or format information whatsoever. Location:\n file:///home/vsts/work/1/azure-rest-api-specs/specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json#/components/schemas/NotebookCellOutputItem-text" |
|
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2020-12-01", "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2020-12-01", "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-artifacts-2020-12-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-monitoring-2020-12-01", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-monitoring-2020-12-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-access-control-2020-12-01", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-access-control-2020-12-01", "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-vnet-2020-12-01", "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)" |
💬 AutorestCore/Exception | "readme":"synapse/data-plane/readme.md", "tag":"package-vnet-2020-12-01", "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 pipeline restarted successfully, please wait for status update in this comment. |
[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 @xolve, Your PR has some issues. Please fix the CI sequentially by following the order of
|
NewApiVersionRequired reason: |
Hi @xolve, 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. |
@jianyexi Could you help to take a look at this PR? look autorest failed due to the model conflict. |
} | ||
} | ||
}, | ||
"ErrorResponse": { |
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.
This has conflict with "../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse", please use the latter one .
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.
Thanks @jianyexi for relative path to exact type. I get the error:
UnhandledPromiseRejectionWarning: Error: '$.definitions.ErrorResponse.title' has incompatible values
The exception trace around it isn't very helpful. Can you please check on it.
This is data plane API. @lmazuel , could you please help with a review? |
…ype in synapse commons.
…bookOperationResults.
### Tag: package-monitoring-2020-12-01 | ||
|
||
These settings apply only when `--tag=package-monitoring-2020-12-01` is specified on the command line. | ||
|
||
``` yaml $(tag) == 'package-artifacts-2020-12-01' | ||
input-file: | ||
- Microsoft.Synapse/stable/2020-12-01/artifacts.json | ||
- Microsoft.Synapse/stable/2020-12-01/bigDataPools.json | ||
- Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json | ||
- Microsoft.Synapse/stable/2020-12-01/gitintegration.json | ||
- Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json | ||
- Microsoft.Synapse/stable/2020-12-01/library.json | ||
- Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json | ||
- Microsoft.Synapse/stable/2020-12-01/monitoring.json | ||
- Microsoft.Synapse/stable/2020-12-01/operations.json | ||
- Microsoft.Synapse/stable/2020-12-01/roleAssignments.json | ||
- Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json | ||
- Microsoft.Synapse/stable/2020-12-01/roles.json | ||
- Microsoft.Synapse/stable/2020-12-01/sparkJob.json | ||
- Microsoft.Synapse/stable/2020-12-01/sqlPools.json | ||
- Microsoft.Synapse/stable/2020-12-01/workspace.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json | ||
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json | ||
``` | ||
|
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.
### Tag: package-monitoring-2020-12-01 | |
These settings apply only when `--tag=package-monitoring-2020-12-01` is specified on the command line. | |
``` yaml $(tag) == 'package-artifacts-2020-12-01' | |
input-file: | |
- Microsoft.Synapse/stable/2020-12-01/artifacts.json | |
- Microsoft.Synapse/stable/2020-12-01/bigDataPools.json | |
- Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json | |
- Microsoft.Synapse/stable/2020-12-01/gitintegration.json | |
- Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json | |
- Microsoft.Synapse/stable/2020-12-01/library.json | |
- Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json | |
- Microsoft.Synapse/stable/2020-12-01/monitoring.json | |
- Microsoft.Synapse/stable/2020-12-01/operations.json | |
- Microsoft.Synapse/stable/2020-12-01/roleAssignments.json | |
- Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json | |
- Microsoft.Synapse/stable/2020-12-01/roles.json | |
- Microsoft.Synapse/stable/2020-12-01/sparkJob.json | |
- Microsoft.Synapse/stable/2020-12-01/sqlPools.json | |
- Microsoft.Synapse/stable/2020-12-01/workspace.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json | |
``` | |
### Tag: package-monitoring-2020-12-01 | |
These settings apply only when `--tag=package-monitoring-2020-12-01` is specified on the command line. | |
``` yaml $(tag) == 'package-artifacts-2020-12-01' | |
input-file: | |
- Microsoft.Synapse/stable/2020-12-01/artifacts.json | |
- Microsoft.Synapse/stable/2020-12-01/bigDataPools.json | |
- Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json | |
- Microsoft.Synapse/stable/2020-12-01/gitintegration.json | |
- Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json | |
- Microsoft.Synapse/stable/2020-12-01/library.json | |
- Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json | |
- Microsoft.Synapse/stable/2020-12-01/monitoring.json | |
- Microsoft.Synapse/stable/2020-12-01/operations.json | |
- Microsoft.Synapse/stable/2020-12-01/roleAssignments.json | |
- Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json | |
- Microsoft.Synapse/stable/2020-12-01/roles.json | |
- Microsoft.Synapse/stable/2020-12-01/sparkJob.json | |
- Microsoft.Synapse/stable/2020-12-01/sqlPools.json | |
- Microsoft.Synapse/stable/2020-12-01/workspace.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json | |
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json |
Tag: package-artifacts-2020-12-01
These settings apply only when --tag=package-artifacts-2020-12-01
is specified on the command line.
input-file:
- Microsoft.Synapse/stable/2020-12-01/artifacts.json
- Microsoft.Synapse/stable/2020-12-01/bigDataPools.json
- Microsoft.Synapse/stable/2020-12-01/gitintegration.json
- Microsoft.Synapse/stable/2020-12-01/integrationRuntimes.json
- Microsoft.Synapse/stable/2020-12-01/library.json
- Microsoft.Synapse/stable/2020-12-01/operations.json
- Microsoft.Synapse/stable/2020-12-01/sparkJob.json
- Microsoft.Synapse/stable/2020-12-01/sqlPools.json
- Microsoft.Synapse/stable/2020-12-01/workspace.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/DataFlow.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Dataset.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/LinkedService.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Notebook.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Pipeline.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SparkJobDefinition.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/SqlScript.json
- Microsoft.Synapse/stable/2020-12-01/entityTypes/Trigger.json
Tag: package-access-control-2020-12-01
These settings apply only when --tag=package-access-control-2020-12-01
is specified on the command line.
- Microsoft.Synapse/stable/2020-12-01/checkAccessSynapseRbac.json
- Microsoft.Synapse/stable/2020-12-01/roleAssignments.json
- Microsoft.Synapse/stable/2020-12-01/roleDefinitions.json
Tag: package-vnet-2020-12-01
These settings apply only when --tag=package-vnet-2020-12-01
is specified on the command line.
- Microsoft.Synapse/stable/2020-12-01/managedPrivateEndpoints.json
Tag: package-monitoring-2020-12-01
These settings apply only when --tag=package-monitoring-2020-12-01
is specified on the command line.
- Microsoft.Synapse/stable/2020-12-01/monitoring.json
specification/synapse/data-plane/Microsoft.Synapse/stable/2020-12-01/roles.json
Outdated
Show resolved
Hide resolved
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.
I have two questions:
|
Yes.
No. |
* Added stable version of dataplane APIs * Added spec files to readme config. * Remove unused example files. * Fixes for checks. * Fixes for checks. * Fixes for checks. * Remove duplicate schema. * Fix formatting. * Use ErrorResponse from common types. * Remove redundant type ErrorContract. * Added back ErrorContract with correct defintion, refering to common type in synapse commons. * Fixed duplicate of libraryOperationResults, fix file placment of notebookOperationResults. * Remove unused file. * Use ErrorContract for error types. * Renamed RoleIdParameter to RoleIdQueryParameter to avoid conflict. * Use common hostname as other swagger files. * Add missing API path parameters defintiions. * Fix schema type for errors. * Use ErrorContract from synapse common types. * Use diff tags and titles for different packages. * Remove deprecated roles.json spec. Co-authored-by: Ravi Arora <raviarora@microsoft.com>
* Added stable version of dataplane APIs * Added spec files to readme config. * Remove unused example files. * Fixes for checks. * Fixes for checks. * Fixes for checks. * Remove duplicate schema. * Fix formatting. * Use ErrorResponse from common types. * Remove redundant type ErrorContract. * Added back ErrorContract with correct defintion, refering to common type in synapse commons. * Fixed duplicate of libraryOperationResults, fix file placment of notebookOperationResults. * Remove unused file. * Use ErrorContract for error types. * Renamed RoleIdParameter to RoleIdQueryParameter to avoid conflict. * Use common hostname as other swagger files. * Add missing API path parameters defintiions. * Fix schema type for errors. * Use ErrorContract from synapse common types. * Use diff tags and titles for different packages. * Remove deprecated roles.json spec. Co-authored-by: Ravi Arora <raviarora@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.