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

Handle C# SDK Naming Requirements for Autogenerated Specs #32006

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

hmmorales
Copy link
Member

@hmmorales hmmorales commented Jan 6, 2025

SDK configuration pull request

Purpose of this PR

  • Make changes to the SDK configuration only when there are no modifications to the API specification, eliminating the need for an ARM or Stewardship Board API review.

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:

Getting help

  • First, carefully read through this PR description, from top to bottom. 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.
  • 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 Jan 6, 2025

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ Your PR has breaking changes in the generated SDK for Go (label: BreakingChange-Go-Sdk). Refer to step 3 in the PR workflow diagram.
  • ❌ Your PR has breaking changes in the generated SDK for JavaScript (label: BreakingChange-JavaScript-Sdk). Refer to step 3 in the PR workflow diagram.
  • ❌ Your PR has breaking changes in the generated SDK for Python (label: BreakingChange-Python-Sdk). Refer to step 3 in the PR workflow diagram.
  • ❌ The required check named Automated merging requirements met has failed. This is the final check that must pass. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide. In addition, refer to step 4 in the PR workflow diagram

Copy link

openapi-pipeline-app bot commented Jan 6, 2025

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/iotoperations/armiotoperations There is no API change compared with the previous version
Java azure-resourcemanager-iotoperations There is no API change compared with the previous version
Python azure-mgmt-iotoperations https://apiview.dev/Assemblies/Review/769883b1547944f0b54d7e35ce415ee3?revisionId=7fc75957482145ceb36deb2b4b3f20fa
JavaScript @azure/arm-iotoperations https://apiview.dev/Assemblies/Review/3497f183f9b842898633d9bc7bf2541d?revisionId=e4b7a9dabb1849cb957b139fae02d3b3
TypeSpec IoTOperations.Management https://apiview.dev/Assemblies/Review/0453fd959bbc4dbb9ee5a6266fb1ce29?revisionId=55460027afa9451599cb0e3686300ec2

@azure-sdk
Copy link
Collaborator

API change check

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

Microsoft.IoTOperations

@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label Jan 6, 2025
@hmmorales
Copy link
Member Author

/azp run

Copy link

Azure Pipelines successfully started running 4 pipeline(s).

@hmmorales hmmorales marked this pull request as ready for review January 7, 2025 22:59
@hmmorales hmmorales changed the title test Handle C# SDK Naming Requirements for Autogenerated Specs Jan 7, 2025
@hmmorales
Copy link
Member Author

Adding this issue for tracking: Azure/azure-sdk-for-net#45949


#suppress "@azure-tools/typespec-azure-core/casing-style"
namespace Microsoft.IoTOperations {
@@access(Operations.list, Access.internal);
Copy link
Member

Choose a reason for hiding this comment

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

This workaround is not needed anymore, generator can remove the list operation properly.

@live1206
Copy link
Member

live1206 commented Jan 8, 2025

Ignore the azure-sdk-for-net-track2 failure for the current PR merge, we will handle it with custom code during .NET SDK generation in azure-sdk-for-net.

@@access(Operations.list, Access.internal);

@@clientName(CertManagerCertOptions, "CertManagerCertConfig", "csharp");
@@clientName(DataflowOperation, "DataflowConfig", "csharp");
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think Config is the right substitute here. What about DataflowAction?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants