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

[tcgc] Remove deprecated description details #1560

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

Conversation

iscai-msft
Copy link
Contributor

fixes #1386

@@ -0,0 +1,7 @@
---
changeKind: deprecation
Copy link
Contributor Author

Choose a reason for hiding this comment

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

should this be marked deprecation or just bug fix since we deprecated it in a previous version

Copy link
Member

Choose a reason for hiding this comment

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

i label it with breaking change in previous pr.

@azure-sdk
Copy link
Collaborator

azure-sdk commented Sep 18, 2024

All changed packages have been documented.

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

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

Remove .description and .details from deprecated api surface

@azure-sdk
Copy link
Collaborator

You can try these changes here

🛝 Playground 🌐 Website 📚 Next docs

@@ -0,0 +1,7 @@
---
changeKind: deprecation
Copy link
Member

Choose a reason for hiding this comment

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

i label it with breaking change in previous pr.

@@ -354,7 +354,7 @@ function handleHttpResponse(
} as SdkHttpResponseExample;
if (typeof example === "object" && example !== null) {
for (const name of Object.keys(example)) {
if (name === "description") {
if (name === "doc") {
Copy link
Member

Choose a reason for hiding this comment

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

it is a hard coded property in current json example, no need to change it to doc.

packages/typespec-client-generator-core/src/interfaces.ts Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[tcgc] remove deprecated description and details
4 participants