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

Polish some API names in TCGC #1463

Merged

Conversation

ArcturusZhang
Copy link
Member

@ArcturusZhang ArcturusZhang commented Sep 3, 2024

Fixes #874
Fixes #933
Fixes #1462
Fixes #1466

@microsoft-github-policy-service microsoft-github-policy-service bot added the lib:tcgc Issues for @azure-tools/typespec-client-generator-core library label Sep 3, 2024
@azure-sdk
Copy link
Collaborator

azure-sdk commented Sep 3, 2024

All changed packages have been documented.

  • @azure-tools/typespec-azure-resource-manager
  • @azure-tools/typespec-client-generator-core
Show changes

@azure-tools/typespec-azure-resource-manager - feature ✏️

x-ms-skip-url-encoding should be replaced with allowReserved

@azure-tools/typespec-client-generator-core - breaking ✏️

  1. The kind for unknown renamed from any to unknown.,> 2. The values property in SdkUnionType renamed to variantTypes.,> 3. The values property in SdkTupleType renamed to valueTypes.,> 4. The example types for parameter, response and SdkType has been renamed to XXXExampleValue to emphasize that they are values instead of the example itself.,> 5. The @format decorator is no longer able to change the type of the property.

@azure-tools/typespec-client-generator-core - fix ✏️

Fix naming logic for anonymous model wrapped by HttpPart

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@ArcturusZhang ArcturusZhang marked this pull request as ready for review September 3, 2024 07:38
@ArcturusZhang ArcturusZhang changed the title Clean up some old APIs Polish some API names in TCGC Sep 3, 2024
Copy link
Member

@haolingdong-msft haolingdong-msft left a comment

Choose a reason for hiding this comment

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

overall looks good to me.

@ArcturusZhang ArcturusZhang added this pull request to the merge queue Sep 11, 2024
@ArcturusZhang ArcturusZhang removed this pull request from the merge queue due to a manual request Sep 11, 2024
@iscai-msft
Copy link
Contributor

@ArcturusZhang I think the release just went out for the latest typespec, so this breaking change won't be part of it, which I think is good because a lot of people prefer having the breaking one a release after in tcgc, so we can better integrate it. Can you rebase this onto the release branch? https://github.com/Azure/typespec-azure/blob/main/CONTRIBUTING.md#make-a-patch-release

@ArcturusZhang
Copy link
Member Author

@ArcturusZhang I think the release just went out for the latest typespec, so this breaking change won't be part of it, which I think is good because a lot of people prefer having the breaking one a release after in tcgc, so we can better integrate it. Can you rebase this onto the release branch? main/CONTRIBUTING.md#make-a-patch-release

sure!

@ArcturusZhang ArcturusZhang changed the base branch from main to release/september-2024 September 13, 2024 05:06
@ArcturusZhang ArcturusZhang merged commit 94e5fe7 into Azure:release/september-2024 Sep 14, 2024
22 checks passed
@ArcturusZhang ArcturusZhang deleted the change-some-bad-apis branch September 14, 2024 01:28
ArcturusZhang added a commit that referenced this pull request Sep 14, 2024
Update references after merged #1463
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lib:tcgc Issues for @azure-tools/typespec-client-generator-core library
Projects
None yet
5 participants