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

[http-client-csharp] split description of some input types into doc and summary #4771

Open
3 tasks done
archerzz opened this issue Oct 17, 2024 · 0 comments
Open
3 tasks done

[http-client-csharp] split description of some input types into doc and summary #4771

archerzz opened this issue Oct 17, 2024 · 0 comments
Assignees
@archerzz
Labels
emitter:client:csharp Issue for the C# client emitter: @typespec/http-client-csharp
Milestone
[2024] December

Comments

@archerzz
Copy link
Member

Clear and concise description of the problem

Description

This is a follow-up refactoring. TCGC recently deleted its deprecated description (which is a synthesized property of @doc and @summary). We should use its doc and summary properties. However, some of our input types still use description property which results in multiple a.summary ?? a.doc expressions when bumping tsp 0.61.2: #4693

We should align with TCGC on those properties.

Checklist

  • Follow our Code of Conduct
  • Read the docs.
  • Check that there isn't already an issue that request the same feature to avoid creating a duplicate.
@archerzz archerzz added the emitter:client:csharp Issue for the C# client emitter: @typespec/http-client-csharp label Oct 17, 2024
@archerzz archerzz mentioned this issue Oct 17, 2024
Merged
@archerzz archerzz self-assigned this Nov 15, 2024
@archerzz archerzz added this to the [2024] December milestone Nov 15, 2024
archerzz pushed a commit to archerzz/typespec that referenced this issue Nov 20, 2024
refactor(http-client-csharp): remove filter-out-core-models option
1e5d06c 
- emitter: replace all `description` properties of input types with `summary` and `doc`
- generator:
  - update json converters for the emitter schema change
  - only expose `Summary` and `Doc` properties if they are used by other classes
- update test cases accordingly

part of microsoft#4771
@archerzz archerzz mentioned this issue Nov 20, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@archerzz archerzz

Labels
emitter:client:csharp Issue for the C# client emitter: @typespec/http-client-csharp
Projects
None yet
Milestone
[2024] December
Development

No branches or pull requests
1 participant
@archerzz