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

[DataFactory]Add Some SHIR Features In DataFatory #25162

Merged
merged 10 commits into from
Aug 30, 2023
Merged

[DataFactory]Add Some SHIR Features In DataFatory #25162

merged 10 commits into from
Aug 30, 2023

Conversation

Jingshu918
Copy link
Contributor

@Jingshu918 Jingshu918 commented Aug 4, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] public repo review queue, private repo review queue
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub, per this wiki doc.)
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Getting help

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 4, 2023

Swagger Validation Report

️❌BreakingChange: 4 Errors, 0 Warnings failed [Detail]
compared swaggers (via Oad v0.10.4)] new version base version
IntegrationRuntime.json 2018-06-01(f926988) 2018-06-01(main)
Rule Message
1045 - AddedOptionalProperty The new version has a new optional property 'numberOfPipelineNodes' that was not found in the old version.
New: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L220:7
Old: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L220:7
1045 - AddedOptionalProperty The new version has a new optional property 'numberOfExternalNodes' that was not found in the old version.
New: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L220:7
Old: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L220:7
1045 - AddedOptionalProperty The new version has a new optional property 'selfContainedInteractiveAuthoringEnabled' that was not found in the old version.
New: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L646:7
Old: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L632:7
1045 - AddedOptionalProperty The new version has a new optional property 'selfContainedInteractiveAuthoringEnabled' that was not found in the old version.
New: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1019:7
Old: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1001:7
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 2 Warnings warning [Detail]
compared tags (via openapi-validator v2.1.4) new version base version
package-2018-06 package-2018-06(f926988) package-2018-06(main)

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

Rule Message Related RPC [For API reviewers]
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L650
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1129


The following errors/warnings exist before current PR submission:

Rule Message
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L104
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L169
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1290
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1339
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1644
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1648
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1668
⚠️ EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
Location: stable/2018-06-01/entityTypes/IntegrationRuntime.json#L1699
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️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).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Aug 4, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌SDK Breaking Change Tracking failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-net-track2 succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-python-track2 warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-java warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi @Jingshu918, this service has enabled Service API Toolset. All spec updates MUST be initiated from service ADO project repo, so that to guarantee it to be the source of truth., please review this pull request if it's intentional or reject it if it's not expected. Normally, all the specification or example changes should start with PR created in ADO.

  • You can refer to Service API Toolset Introduction for details.
  • Please contact service focal contacts or Service API Toolset Support Channel if need further help.
  • @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 4, 2023

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/datafactory/armdatafactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    Java azure-resourcemanager-datafactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    JavaScript @azure/arm-datafactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.
    .Net Azure.ResourceManager.DataFactory Create ApiView failed. Please ensure your github account in Azure/Microsoft is public and add a comment "/azp run" to re-trigger the CI.

    @openapi-workflow-bot
    Copy link

    Hi, @Jingshu918! Thank you for your pull request. To help get your PR merged:

  • Ensure you reviewed the checklists in the PR description.
  • Know that PR assignee is the person auto-assigned and responsible for your current PR review and approval.
  • For convenient view of the API changes made by this PR, refer to the URLs provided in the table in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.
  • @openapi-workflow-bot openapi-workflow-bot bot added the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 4, 2023
    @microsoft-github-policy-service
    Copy link
    Contributor

    Thank you for your contribution Jingshu918! We will review the pull request and get back to you soon.

    @microsoft-github-policy-service microsoft-github-policy-service bot added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Aug 4, 2023
    @AzureRestAPISpecReview AzureRestAPISpecReview added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review ARMReview NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager labels Aug 4, 2023
    @openapi-workflow-bot
    Copy link

    Please address or respond to feedback from the ARM API reviewer.
    When you are ready to continue the ARM API review, please remove the ARMChangesRequested label.
    This will notify the reviewer to have another look.
    If the feedback provided needs further discussion, please use this Teams channel to post your questions - aka.ms/azsdk/support/specreview-channel.
    Please include [ARM Query] in the title of your question to indicate that it is ARM-related.

    @openapi-workflow-bot
    Copy link

    Hi @Jingshu918! The automation detected this pull request introduces changes to at least one existing API version that violate Azure's versioning policy. To comply with the policy, these changes must be made in a new API version. As a result, the automation added the NewApiVersionRequired label.

    You cannot proceed with merging this PR until you complete one of the following action items:

    ACTION ITEM ALTERNATIVE A: Introduce a new API version.
    Submit a new PR instead of this one, or modify this PR, so that it adds a new API version instead of introducing changes to existing API versions.

    ACTION ITEM ALTERNATIVE B: Request approval.
    Alternatively, if you cannot avoid modifying existing API versions, then you can request an approval for them. Please follow the breaking changes process.
    This case applies even if:

    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason. Such claims must be reviewed, and the process is the same.

    This reverts commit 9caf1ac.
    This reverts commit e1e86ce.
    @openapi-pipeline-app
    Copy link

    Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛.

    @Jingshu918
    Copy link
    Contributor Author

    @raych1 @msyyc @qiaozha Please help review SDK breaking change.

    @Frey-Wang Frey-Wang removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Aug 24, 2023
    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 24, 2023
    @ms-henglu ms-henglu added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Aug 24, 2023
    @openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Aug 24, 2023
    @Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Aug 25, 2023
    @kazrael2119
    Copy link
    Contributor

    this js sdk breaking is not caused by this pr

    @msyyc
    Copy link
    Member

    msyyc commented Aug 28, 2023

    Python SDK breaking is not caused by this PR

    @Jingshu918
    Copy link
    Contributor Author

    /pr RequestMerge

    @sjanamma
    Copy link

    @Jingshu918 - Please remove DoNotMerge tag, in order for this PR to be merged by the ARM API reviewers' team.

    @Frey-Wang Frey-Wang removed the DoNotMerge <valid label in PR review process> use to hold merge after approval label Aug 29, 2023
    @sjanamma
    Copy link

    @Jingshu918 - Please get the PR approved by one of the required approvers.

    @sjanamma sjanamma merged commit 514250f into Azure:main Aug 30, 2023
    @openapi-pipeline-app
    Copy link

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

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript Approved-SdkBreakingChange-Python ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript customer-reported Issues that are reported by GitHub users external to the Azure organization. DoNotMerge <valid label in PR review process> use to hold merge after approval NewApiVersionRequired ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager ShiftLeftViolation
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.