RicoSuter/NSwag

Comment text in attribute 'obsolete' is not displayed in the generated client

Open

#2,595 opened on Dec 26, 2019

View on GitHub
 (6 comments) (0 reactions) (0 assignees)C# (1,189 forks)batch import
help wantedproject: NSwag.CodeGeneration.CSharp (Clients)type: enhancement

Repository metrics

Stars
 (6,291 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Hello guys,

In my controller method marked as [Obsolete("Reason")] but in generated client for it 'obsolete' attribute without comment - [Obsolete] Is there a way around this problem?

In .nswag config "ignoreObsoleteProperties": false

Contributor guide

Research direction
Investigate the code generation logic for the Obsolete attribute in NSwag to find where the comment text is lost.
Tech stack
csharp
Domain
backendapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#NSwag
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65