swagger-api / swagger-api/swagger-parser
Tags list is null unless a tag description is added
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 867
- Forks
- 560
- Avg merge
- 2d 21h
- Merged PRs (30d)
- 7
Description
This works:
@RestController
@RequestMapping("/api")
@Tag(name = "Account", description = "Account REST APIs")
public class AccountResource { ... }
This doesn't work:
@RestController
@RequestMapping("/api")
@Tag(name = "Account")
public class AccountResource { ... }
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
Reproduce the two annotation cases shown in the issue, comparing a @Tag with only a name against one with a description. Trace how the parser handles these tags and consider the work complete when the name-only case produces a non-null tags list without regressing the described case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100