swagger-api / swagger-api/swagger-core
[Feature] Mark type as deprecated if the class is `@Deprecated`
Open
Nobody has claimed this yet.
backlog
- Dominant language
- Java
- Stars
- 7.5k
- Forks
- 2.3k
- Avg merge
- 18h 1m
- Merged PRs (30d)
- 10
Description
If a controller method is annotated with @Deprecated, the respective operation gets a deprecated: true flag. However, if for example a DTO class is annotated with @Deprecated, that has no effect on the OpenAPI docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the code that turns @Deprecated on controller methods into the OpenAPI deprecated flag, then inspect nearby schema-generation tests. Determine where deprecated DTO or other model classes are represented, and verify completion when a deprecated class produces deprecated: true in the generated OpenAPI documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100