Azure Synapse GA API Version #12502
Merged
Azure Synapse GA API Version #12502
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, @amoghnatu 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 |
|---|---|
|
The response of operation:'BigDataPools_Get' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/bigDataPool.json#L25 |
|
The response of operation:'BigDataPools_Update' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/bigDataPool.json#L78 |
|
The response of operation:'BigDataPools_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/bigDataPool.json#L142 |
|
The response of operation:'IpFirewallRules_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/firewallRule.json#L75 |
|
The response of operation:'IpFirewallRules_Get' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/firewallRule.json#L203 |
|
The response of operation:'IntegrationRuntimes_Update' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json#L25 |
|
The response of operation:'IntegrationRuntimes_Get' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json#L85 |
|
The response of operation:'IntegrationRuntimes_Create' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/integrationRuntime.json#L146 |
|
The response of operation:'Keys_Get' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/keys.json#L75 |
|
The response of operation:'Keys_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response. New: Microsoft.Synapse/stable/2020-12-01/keys.json#L123 |
️⚠️Avocado: 1 Warnings warning [Detail]
| Rule | Message |
|---|---|
| The JSON file has a circular reference. readme: specification/synapse/resource-manager/readme.md json: Microsoft.Synapse/stable/2020-12-01/workspace.json |
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️⚠️[Staging] Cross Version BreakingChange (Base on preview version): 163 Warnings warning [Detail]
Only 10 items are listed, please refer to log for more details.
- Compared Swaggers (Based on Oad v0.8.6)
- original: preview/2019-06-01-preview/bigDataPool.json <---> new: stable/2020-12-01/bigDataPool.json
- original: preview/2019-06-01-preview/checkNameAvailability.json <---> new: stable/2020-12-01/checkNameAvailability.json
- original: preview/2019-06-01-preview/firewallRule.json <---> new: stable/2020-12-01/firewallRule.json
- original: preview/2019-06-01-preview/integrationRuntime.json <---> new: stable/2020-12-01/integrationRuntime.json
- original: preview/2019-06-01-preview/keys.json <---> new: stable/2020-12-01/keys.json
- original: preview/2020-04-01-preview/operations.json <---> new: stable/2020-12-01/operations.json
- original: preview/2019-06-01-preview/privateEndpointConnections.json <---> new: stable/2020-12-01/privateEndpointConnections.json
- original: preview/2019-06-01-preview/privateLinkResources.json <---> new: stable/2020-12-01/privateLinkResources.json
- original: preview/2019-06-01-preview/privatelinkhub.json <---> new: stable/2020-12-01/privatelinkhub.json
- original: preview/2020-04-01-preview/sqlPool.json <---> new: stable/2020-12-01/sqlPool.json
- original: preview/2019-06-01-preview/sqlServer.json <---> new: stable/2020-12-01/sqlServer.json
- original: preview/2019-06-01-preview/workspace.json <---> new: stable/2020-12-01/workspace.json
| Rule | Message |
|---|---|
| The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlpools' removed or restructured? Old: Microsoft.Synapse/preview/2019-06-01-preview/sqlServer.json#L848:5 |
|
| The new version is missing a definition that was found in the old version. Was 'SqlPoolProperties' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/sqlPool.json#L5227:3 Old: Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json#L275:3 |
|
| The new version is missing a definition that was found in the old version. Was 'SqlPoolV3' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/sqlPool.json#L5227:3 Old: Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json#L275:3 |
|
| The new version is missing a definition that was found in the old version. Was 'SqlPoolUpdate' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/sqlPool.json#L5227:3 Old: Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json#L275:3 |
|
| The new version is missing a definition that was found in the old version. Was 'SystemData' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/sqlPool.json#L5227:3 Old: Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json#L275:3 |
|
| The new version is missing a client parameter that was found in the old version. Was 'WorkspaceNameParameter' removed or renamed? New: azure-rest-api-specs/blob/3176dce78995ca31ac025db1d128563bb7a34b4c/revision:1974:2 Old: azure-rest-api-specs/blob/master/revision:1818:2 |
|
| The new version is missing a client parameter that was found in the old version. Was 'WorkspaceNameParameter' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/sqlPool.json#L7600:3 Old: azure-rest-api-specs/blob/master/revision:844:2 |
|
| The new version is missing a client parameter that was found in the old version. Was 'SqlPoolNameParameter' removed or renamed? New: Microsoft.Synapse/stable/2020-12-01/sqlPool.json#L7600:3 Old: azure-rest-api-specs/blob/master/revision:844:2 |
|
| The operation id has been changed from 'SqlV3Operations_List' to 'Operations_List'. This will impact generated code. New: Microsoft.Synapse/stable/2020-12-01/operations.json#L25:7 Old: Microsoft.Synapse/preview/2020-04-01-preview/operations.json#L25:7 |
|
| The operation id has been changed from 'SqlV3Operations_GetLocationHeaderResult' to 'Operations_GetLocationHeaderResult'. This will impact generated code. New: Microsoft.Synapse/stable/2020-12-01/operations.json#L62:7 Old: Microsoft.Synapse/preview/2020-04-01-preview/operations.json#L62:7 |
️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
Swagger Generation Artifacts
|
| Rule | Message |
|---|---|
|
"logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=189864&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b", "detail":"FATAL ERROR: CALL_AND_RETRY_LAST Allocation failed - JavaScript heap out of memory" |
openapi-workflow-bot
bot
added
the
WaitForARMFeedback
|
Hi, @amoghnatu your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com). cc @ |
|
Hi @amoghnatu, Your PR has some issues. Please fix the CI sequentially by following the order of
|
openapi-pipeline-app
bot
added
CI-BreakingChange-Python
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
This was referenced Jan 19, 2021
|
@amoghnatu I see two preview api versions for synapse - 2019-06-01-preview and 2020-04-01-preview. In this PR, I see the base commit has the specs from 2019-06-01-preview version. Did you ensure the changes added in 2020-04-01-preview version are also in GA version? |
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/bigDataPool.json
Show resolved
Hide resolved
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/bigDataPool.json
Show resolved
Hide resolved
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Show resolved
Hide resolved
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
|
Hi @amoghnatu, 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. |
|
Cross API version breaking change, need breaking change review board approval. |
idear1203
reviewed
Jan 22, 2021
| "WorkspaceManagedSqlServer", | ||
| "recoverableSqlpools" | ||
| ], | ||
| "operationId": "WorkspaceManagedSqlServerRecoverableSqlpools_List", |
There was a problem hiding this comment.
WorkspaceManagedSqlServerRecoverableSqlpools_List [](start = 24, length = 49)
Please change to WorkspaceManagedSqlServerRecoverableSqlPools_List to make it consistent with other operation IDs
idear1203
reviewed
Jan 22, 2021
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
idear1203
reviewed
Jan 22, 2021
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
idear1203
reviewed
Jan 22, 2021
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
idear1203
reviewed
Jan 22, 2021
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
idear1203
reviewed
Jan 22, 2021
specification/synapse/resource-manager/Microsoft.Synapse/stable/2020-12-01/sqlServer.json
Outdated
Show resolved
Hide resolved
openapi-pipeline-app
bot
added
CI-FixRequiredOnFailure
and removed
CI-FixRequiredOnFailure
labels
RamyasreeChakka
added
WaitForARMFeedback
RamyasreeChakka
approved these changes
Jan 23, 2021
idear1203
approved these changes
Jan 23, 2021
akning-ms
reviewed
Jan 23, 2021
| @@ -1089,13 +1089,13 @@ | |||
| } | |||
| } | |||
| }, | |||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlpools": { | |||
| "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/recoverableSqlPools": { | |||
There was a problem hiding this comment.
Can you let me know why change this case issue? as it will cause SDK breaking change, specially for operation id change. if not special reason. suggest to revert.
There was a problem hiding this comment.
The SDK's have not yet been generated for this api version. This is a new API version we're adding and there are NO SDKs right now. So nothing would fail.
There was a problem hiding this comment.
@akning-ms Is there anything pending for merging this PR?
This was referenced Jan 23, 2021
[ReleasePR synapse] [Synapse] - Remove x-ms-azure-resource
Azure/azure-resource-manager-schemas#1315
Merged
mkarmark
pushed a commit
to mkarmark/azure-rest-api-specs
that referenced
this pull request
Jul 21, 2021
* Base commit - Copied 2019-06-01-preview api version to stable version 2020-12-01 * GA API Version changes. * updated response property to readOnly and fixed example file. * Fixed spell check error. * Fixed review comments. * Fixed review comment. * Fixed review comments. * Fixed review comments. * Fixed lint errors. * Fixed go readme. file. * Fixed review comments and added JEDI requirement swagger. Co-authored-by: Amogh Natu <amnat@microsoft.com>
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.