Skip to content

Conversation

@JaylenZ8
Copy link
Contributor

@JaylenZ8 JaylenZ8 commented Feb 6, 2025

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.
  • Convert existing OpenAPI spec to TypeSpec spec (do not combine this with implementing changes for a new API version).
  • Other, please clarify:
    • Update existing version to fix casing issue.

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.
  • If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
  • 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.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Feb 6, 2025

Next Steps to Merge

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

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Feb 6, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/datafactory/armdatafactory There is no API change compared with the previous version
Java azure-resourcemanager-datafactory Create ApiView timeout. Package is too large and we cannot create ApiView for it.
JavaScript @azure/arm-datafactory Create ApiView timeout. Package is too large and we cannot create ApiView for it.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Feb 6, 2025

API change check

APIView has identified API level changes in this PR and created following API reviews.

Microsoft.DataFactory
Microsoft.Synapse

@AzureRestAPISpecReview AzureRestAPISpecReview removed BreakingChange-Approved-BugFix Changes are to correct the REST API definition to correctly describe service behavior BreakingChangeReviewRequired <valid label in PR review process>add this label when breaking change review is required NotReadyForARMReview labels Feb 7, 2025
@AzureRestAPISpecReview AzureRestAPISpecReview added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 7, 2025
@mentat9 mentat9 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Feb 7, 2025
@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 Feb 7, 2025
@Jingshu918 Jingshu918 added the PublishToCustomers Acknowledgement the changes will be published to Azure customers. label Feb 8, 2025
"LakeHouseTableDataset": {
"x-ms-discriminator-value": "LakeHouseTable",
"description": "Microsoft Fabric LakeHouse Table.",
"x-ms-discriminator-value": "LakehouseTable",
Copy link
Member

Choose a reason for hiding this comment

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

@JeffreyRichter @mikeharder I feel like this is an api layer breaking here, but it's not getting detected correctly. because if customers want to pass an object for LakeHouseTableDataset, they will have to change the discriminator property type's value from "LakeHouseTable" to "LakehouseTable". Should we enhance our tooling so that we don't miss cases like this?

but as @JaylenZ8 confirmed offline, since service backend is backward compatible for this, and it can still recognize "LakeHouseTable" I guess it's probably okay for this one?

Copy link
Member

Choose a reason for hiding this comment

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

@qiaozha: Please open an issue at https://github.com/Azure/openapi-diff/issues to suggest a bug fix or feature request for the breaking changes detector.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks, issue created here Azure/openapi-diff#350

@ruowan ruowan merged commit 3e87982 into Azure:main Feb 10, 2025
27 of 28 checks passed
pjpatel12 pushed a commit to pjpatel12/azure-rest-api-specs that referenced this pull request Apr 29, 2025
* Fix casing

* Revert "Fix casing"

This reverts commit d0674aa.

* Fix

* Update sdk-suppressions.yaml

---------

Co-authored-by: kazrael2119 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review BreakingChange-JavaScript-Sdk-Suppression BreakingChange-JavaScript-Sdk-Suppression-Approved data-plane PublishToCustomers Acknowledgement the changes will be published to Azure customers. ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager

Projects

None yet

Development

Successfully merging this pull request may close these issues.