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

Liftr Informatica API - Stable version release for SDK generation #29140

Merged
merged 11 commits into from
May 22, 2024

Conversation

almasak
Copy link
Member

@almasak almasak commented May 17, 2024

ARM (Control Plane) API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

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

spec_pr_review_workflow_diagram

Purpose of this PR

What's the purpose of this PR? Check the specific option that applies. This is mandatory!

  • New resource provider.
  • New API version for an existing resource provider. (If API spec is not defined in TypeSpec, the PR should have been created in adherence to OpenAPI specs PR creation guidance).
  • 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 OpenAPI spec 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:

  • I confirm this PR is modifying Azure Resource Manager (ARM) related specifications, and not data plane related specifications.
  • I have reviewed following Resource Provider guidelines, including
    ARM resource provider contract and
    REST guidelines (estimated time: 4 hours).
    I understand this is required before I can proceed to the diagram Step 2, "ARM API changes review", for this PR.

Additional information

Viewing API changes

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.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
suppressions guide to get approval.

Getting help

  • First, please carefully read through this PR description, from top to bottom. Please fill out the Purpose of this PR and Due diligence checklist.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • For help with ARM review (PR workflow diagram Step 2), see https://aka.ms/azsdk/pr-arm-review.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

Copy link

openapi-pipeline-app bot commented May 17, 2024

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Copy link

openapi-pipeline-app bot commented May 17, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 68 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
package-2024-05-08 package-2024-05-08(0b183cf) 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]
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L61
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L68
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L74
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L100
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L103
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L116
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L142
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L145
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L148
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L161
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L187
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L190
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L193
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L214
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L235
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L238
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L241
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L284
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L309
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L312
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L315
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L345
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L366
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L369
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L372
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L404
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L431
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L434
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L437
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: Informatica.DataManagement/stable/2024-05-08/openapi.json#L458
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️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?

Copy link

openapi-pipeline-app bot commented May 17, 2024

Swagger Generation Artifacts

️🔄ApiDocPreview inProgress [Detail]
️⚠️ azure-sdk-for-python warning [Detail]
  • ⚠️Warning in generating from 9fc5b26. SDK Automation 14.0.0
    command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
    cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
    warn		specification/informatica/Informatica.DataManagement/tspconfig.yaml skipped due to azure-sdk-for-python not found in tspconfig.yaml
    command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
  • ️✔️azure-mgmt-informaticadatamanagement [Preview SDK Changes]
    • azure-mgmt-informaticadatamanagement-1.0.0b1.zip
    • azure_mgmt_informaticadatamanagement-1.0.0b1-py3-none-any.whl
    info	[Changelog]   - Initial Release
️️✔️ azure-sdk-for-java succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9fc5b26. SDK Automation 14.0.0
    command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
    command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
  • ️✔️azure-resourcemanager-informatica [Preview SDK Changes]
    • pom.xml
    • azure-resourcemanager-informatica-1.0.0-beta.1-sources.jar
    • azure-resourcemanager-informatica-1.0.0-beta.1.jar
️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9fc5b26. SDK Automation 14.0.0
    command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
    warn		specification/informatica/Informatica.DataManagement/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
    command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
  • ️✔️sdk/resourcemanager/informaticadatamanagement/arminformaticadatamanagement [Preview SDK Changes]
    info	[Changelog] This is a new package
    info	[Changelog]
️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
  • ️✔️Succeeded in generating from 9fc5b26. SDK Automation 14.0.0
    command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
    warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
    command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
  • ️✔️@azure/arm-informaticadatamanagement [Preview SDK Changes]
    • azure-arm-informaticadatamanagement-1.0.0.tgz
    info	[Changelog]
    error	breakingChangeTracking is enabled, but version or changelogItem is not found in output.
Posted by Swagger Pipeline | How to fix these errors?

Copy link

Hi, @almasak, our workflow has detected that there is no management SDK ever released for your RP, to further process SDK onboard for your RP, you should have the SDK client library name of your RP reviewed and approved.
Action Required:

  • Follow this guidance Naming for new initial management or client libraries (new SDKs) - Overview (azure.com) to create an issue for management client library name arch board review.
  • Paste the issue link that you created in step 1 in this PR

  • Impact: SDK release owner will take the approved management client library name to release SDK. No client library name approval will leads to SDK release delayed.

    @AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label May 17, 2024
    @AzureRestAPISpecReview AzureRestAPISpecReview removed the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label May 17, 2024
    @AzureRestAPISpecReview AzureRestAPISpecReview added the ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test label May 17, 2024
    @almasak
    Copy link
    Member Author

    almasak commented May 17, 2024

    /azp run

    Copy link

    Azure Pipelines successfully started running 4 pipeline(s).

    @almasak
    Copy link
    Member Author

    almasak commented May 17, 2024

    Suppression has been added for "OperationIDNounVerb" since the failing check is not applicable for our case, as "startFailedServerlessRuntime" is a single verb-term and not a noun, and is thus a false-positive.

    Moreover, this API spec already exists for our preview version: Link

    "swagger": "2.0",
    "info": {
    "title": "Informatica.DataManagement",
    "version": "2024-05-09",
    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    "2024-05-09"

    Looks like this PR introduces new stable version of swagger, please create base commit for with either previous stable version or preview version(if it was arm reviewed earlier). Please follow: https://eng.ms/docs/products/azure-developer-experience/design/api-specs/api-specs?tabs=openapi

    Copy link
    Member Author

    Choose a reason for hiding this comment

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

    This is our first version of the API specs (either private or stable) in this repo. Previous preview version is in the private repository:

    https://github.com/Azure/azure-rest-api-specs-pr/pull/16995
    https://github.com/Azure/azure-rest-api-specs-pr/tree/RPSaaSMaster/specification/informatica

    Copy link
    Contributor

    Choose a reason for hiding this comment

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

    You could still copy the files in the repo in your local branch and use the script to create a base of it.
    Since you have chosen not done it, just FYI, it will take more time to complete the ARM review for this PR.

    @samsaha-ms samsaha-ms added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 20, 2024
    @openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 20, 2024
    @samsaha-ms
    Copy link
    Contributor

    @almasak , Please remove ArmChangesRequested tag after addressing comments for further review.

    @almasak almasak removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label May 22, 2024
    @openapi-pipeline-app openapi-pipeline-app bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 22, 2024
    @samsaha-ms
    Copy link
    Contributor

    Approving suppression based on author and other ARM reviewers previous conversation over group chat.
    image

    @samsaha-ms samsaha-ms added Approved-Suppression ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review labels May 22, 2024
    @openapi-pipeline-app openapi-pipeline-app bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label May 22, 2024
    @samsaha-ms
    Copy link
    Contributor

    Signed off the PR from ARM as changes were reviewed earlier in private repo under 2023-08-20-preview api version.

    @samsaha-ms
    Copy link
    Contributor

    samsaha-ms commented May 22, 2024

    @almasak, please follow the Next Steps to Merge section for moving to next step to merge the PR.

    @almasak
    Copy link
    Member Author

    almasak commented May 22, 2024

    Namespace review:

    https://github.com/Azure/azure-sdk-pr/issues/1707

    @almasak
    Copy link
    Member Author

    almasak commented May 22, 2024

    /pr RequestMerge

    @microsoft-github-policy-service microsoft-github-policy-service bot added the MergeRequested Part of the ARM PR review workflow label May 22, 2024
    @samsaha-ms samsaha-ms merged commit a6ba164 into Azure:main May 22, 2024
    30 of 32 checks passed
    Francisco-Gamino pushed a commit to Francisco-Gamino/azure-rest-api-specs that referenced this pull request Jun 5, 2024
    …ure#29140)
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    
    * Liftr Informatica API - Stable version release for SDK generation
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-Suppression ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review IDCDevDiv MergeRequested Part of the ARM PR review workflow new-api-version new-rp-namespace-Approved ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager RPaaS SuppressionReviewRequired TypeSpec Authored with TypeSpec
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    None yet

    3 participants