Skip to content
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

[Synapse Platform Service - Synase Link] add ActionOnExistingTargetTable properties of synapse link #23670

Conversation

jingzhong-MS
Copy link
Contributor

@jingzhong-MS jingzhong-MS commented Apr 21, 2023

Data Plane API - Pull Request

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

@openapi-workflow-bot
Copy link

Hi, @jingzhong-MS Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    compared swaggers (via Oad v0.10.4)] new version base version
    linkConnections.json 2023-04-18-preview(be3647e) 2022-12-01-preview(main)
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 92 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.1) new version base version
    package-artifacts-composite-v7 package-artifacts-composite-v7(be3647e) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Only 30 items are listed, please refer to log for more details.

    Rule Message Related RPC [For API reviewers]
    ⚠️ DeprecatedXmsCodeGenerationSetting The x-ms-code-generation-setting extension is being deprecated. Please remove it and move settings to readme file for code generation.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L6
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L34
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L48
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L50
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L70
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L73
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L96
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L98
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L113
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L116
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L130
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L132
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L147
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L150
    ⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L158
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L164
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L166
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L183
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L186
    ⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L203
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L206
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L208
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L225
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L228
    ⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L236
    ⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L239
    ⚠️ ErrorResponse Error response schema should contain an object property named error.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L241
    ⚠️ OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'LinkConnectionModel'. Consider using the plural form of 'LinkConnection' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L258
    ⚠️ PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L261
    ⚠️ SuccessResponseBody All success responses except 202 & 204 should define a response body.
    Location: Microsoft.Synapse/preview/2023-04-18-preview/linkConnections.json#L269
    ️⚠️Avocado: 1 Warnings warning [Detail]
    Rule Message
    ⚠️ MULTIPLE_DEFAULT_TAGS The readme file has more than one default tag.
    readme: specification/synapse/data-plane/readme.md
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

    API Test is not triggered due to precheck failure. Check pipeline log for details.

    ️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
    ️️✔️CadlAPIView succeeded [Detail] [Expand]
    ️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    ️️✔️TypeSpec Validation succeeded [Detail] [Expand]
    Validation passes for TypeSpec Validation.
    ️️✔️PR Summary succeeded [Detail] [Expand]
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Apr 21, 2023

    Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

    @jingzhong-MS jingzhong-MS changed the title add synapse 2023-04-18-preview [Synapse Platform Service - Synase Link] add synapse 2023-04-18-preview Apr 21, 2023
    @ghost ghost added the Synapses label Apr 21, 2023
    @openapi-workflow-bot
    Copy link

    Hi, @jingzhong-MS, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    @jingzhong-MS jingzhong-MS force-pushed the dev/jingzhong/synapselink-dataplane-2023-04-18-preview branch from 571304a to f1e251e Compare April 27, 2023 11:50
    @jingzhong-MS jingzhong-MS changed the title [Synapse Platform Service - Synase Link] add synapse 2023-04-18-preview [Synapse Platform Service - Synase Link] add ActionOnExistingTargetTable properties of synapse link Apr 27, 2023
    @jingzhong-MS jingzhong-MS force-pushed the dev/jingzhong/synapselink-dataplane-2023-04-18-preview branch from f1e251e to fec99ae Compare May 6, 2023 01:58
    * remove dropExistingTargetTableOnStart properties
    
    * add actionOnExistingTargetTable properties
    @jingzhong-MS jingzhong-MS force-pushed the dev/jingzhong/synapselink-dataplane-2023-04-18-preview branch from fec99ae to be3647e Compare May 6, 2023 02:57
    @markweitzel markweitzel self-requested a review May 18, 2023 23:15
    Copy link
    Member

    @markweitzel markweitzel left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Per the API Stewardship Board meeting on 18-May23, this is approved by the Stewardship Board

    @markweitzel markweitzel requested a review from mikekistler May 18, 2023 23:18
    Copy link
    Member

    @mikekistler mikekistler left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    Looks good! 👍

    @mikekistler mikekistler added the APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. label May 18, 2023
    @lmazuel lmazuel merged commit 60409c8 into Azure:main May 22, 2023
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    APIStewardshipBoard-SignedOff The Azure API Stewardship team has reviewed and approved the changes. CI-MissingBaseCommit data-plane new-api-version Synapses
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants