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.

Sign up for GitHub

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

Jump to bottom

Remove 'x-ms-client-flatten' in typespec-azure-resource-manager templates and make it conditional in autorest #1105

Merged
merged 6 commits into from
Jul 11, 2024
Merged

Remove 'x-ms-client-flatten' in typespec-azure-resource-manager templates and make it conditional in autorest #1105

merged 6 commits into from
Jul 11, 2024

Conversation

allenjzhang
Copy link
Member

Closes #709

@azure-sdk
Copy link
Collaborator

azure-sdk commented Jul 2, 2024 •
edited
Loading

All changed packages have been documented.

  • ✅ @azure-tools/typespec-autorest
  • ✅ @azure-tools/typespec-azure-resource-manager
Show changes

@azure-tools/typespec-autorest - breaking ✏️

x-ms-client-flatten extension on some of resource properties property is now configurable to be emitted by autorest emitter. Default is false which will skip emission of that extension.

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

x-ms-client-flatten extension on some of resource properties property is now configurable to be emitted by autorest emitter. Default is false which will skip emission of that extension.

@azure-sdk
Copy link
Collaborator

You can try these changes at https://cadlplayground.z22.web.core.windows.net/typespec-azure/prs/1105/

Check the website changes at https://tspwebsitepr.z22.web.core.windows.net/typespec-azure/prs/1105/

@allenjzhang allenjzhang added this pull request to the merge queue Jul 11, 2024
Merged via the queue into Azure:main with commit 11c971b Jul 11, 2024
21 checks passed
@allenjzhang allenjzhang deleted the azhang_RemoveClientFlatten branch July 11, 2024 00:33
tadelesh
tadelesh reviewed Jul 12, 2024
View reviewed changes
packages/typespec-azure-resource-manager/src/private.decorators.ts
/**
* Please DO NOT USE in RestAPI specs.
* Internal decorator that deprecated direct usage of `x-ms-client-flatten` OpenAPI extension.
* It will programatically enabled/disable client flattening with @flattenProperty with autorest
Copy link
Member

Choose a reason for hiding this comment

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

@allenjzhang i do not see where to set @flattenProperty decorator, but only see the set of openapi2 x-ms-client-flatten. am i miss sth?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@qiaozha qiaozha qiaozha left review comments

@tadelesh tadelesh tadelesh left review comments

@timotheeguerin timotheeguerin timotheeguerin approved these changes

@bterlson bterlson Awaiting requested review from bterlson bterlson is a code owner

@markcowl markcowl Awaiting requested review from markcowl markcowl is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Make 'x-ms-client-flatten' in typespec-azure-resource-manager templates conditional
5 participants
@allenjzhang @azure-sdk @timotheeguerin @tadelesh @qiaozha