Skip to content

Client Rename for C# .NET SDK #33703

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

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

Conversation

saitama-kunzo
Copy link

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 Apr 3, 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 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 Apr 3, 2025

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

Copy link

github-actions bot commented Apr 3, 2025

API Change Check

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

Language API Review for Package
TypeSpec Qumulo.Storage

@@ -1,6 +1,18 @@
import "./main.tsp";
import "./main.tsp";
Copy link
Member

Choose a reason for hiding this comment

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

this is duplicated with L1

Copy link
Author

Choose a reason for hiding this comment

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

Addressed

@@ -1,6 +1,18 @@
import "./main.tsp";
import "./main.tsp";
import "./LiftrBase.Storage/main.tsp";
Copy link
Member

Choose a reason for hiding this comment

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

this is not needed, it has been imported to main.tsp already.

Copy link
Author

Choose a reason for hiding this comment

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

Addressed

@live1206
Copy link
Member

live1206 commented Apr 7, 2025

/azp run

Copy link

You have several pipelines (over 10) configured to build pull requests in this repository. Specify which pipelines you would like to run by using /azp run [pipelines] command. You can specify multiple pipelines using a comma separated list.

@jianingwang123
Copy link

Hi @saitama-kunzo,
According to https://github.com/Azure/azure-rest-api-specs/actions/runs/14260526788/job/39970914901?pr=33703#step:4:105, your tspconfig.yaml is incorrectly configured. Kindly update your tspconfig.yaml as per the details provided below.
Please let us know if you need any further assistance.

  - Failed to find "options.@azure-tools/typespec-java.package-dir". Please add "options.@azure-tools/typespec-java.package-dir".
  - Failed to find "options.@azure-tools/typespec-go.service-dir". Please add "options.@azure-tools/typespec-go.service-dir".
  - Failed to find "options.@azure-tools/typespec-go.package-dir". Please add "options.@azure-tools/typespec-go.package-dir".
  - Failed to find "options.@azure-tools/typespec-go.module". Please add "options.@azure-tools/typespec-go.module".
  - Failed to find "options.@azure-tools/typespec-go.fix-const-stuttering". Please add "options.@azure-tools/typespec-go.fix-const-stuttering".
  - Failed to find "options.@azure-tools/typespec-go.generate-examples". Please add "options.@azure-tools/typespec-go.generate-examples".
  - Failed to find "options.@azure-tools/typespec-go.generate-fakes". Please add "options.@azure-tools/typespec-go.generate-fakes".
  - Failed to find "options.@azure-tools/typespec-go.head-as-boolean". Please add "options.@azure-tools/typespec-go.head-as-boolean".
  - Failed to find "options.@azure-tools/typespec-go.inject-spans". Please add "options.@azure-tools/typespec-go.inject-spans".
  - Failed to find "options.@azure-tools/typespec-python.package-name". Please add "options.@azure-tools/typespec-python.package-name".

@saitama-kunzo
Copy link
Author

saitama-kunzo commented Apr 16, 2025

Hi @jianingwang123,
This PR only include changes related to client renaming for generating .NET SDK. Also, we are not generating java/go SDK, still do we need to add those details in the tspconfig file?
Also, for python SDK, package-name will have same value as package-dir? I cannot see this option in this sample tspconfig - https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml

@jianingwang123
Copy link

Hi @jianingwang123, This PR only include changes related to client renaming for generating .NET SDK. Also, we are not generating java/go SDK, still do we need to add those details in the tspconfig file? Also, for python SDK, package-name will have same value as package-dir? I cannot see this option in this sample tspconfig - https://github.com/Azure/azure-rest-api-specs/blob/main/specification/contosowidgetmanager/Contoso.Management/tspconfig.yaml

Hi @saitama-kunzo,
Previously, TypeSpec Validation did not validate tspconfig.yaml, and spec PRs could be merged even if the PR had SDK automation failures or skips. However, moving forward, TypeSpec Validation will validate tspconfig.yaml for all languages.

While the validation currently only reports warning messages, it will start reporting errors in the near future, which will block PR merges. To prevent potential issues, we highly recommend updating tspconfig.yaml according to the warning messages provided by TypeSpec Validation.

For the Python MPG SDK, there is no need to add package-name. Please disregard this. Thank you.

@saitama-kunzo
Copy link
Author

Hi, @jianingwang123,
I have made the appropriate changes to the tspconfig. Please review, thanks.

@jianingwang123
Copy link

Hi, @jianingwang123, I have made the appropriate changes to the tspconfig. Please review, thanks.

It looks like SdkTspConfigValidation has passed, thank you.

@saitama-kunzo
Copy link
Author

This PR only includes changes to rename the models for generated .NET SDK. We have not made any changes to models, or code that generates python/java sdk.

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